Skip to main content
GET
Get Coupon

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

Response

200 - application/json

OK

amount
object | null

The amount which has value in cents and a currency

cap
object | null

The amount which has value in cents and a currency

created_at
string<date-time>
duration
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
item
object
item_id
null | string
item_pricing
object
item_pricing_id
null | string
max_redemptions
integer
Required range: x >= 0
metadata
object
months
integer
Required range: x >= 0
name
string
num_redemptions
integer
Required range: x >= 0
percent
number<double>
product_pricing
object
product_pricing_id
null | string
products
string[] | null
promo_codes
object[] | null
state
string
type
string
units
number<double>