Skip to main content
POST
Create Promo

Authorizations

Authorization
string
header
required

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

Scopes

Headers

Idempotency-Key
string

The idempotency key that will be used to ensure the request is only performed once

Path Parameters

company_id
string
required

The company ID with the prefix 'cmp_'.

id
string
required

The resource ID

Body

application/json
code
string
required

The promo code customers enter to redeem the coupon

description
string

A description of the promo code

metadata
object

Arbitrary key-value metadata to store with the promo code

Response

201 - application/json

Created

code
string
coupon_id
string
created_at
string<date-time>
description
string
expiration_date
null | string<date-time>
id
string
import_created_at_ref
null | string<date-time>
import_ref
null | string
imported_from
null | string
max_redemptions
integer<int64>
metadata
object
num_redemptions
integer<int64>
restrictions
object
state
string