Cancel Subscription

🔐

Authentication

✔️ Application API Scope

✔️ Storefront API Scope (including with trust_level: recognized)

Attempting to call these on a prepaid subscription will result in a 400 error.

Response Body Definitions

New Bundle Components Example

[  
  {  
    "public_id": "79d2dc76245111eeb185acde48001122",  
    "quantity": 1,  
    "product": "0070067690"  
  },  
  {  
    "public_id": "7eeaa504245111eeb185acde48001122",  
    "quantity": 3,  
    "product": "0070067691"  
  }  
]

Prepaid Subscription Context Example

{
  "prepaid_orders_remaining": 0,
  "prepaid_orders_per_billing": 3,
  "renewal_behavior": "autorenew",
  "last_renewal_revenue": 100.8,
  "prepaid_origin_merchant_order_id": "#3082"
}

Or empty object if prepaid is not enabled:

{}

Usage

This endpoint cancels a subscription and prevents any future shipments from being processed. Once cancelled, the subscription status will be updated and the cancelled field will contain the cancellation timestamp.

Important Notes

• This operation cannot be performed on prepaid subscriptions
• Cancelled subscriptions can potentially be reactivated using the reactivate endpoint
• The cancellation reason can be provided to track why subscriptions are being cancelled