Skip to main content
Manja / Stripe
Schema2020-08-27object

discount

A discount represents the actual application of a coupon to a particular customer. It contains information about when the discount began and when it will end. Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

Discount

object

A discount represents the actual application of a coupon to a particular customer. It contains information about when the discount began and when it will end. Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).

checkout_session string
optionalnullable

The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

maxLength:5000

coupon Coupon object
required

A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or [orders](https://stripe.com/docs/api#create_order_legacy-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge).

customer
optionalnullable

The ID of the customer associated with this discount.

end integer (unix-time)
optionalnullable

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.

id string
required

The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.

maxLength:5000

invoice string
optionalnullable

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

maxLength:5000

invoice_item string
optionalnullable

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.

maxLength:5000

object string
required

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

Allowed: "discount"

promotion_code
optionalnullable

The promotion code applied to create this discount.

start integer (unix-time)
required

Date that the coupon was applied.

subscription string
optionalnullable

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

maxLength:5000