Create a cart promotion
Creates a cart promotion for the division, created active. Its discount applies to the whole cart, so it takes no plans. Catalog divisions only.
Admins and Developers can obtain their Bolt API key from the Bolt Merchant Dashboard. Send it together with X-Publishable-Key.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/subscriptions/promotions" \ -H "Content-Type: application/json" \ -d '{ "name": "Holiday sale", "target": "cart", "duration": "once", "amount_off": 500, "currency": "USD", "codes": [ { "code": "HOLIDAY5" } ] }'{ "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"}List all promotions GET
Retrieves the division's promotions, newest first, ten to a page, each with the products and plans it targets.
Delete a promotion by ID DELETE
Deactivates the promotion, item or cart, by its ID alone. New carts stop receiving the discount; subscriptions that already captured it keep their terms. A promotion still in draft is deleted outright.