Skip to Content
veriom

Open billing portal

Open the Stripe billing portal for the workspace's subscription. Admins change plan or payment method, download invoices, or cancel there; Stripe reports each change to the billing webhook. Needs an admin in a browser session with a recent step-up.

POST
/v1/workspaces/{workspace_id}/plan/billing-portal

Open the Stripe billing portal for the workspace's subscription.

Admins change plan or payment method, download invoices, or cancel there; Stripe reports each change to the billing webhook. Needs an admin in a browser session with a recent step-up.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
portal_url*Portal Url

The Stripe billing portal page to send the browser to.

Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/plan/billing-portal'
Example Response
{  "portal_url": "string"}