Skip to main content
POST
Add a new promotion code for a coupon.

Authorizations

Authorization
string
header
required

Enter your access token (OAuth / JWT).

Body

application/json

The promotion code to create

Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
SchemaLessData
object | null
StripeId
string | null
Maximum string length: 255
IsLivemode
boolean
Account
Account · object | null

Circular reference to Account (not expanded here).

Active
boolean
Code
string | null
Maximum string length: 250
ExpiresAt
string<date-time> | null
MaxRedemptions
integer<int64> | null
Restrictions_FirstTimeTransaction
boolean
StripeCoupon
object | null
Example:
TimesRedeemed
integer<int64>
Valid
boolean
CustomerId
string | null
CouponId
string | null

Response

Created
string<date-time>
required
read-only
Minimum string length: 1
Updated
string<date-time>
required
read-only
Minimum string length: 1
Uid
string | null
Maximum string length: 10
_objectType
string | null
ActivityEventData
unknown
SchemaLessData
object | null
StripeId
string | null
Maximum string length: 255
IsLivemode
boolean
Account
Account · object | null

Circular reference to Account (not expanded here).

Active
boolean
Code
string | null
Maximum string length: 250
ExpiresAt
string<date-time> | null
MaxRedemptions
integer<int64> | null
Restrictions_FirstTimeTransaction
boolean
StripeCoupon
object | null
Example:
TimesRedeemed
integer<int64>
Valid
boolean
CustomerId
string | null
CouponId
string | null