Bolt has moved to boltapp.com. Stores still using bolt.com hosts must update now: see the migration guide.

Skip to content

Update a plan

View As MarkdownMCP
PUT
/v1/subscriptions/plans/{planId}

Rewrites a plan's base fields - name, SKU, frequency and price - while its product has never been active. Once the product has been activated, plans are immutable here; price changes are made by adding a new plan.

The trial and the promotions attached to a plan are managed through their own endpoints (setPlanTrial, deletePlanTrial, attachPlanPromotion, detachPlanPromotion) and can be changed at any time, on active products too. Catalog divisions only.

Authorization

X-API-Key<token>

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

planId*string

ID of the plan to update.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/subscriptions/plans/spl_ba_PpkW16oIW" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "frequency": 0,    "frequency_unit": "day"  }'
{  "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"      }    ]  }}