Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Create portal sessions and call customer-facing endpoints with a portal token
POST /v1/portal/sessions
Authorization: Bearer orv_xxxxxxxx_your_secret
{
"customerId": "cust_acme",
"expiresInSeconds": 3600,
"allowPlanChanges": true,
"allowCreditPurchases": false
}
| Field | Type | Required | Description |
|---|---|---|---|
customerId | string | Yes | The customer the session is for. |
expiresInSeconds | integer | No | How long the session lasts, from 1 to 86,400. |
allowPlanChanges | boolean | No | Lets the customer switch to another published plan. |
allowCreditPurchases | boolean | No | Lets the customer buy credits, invoiced to them. |
GET /v1/portal/me
Authorization: Bearer <portal token>
| Method and path | Description |
|---|---|
GET /v1/portal/me | The customer. |
GET /v1/portal/config | Which portal features are enabled for this session. |
GET /v1/portal/plans | Published plans the customer can switch to. |
GET /v1/portal/plan-change/preview?planId=… | What switching to a plan would cost. Changes nothing. |
POST /v1/portal/plan-change | Switch the customer to a plan. |
GET /v1/portal/usage | Usage for the current period. |
GET /v1/portal/entitlements | Features and remaining allowances. |
GET /v1/portal/wallets | Credit balances. |
GET /v1/portal/credits | Credit history. |
POST /v1/portal/wallets/:type/purchase | Buy credits, invoiced to the customer. Requires allowCreditPurchases. |
GET /v1/portal/invoices | The customer’s invoices. |
GET /v1/portal/upcoming | The next invoice. |