Skip to main content
GET
Scope required: promos.read
This endpoint returns a single active promotion for the merchant. The promotion must belong to the specified merchant and be in the active state, otherwise a 404 Not Found is returned. The fields of the promotion’s active code pool are flattened onto the promotion, including generation_type, redemption_count, and total_codes.

​
Parameters

​
string
required
Promotion ID
​
string
required
Merchant ID

​
Response

​
string
Promotion ID
​
string
Promotion name
​
string
Promotion state (always active)
​
string
Type of discount the promotion applies: percent, item, or amount
​
string
Discount amount, as a string. Null if not set.
​
string
Minimum spend required to redeem, as a string. Null if not set.
​
string
Maximum discount that can be applied, as a string. Null if not set.
​
string
Terms and conditions
​
string
Where the promotion can be redeemed: all, instore, or online
​
datetime
Promotion start timestamp (ISO8601). Null if not set.
​
datetime
Promotion end timestamp (ISO8601). Null if not set.
​
string
How the pool’s codes are generated: multi_use (a shared code redeemable multiple times) or single_use (a batch of one-time codes). Null if the promotion has no code pool.
​
integer
Number of times codes in the active pool have been redeemed
​
integer
Total number of codes in the active pool
​
string
Status of asynchronous code generation for the active pool: none, in_progress, complete, or failed. Poll this field after requesting code generation via Create Promotion or Generate Promotion Codes.