OptionalactiveWhether the promotion code is currently active.
OptionalcodeThe customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
If left blank, we will generate one automatically.
OptionalcustomerThe customer who can use this promotion code. If not set, all customers can use the promotion code.
Optionalcustomer_The account representing the customer who can use this promotion code. If not set, all customers can use the promotion code.
OptionalexpandSpecifies which fields in the response should be expanded.
Optionalexpires_The timestamp at which this promotion code will expire. If the coupon has specified a redeems_by, then this value cannot be after the coupon's redeems_by.
Optionalmax_A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a max_redemptions, then this value cannot be greater than the coupon's max_redemptions.
OptionalmetadataSet of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
OptionalrestrictionsSettings that restrict the redemption of the promotion code.
The promotion referenced by this promotion code.