Manage billing cycles in bulk

• Your app can make authenticated requests to the GraphQL Admin API.
• Your app has the read_own_subscription_contracts and write_own_subscription_contracts access scopes. Learn how to configure your access scopes using Shopify CLI.

• You've created products and product variants in your development store.

• You've created an active subscription contract with a recurring billing and delivery policy.

• You've familiarized yourself with the concept of billing cycles.

The subscriptionBillingCycleBulkCharge mutation allows you to create charges for multiple billing cycles in bulk. This can be particularly useful when you need to process charges for a large number of subscriptions at once. This mutation only allows a single successfull charge per billing cycle and only allows charging billing cycles with the billing attempt expected date in the past or within the next 24 hours.

The following example shows how to create a regular billing schedule for all unbilled cycles within a 24-hour period.

You can later use the subscriptionBillingCycleBulkResults to query all the billing cycles selected with this mutation, using the returned jobId.

The subscriptionBillingCycleBulkSearch mutation allows you to search for billing cycles in bulk based on specific criteria. It works similar to subscriptionBillingCycleBulkCharge, but doesn't charge or run any operations on the selected cycles.

In the following example, a list of all billing cycles that need to be billed next week is compiled.

To get the result of your search, you need to run the subscriptionBillingCycleBulkResults query using the returned job ID.

After initiating a bulk operation using subscriptionBillingCycleBulkCharge or subscriptionBillingCycleBulkSearch, you can use the subscriptionBillingCycleBulkResults query to retrieve the results of the operation.

Learn how to combine contracts together in a subscription billing cycle for a customer that has multiple subscriptions.