API referencePlatformPlatform billing
Self-serve: subscribe the project's Tenant account to a SaaS plan
Authorization
bearer_auth AuthorizationBearer <token>
In: header
Header 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
application/json
application/json
application/json
curl -X POST "https://example.com/platform/v1/billing/account/checkout" \ -H "X-Project-Id: 11111111-1111-1111-1111-111111111111" \ -H "Content-Type: application/json" \ -d '{ "plan_id": "00713021-9aea-41da-9a88-87760c08fa72", "vendor": "stripe" }'{ "billing_account_id": "db2251e5-5308-40a7-9f48-3aed5a9ce736", "plan_id": "00713021-9aea-41da-9a88-87760c08fa72", "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9", "status": "string", "step": "string", "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627", "three_ds_url": "string"}{ "detail": "Pool slug must be unique.", "instance": "urn:forestvpn:trace:a1b2c3d4", "title": "Validation Error", "type": "https://fvpn.net/errors/validation"}{ "detail": "Pool slug must be unique.", "instance": "urn:forestvpn:trace:a1b2c3d4", "title": "Validation Error", "type": "https://fvpn.net/errors/validation"}{ "detail": "Pool slug must be unique.", "instance": "urn:forestvpn:trace:a1b2c3d4", "title": "Validation Error", "type": "https://fvpn.net/errors/validation"}{ "detail": "Pool slug must be unique.", "instance": "urn:forestvpn:trace:a1b2c3d4", "title": "Validation Error", "type": "https://fvpn.net/errors/validation"}