curl https://api.thanxsandbox.com/partner/promotions/promo_abc123?merchant_id={merchant_id} \
-X GET \
-H 'X-ClientId: {client_id}' \
-H 'Accept-Version: v4.0' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access_token}'
{
"promotion": {
"id": "promo_abc123",
"name": "Summer 20% Off",
"state": "active",
"discount_type": "percent",
"discount_value": "20.0",
"minimum_spend": "25.0",
"maximum_discount": "10.0",
"fine_print": "Limit one per customer",
"redemption_venue": "online",
"starts_at": "2026-06-01T00:00:00Z",
"ends_at": "2026-08-31T23:59:59Z",
"generation_type": "single_use",
"redemption_count": 142,
"total_codes": 10000,
"code_generation_status": "complete"
}
}
{
"error": {
"code": "NOT_FOUND",
"message": "Promotion not found"
}
}
Promotions
Get Promotion
Returns a single active promotion
GET
/
partner
/
promotions
/
:id
curl https://api.thanxsandbox.com/partner/promotions/promo_abc123?merchant_id={merchant_id} \
-X GET \
-H 'X-ClientId: {client_id}' \
-H 'Accept-Version: v4.0' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access_token}'
{
"promotion": {
"id": "promo_abc123",
"name": "Summer 20% Off",
"state": "active",
"discount_type": "percent",
"discount_value": "20.0",
"minimum_spend": "25.0",
"maximum_discount": "10.0",
"fine_print": "Limit one per customer",
"redemption_venue": "online",
"starts_at": "2026-06-01T00:00:00Z",
"ends_at": "2026-08-31T23:59:59Z",
"generation_type": "single_use",
"redemption_count": 142,
"total_codes": 10000,
"code_generation_status": "complete"
}
}
{
"error": {
"code": "NOT_FOUND",
"message": "Promotion not found"
}
}
Scope required:
promos.readactive 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
Response
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.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.curl https://api.thanxsandbox.com/partner/promotions/promo_abc123?merchant_id={merchant_id} \
-X GET \
-H 'X-ClientId: {client_id}' \
-H 'Accept-Version: v4.0' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access_token}'
{
"promotion": {
"id": "promo_abc123",
"name": "Summer 20% Off",
"state": "active",
"discount_type": "percent",
"discount_value": "20.0",
"minimum_spend": "25.0",
"maximum_discount": "10.0",
"fine_print": "Limit one per customer",
"redemption_venue": "online",
"starts_at": "2026-06-01T00:00:00Z",
"ends_at": "2026-08-31T23:59:59Z",
"generation_type": "single_use",
"redemption_count": 142,
"total_codes": 10000,
"code_generation_status": "complete"
}
}
{
"error": {
"code": "NOT_FOUND",
"message": "Promotion not found"
}
}