objectpromotion_code
A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.
- Source
openapi/spec3.json- Commit
d70de345383d- Active snapshot
da69df7e6e11
PromotionCode
objectA Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.
Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.
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).
Time at which the object was created. Measured in seconds since the Unix epoch.
The customer that this promotion code can be used by.
Date at which the promotion code can no longer be redeemed.
Unique identifier for the object.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Maximum number of times this promotion code can be redeemed.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
String representing the object's type. Objects of the same type share the same value.
Number of times this promotion code has been used.