shopify.billing.cancel

Cancel a subscription plan by the given id.

Example

Cancel a subscription plan, given an id

The call to cancel will return an AppSubscription object, containing the details of the subscription just cancelled successfully, and will throw a BillingError if any errors occur.

const subscriptionId = "gid://shopify/AppSubscription/1234567890"; // this can be obtained from a call to shopify.billing.subscriptions()
try {
  const canceledSubscription = await shopify.billing.cancel({
    session,
    subscriptionId,
    prorate: true,  // Whether to issue prorated credits for the unused portion of the app subscription. Defaults to true.
  })
} catch (error) {
  if (error typeof BillingError) {
    console.log(`Unable to cancel subscription ${subscriptionId}: ${JSON.stringify(error.errorData, null, 2)}`);
    // handle error appropriately
  }
}
// canceledSubscription will have the following shape:
// {
//   id: string;
//   name: string;
//   test: boolean;
// }

Parameters

Receives an object containing:

session

Session | :exclamation: required

The Session for the current request.

subscriptionId

string | :exclamation: required

The id for the subscription to cancel.

prorate

boolean | optional, defaults to true

Whether to issue prorated credits for the unused portion of the app subscription. Defaults to true.

Return

AppSubscription

An object containing the id, name and test properties of the subscription that was just successfully cancelled:

{
  id: string;
  name: string;
  test: boolean;
}

If the call to shopify.billing.cancel throws a BillingError, the BillingError object will contain an array of error messages returned by the GraphQL API call in the errorData property.

Back to shopify.billing