v1

latestOpenAPI 3.1.02026-07-24571564.5 KB
Subscriptions

Cancel subscription

Cancels the subscription.

If the subscription is in dunning, it'll be taken out of dunning.

If the shop has an actions set to trigger when a subscription is cancelled, they'll be triggered (example: email notifications).

NOTE: If the request to cancel the subscription in Shopify fails, the subscription will still be cancelled in the Awtomic system to avoid future billing attempts.

post/customers/{customerId}/subscriptions/{subscriptionId}/cancel

Path parameters

customerIdstring required

Customer Id

subscriptionIdstring required

Subscription Id

Request body

detailsstring

customer provided details about the cancellation

reasonstring

shortcode reason for cancellation (used for analytics)

Response

Updated subscription

SubscriptionIdstring

Identifier

SubscriptionStatusstring

Status

NextBillingDatestring date-time

Date of the next billing