The Discount object

Attributes

id string 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.
customer nullable string Expandable The ID of the customer associated with this discount.
customer _ account nullable string The ID of the account representing the customer associated with this discount.
end nullable timestamp If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.
source object The source of the discount.
start timestamp Date that the coupon was applied.
subscription nullable string The subscription that this coupon is applied to, if it is applied to a particular subscription.

More attributes

object string, value is "discount"
checkout _ session nullable string
invoice nullable string
invoice _ item nullable string
promotion _ code nullable string Expandable
subscription _ item nullable string

The Discount object

{ "id": "di_1M6vk22eZvKYlo2CYMGIhk14", "object": "discount", "checkout_session": "cs_test_b1mywbZHtQCQW2ncaItVPFqupwmfqNU4IMMdw3lArEBGt0QD0CZDrNQswR", "source": { "type": "coupon", "coupon": "nVJYDOag" }, "customer": "cus_9s6XKzkNRiz8i3", "end": null, "invoice": null, "invoice_item": null, "promotion_code": null, "start": 1669120702, "subscription": null}

Delete a customer discount

DELETE / v1 / customers /:id / discount

Removes the currently applied discount on a customer.

Parameters

No parameters.

Returns

An object with a deleted flag set to true upon success. This call returns an error otherwise, such as if no discount exists on this customer.

Response

{ "object": "discount", "deleted": true}

Delete a subscription discount

DELETE / v1 / subscriptions /:id / discount

Removes the currently applied discount on a subscription.

Parameters

No parameters.

Returns

An object with a deleted flag set to true upon success. This call returns an error otherwise, such as if no discount exists on this subscription.

Response

{ "object": "discount", "deleted": true}