subscriptionBillingCycleBulkSearch

mutation

Requires write_own_subscription_contracts access scope. Also: The user must have manage_orders_information permission.

Asynchronously queries all subscription billing cycles whose billingAttemptExpectedDate values fall within a specified date range and meet additional filtering criteria. The results of this action can be retrieved using the subscriptionBillingCycleBulkResults query.

Arguments

Anchor to billingAttemptExpectedDateRangebillingAttemptExpectedDateRange • SubscriptionBillingCyclesDateRangeSelector!required: Specifies the date range within which the billingAttemptExpectedDate values of the billing cycles should fall.
Anchor to filtersfilters • SubscriptionBillingCycleBulkFilters: Criteria to filter the billing cycles on which the action is executed.

Was this section helpful?

Anchor to SubscriptionBillingCycleBulkSearchPayload returnsSubscriptionBillingCycleBulkSearchPayload returns

Anchor to jobjob • Job: The asynchronous job that performs the action on the targeted billing cycles.
Anchor to userErrorsuserErrors • [SubscriptionBillingCycleBulkUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Create a job to search for all subscription billing cycles in time range
subscriptionBillingCycleBulkSearch reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation($startDate: DateTime!, $endDate: DateTime!) {
6    subscriptionBillingCycleBulkSearch(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {
7      job {
8        id
9      }
10    }
11  }`,
12  {
13    variables: {
14      "startDate": "2023-02-01T00:00:00-05:00",
15      "endDate": "2023-02-02T23:59:59-05:00"
16    },
17  },
18);
19
20const data = await response.json();
21

mutation($startDate: DateTime!, $endDate: DateTime!) {
  subscriptionBillingCycleBulkSearch(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {
    job {
      id
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation($startDate: DateTime!, $endDate: DateTime!) { subscriptionBillingCycleBulkSearch(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) { job { id } } }",
 "variables": {
    "startDate": "2023-02-01T00:00:00-05:00",
    "endDate": "2023-02-02T23:59:59-05:00"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation($startDate: DateTime!, $endDate: DateTime!) {
    subscriptionBillingCycleBulkSearch(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {
      job {
        id
      }
    }
  }`,
  {
    variables: {
      "startDate": "2023-02-01T00:00:00-05:00",
      "endDate": "2023-02-02T23:59:59-05:00"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation($startDate: DateTime!, $endDate: DateTime!) {
      subscriptionBillingCycleBulkSearch(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {
        job {
          id
        }
      }
    }`,
    "variables": {
      "startDate": "2023-02-01T00:00:00-05:00",
      "endDate": "2023-02-02T23:59:59-05:00"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation($startDate: DateTime!, $endDate: DateTime!) {
    subscriptionBillingCycleBulkSearch(billingAttemptExpectedDateRange: {startDate: $startDate, endDate: $endDate}) {
      job {
        id
      }
    }
  }
QUERY

variables = {
  "startDate": "2023-02-01T00:00:00-05:00",
  "endDate": "2023-02-02T23:59:59-05:00"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "startDate": "2023-02-01T00:00:00-05:00",
3  "endDate": "2023-02-02T23:59:59-05:00"
4}

Response

JSON

1{
2  "subscriptionBillingCycleBulkSearch": {
3    "job": {
4      "id": "gid://shopify/Job/ea4e2f15-8508-4930-8de5-0e31c8b7014e"
5    }
6  }
7}