Skip to main content
POST
/
v1
/
promotions
Create
curl --request POST \
  --url https://{defaultHost}/v1/promotions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "promotion": {
    "code": "TESTCODE",
    "coupon_id": "8e426f7f-14c0-48d6-9212-0a4e060a34ad"
  }
}
'
{
  "id": "a2f8b754-80e4-4929-bc76-c5ab1906fb70",
  "object": "promotion",
  "archived": false,
  "archived_at": null,
  "code": "TESTCODE",
  "expired": false,
  "max_redemptions": null,
  "metadata": {},
  "redeem_by": null,
  "times_redeemed": 0,
  "affiliation": null,
  "coupon": "8e426f7f-14c0-48d6-9212-0a4e060a34ad",
  "customer": null,
  "discarded_at": null,
  "created_at": 1767909739,
  "updated_at": 1767909739
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
promotion
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
archived
boolean

Whether or not this promotion is archived.

​
code
string

The customer-facing code. Regardless of case, this code must be unique across all promotion codes on your account. If left blank, we will generate one automatically.

​
expired
boolean

Taking into account the above properties, whether this promotion can still be used.

​
max_redemptions
integer | null

Maximum number of times this coupon can be redeemed in total across all customers.

​
redeem_by
integer | null

Date after which the coupon can no longer be redeemed.

​
metadata
object

Set 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.

​
archived_at
integer | null

Time at which the object was archived. Measured in seconds since the Unix epoch.

​
affiliation

Expandable – The associated affiliation ID.

​
coupon

Expandable – The associated coupon ID.

​
customer

Expandable – The associated customer ID.

​
discounts

Expandable – Property not returned unless expanded.

​
discarded_at
integer | null

Time at which the object was discarded. Measured in seconds since the Unix epoch.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.