Delete a customer discount

Changed on

Removes the currently applied discount on a customer.

delete/v1/customers/{customer}/discount

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/customers/{customer}/discount
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

customerstring required

Request body application/x-www-form-urlencoded

object 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

  • b22313c11340Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    This list may be incomplete.

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

Some revisions have not been checked yet.