Schema2020-08-27object

promotion_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

PromotionCodesResourceRestrictions

object

first_time_transaction boolean

required

A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices

minimum_amount integer

optionalnullable

Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).

minimum_amount_currency string

optionalnullable

Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount

maxLength:5000

Root JSON Schema

{"description":"A Promotion Code represents a customer-redeemable code for a coupon. It can be used to\ncreate multiple codes for a single coupon.","properties":{"active":{"description":"Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.","type":"boolean"},"code":{"description":"The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.","maxLength":5000,"type":"string"},"coupon":{"$ref":"#/components/schemas/coupon"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"customer":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/customer"},{"$ref":"#/components/schemas/deleted_customer"}],"description":"The customer that this promotion code can be used by.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/customer"},{"$ref":"#/components/schemas/deleted_customer"}]}},"expires_at":{"description":"Date at which the promotion code can no longer be redeemed.","format":"unix-time","nullable":true,"type":"integer"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"max_redemptions":{"description":"Maximum number of times this promotion code can be redeemed.","nullable":true,"type":"integer"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"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.","nullable":true,"type":"object"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["promotion_code"],"type":"string"},"restrictions":{"$ref":"#/components/schemas/promotion_codes_resource_restrictions"},"times_redeemed":{"description":"Number of times this promotion code has been used.","type":"integer"}},"required":["active","code","coupon","created","id","livemode","object","restrictions","times_redeemed"],"title":"PromotionCode","type":"object","x-expandableFields":["coupon","customer","restrictions"],"x-resourceId":"promotion_code"}