Delete a customer discount

Removes the currently applied discount on a customer.

delete/v1/customers/{customer}/discount

Path parameters

customerstring 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 14 of the 51 revisions of this API.194937

    • removed the required property //////////// from the response with the status

      response-required-property-removed

    • removed the required property ////////// from the response with the status

      response-required-property-removed

    • removed the required property ////////// from the response with the status

      response-required-property-removed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

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

      response-optional-property-added

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

      response-optional-property-added

    • removed the optional property ////// from the response with the status

      response-optional-property-removed

    • removed the optional property //// from the response with the status

      response-optional-property-removed

    • added the new prevented enum value to the ////////// response property for the response status

      response-property-enum-value-added

    • added the new prevented enum value to the //////// response property for the response status

      response-property-enum-value-added

    • added the new prevented enum value to the //////// response property for the response status

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 1199cc3c557429See the full diff
    • the response property /////////////// became optional for the status

      response-property-became-optional

    • the response property //////////// became optional for the status

      response-property-became-optional

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

    • added the optional property ////// to the response with the 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

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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

      response-optional-property-added

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