API referenceConsumerBilling
Change_subscription_plan
Authorization
bearer_auth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Format
uuidHeader Parameters
X-Project-Id*string
UUID of the project that scopes consumer accounts, devices, sessions, and VSpaces for the request.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/consumer/v1/billing/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/change-plan" \ -H "X-Project-Id: 11111111-1111-1111-1111-111111111111" \ -H "Content-Type: application/json" \ -d '{ "new_plan_id": "2d17ed43-dab8-4ccb-b506-9f23ea4d4c78" }'{ "effective_at": "2019-08-24T14:15:22Z", "redirect_url": "string", "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627"}{ "detail": "Pool slug must be unique.", "instance": "urn:forestvpn:trace:a1b2c3d4", "title": "Validation Error", "type": "https://fvpn.net/errors/validation"}