Delete a subscription discount

Removes the currently applied discount on a subscription.

delete/v1/subscriptions/{subscription_exposed_id}/discount

Path parameters

subscription_exposed_idstring required

Response

Successful response.

checkout_sessionstring nullable

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.

customer_accountstring nullable

The ID of the account representing the customer associated with this discount.

deletedtrue required

Always true for a deleted object

idstring required

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.

invoicestring nullable

The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.

invoice_itemstring nullable

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.

object'discount' required

String representing the object's type. Objects of the same type share the same value.

startinteger required

Date that the coupon was applied.

subscriptionstring nullable

The subscription that this coupon is applied to, if it is applied to a particular subscription.

subscription_itemstring nullable

The subscription item that this coupon is applied to, if it is applied to a particular subscription item.

Changes

Changed in 9 of the 51 revisions of this API.161624

Nov 5, 202562e8dc4ed8691See the full diff
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the default status
  response-optional-property-added
Oct 22, 20251e483c60b4801See the full diff
- ○
  added the optional property error/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the default status
  response-optional-property-added
Aug 19, 20257b79777e9bbd2See the full diff
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the default status
  response-optional-property-added
Jul 22, 2025c4dc6dbe947e1See the full diff
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the default status
  response-optional-property-added
Feb 14, 20251199cc3c557429See the full diff
- ▲
  the response property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/price_type became optional for the status default
  response-property-became-optional
- ▲
  the response property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/price_type became optional for the status default
  response-property-became-optional
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/prices to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/priority to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/prices to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/priority to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/acss_debit/anyOf[subschema #1: payment_intent_payment_method_options_acss_debit]/target_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/au_becs_debit/anyOf[subschema #1: payment_intent_payment_method_options_au_becs_debit]/target_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/bacs_debit/anyOf[subschema #1: payment_intent_payment_method_options_bacs_debit]/target_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/sepa_debit/anyOf[subschema #1: payment_intent_payment_method_options_sepa_debit]/target_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/us_bank_account/anyOf[subschema #1: payment_intent_payment_method_options_us_bank_account]/target_date to the response with the default status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 17, 2025b8a91ebdacb78See the full diff
- ○
  added the optional property error/advice_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/outcome/anyOf[subschema #1: ChargeOutcome]/advice_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/pay_by_bank to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypal/country to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/outcome/anyOf[subschema #1: ChargeOutcome]/advice_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/pay_by_bank to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypal/country to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/pay_by_bank to the response with the default status
  response-optional-property-added
Dec 14, 202446de5407335916See the full diff
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/customer_tax_ids/items/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/invoice_item/anyOf[subschema #2: InvoiceItem]/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/invoice_item/anyOf[subschema #2: InvoiceItem]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/invoice_item/anyOf[subschema #2: InvoiceItem]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription_schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription_schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Dec 11, 2024d8ab202758612See the full diff
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/card/network_transaction_id to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/card/network_transaction_id to the response with the default status
  response-optional-property-added
Oct 23, 202433103c93fb8c14See the full diff
- ▲
  the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/refunds/data/items/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
- ▲
  the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/refunds/data/items/next_action/display_details response's property type/format changed from / to object/ for status default
  response-property-type-changed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.

Full history