DELETE
/v1/subscriptions/{subscription_exposed_id}/discountDelete a subscription discount
Deletes the discount currently applied to a subscription. Supply subscription_exposed_id to identify the subscription whose discount you want to remove. The response identifies the deleted discount and its original source and application time.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
subscription_exposed_idstringrequired
The subscription identifier whose current discount should be removed. Maximum 5,000 characters.
200Returns a deleted discount object with `deleted` set to true, the discount identifier, object type, source, and Unix timestamp when the discount was applied.
checkout_sessionstringoptional
The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode.
customerstringoptional
The ID of the customer associated with this discount.
customer_accountstringoptional
The ID of the account representing the customer associated with this discount.
deletedbooleanrequired
Always true for a deleted object
idstringrequired
The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.
invoicestringoptional
The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
invoice_itemstringoptional
The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
promotion_codestringoptional
The promotion code applied to create this discount.
sourceobjectrequired
startintegerrequired
Date that the coupon was applied.
subscriptionstringoptional
The subscription that this coupon is applied to, if it is applied to a particular subscription.
subscription_itemstringoptional
The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
defaultError response.
errorobjectrequired
Error handling
subscription_exposed_id must identify the subscription and must not exceed 5,000 characters.