Set a plan's trial
Sets the plan's free trial, replacing any trial it already has. The trial applies to new subscriptions only; running subscriptions keep the terms they started with. Works on active products too. 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
Path Parameters
ID of the plan.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v1/subscriptions/plans/spl_ba_PpkW16oIW/trial" \ -H "Content-Type: application/json" \ -d '{ "trial_days": 14 }'{ "id": "spl_ba_PpkW16oIW", "name": "Monthly Subscription", "sku": "BOLT-12345", "created_at": "2023-10-01T12:00:00Z", "updated_at": "2023-10-01T12:00:00Z", "frequency": 1, "product_id": "sp_Tlj0Osm0N76T", "frequency_unit": "month", "initial_period": { "frequency": 2, "frequency_unit": "week" }, "checkout_link": "https://your_site.c.boltapp.com/g?merchant_product_id=37&merchant_variant_id=67&publishable_key=BQ9PKQksUGtj.Q9LwVLfV3WF4.32122926f7b9651a416a5099dc92dc2b4c87c8b922c114229f83b345d65f1195", "base_price": 3000, "ubb": true, "usage_pricing": [ { "meter_name": "API Calls", "event_type": "api_call", "aggregation_type": "sum", "charge_model": "per_unit", "charge_config": {}, "currency": "USD" } ], "status": "active", "currency": "USD", "trial": { "trial_days": 14 }, "usage": { "meter_id": 0, "charge_model": "string", "charge_config": {}, "sessions": [ { "duration": 0, "duration_unit": "string", "alert_threshold": "string" } ] }}Remove a plan's trial DELETE
Removes the plan's free trial. New subscriptions start billing immediately; running subscriptions keep the terms they started with.
Attach a promotion to a plan POST
Attaches a promotion of the plan's product to the plan. The discount applies to new carts on that plan; running subscriptions are not re-priced. Catalog divisions only.