List all promotions
Retrieves the division's promotions, newest first, ten to a page, each with the products and plans it targets.
Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard. Send it together with X-Publishable-Key.
In: header
Query Parameters
Filter by part of the promotion name, any case.
Filter by lifecycle status.
Value in
- "draft"
- "active"
- "deactivated"
The next_cursor of the page before.
Response Body
application/json
application/json
curl -X GET "https://example.com/v1/subscriptions/promotions"{ "data": [ { "id": "bcp_V9y3q4Jw8kQe", "name": "Launch discount", "status": "active", "target": "item", "automatic": true, "combinable": true, "priority": 0, "duration": "once", "percent_off": 0, "amount_off": 0, "currency": "USD", "minimum_amount": 0, "allowed_cycle_counts": 0, "max_redemptions": 0, "times_redeemed": 0, "allowed_customers": [ "string" ], "plan_ids": [ "string" ], "codes": [ { "id": "string", "code": "LAUNCH20", "active": true, "max_redemptions": 0, "times_redeemed": 0, "expires_at": "2019-08-24T14:15:22Z", "first_time_transaction": true } ], "redeem_by": "2019-08-24T14:15:22Z", "activated_at": "2019-08-24T14:15:22Z", "deactivated_at": "2019-08-24T14:15:22Z", "products": [ { "id": "string", "name": "string", "plans": [ { "id": "string", "name": "string" } ] } ] } ], "next_cursor": "string"}Delete a promotion DELETE
Deactivates the promotion. New carts stop receiving the discount; subscriptions that already captured it keep their terms. A promotion still in draft is deleted outright.
Create a cart promotion POST
Creates a cart promotion for the division, created active. Its discount applies to the whole cart, so it takes no plans. Catalog divisions only.