> ## Documentation Index > Fetch the complete documentation index at: https://docs.qumo-deploy.com/llms.txt > Use this file to discover all available pages before exploring further. # Open the billing portal > Creates a Stripe Customer Portal session for the organization and returns its URL. `flow` opens the portal directly on a plan change or cancellation of the live subscription; without a live subscription, or when the portal does not allow that flow, it opens on the portal's home page. Returns 404 when the organization has never started a checkout. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v1/billing/portal-sessions openapi: 3.1.0 info: title: Qumo Deploy REST API description: > The Qumo Deploy control plane: organizations, projects, signing keys, machine identities, access control, audit and billing. Relay credentials are not issued here: your app signs them with its own [signing keys](/guides/signing-keys). Every operation here is generated against the routes the server registers and checked in CI, so an operation in this reference exists and a route missing from it is deliberately internal (relay mesh, webhooks, probes, operator-only and browser sign-in routes). Errors are JSON objects with one `error` field. What each status code means is in [Error codes](/guides/error-codes); the token scope each permission needs is in [Scopes and permissions](/guides/scopes-permissions). version: 1.0.0 servers: - url: https://api.qumo-deploy.com description: Public API (Bearer tokens only; cookies are ignored) security: [] tags: - name: Account description: The signed-in user's own sessions, tokens, security settings and data. - name: Device flow description: OAuth 2.0 device authorization, used by `qumod login`. - name: Organizations description: Organizations, their members and usage. - name: Projects description: Projects inside an organization. - name: Signing keys description: Keys your app signs relay credentials with. - name: Relays description: Where clients of a broadcast path connect. - name: Identities description: Machine identities, their tokens and IP allowlists. - name: Access control description: Roles, IAM bindings and invitations. - name: Audit description: The audit log and its webhook. - name: Notifications description: Notification policies. - name: Billing description: Plans, usage cost, budgets, invoices and payment methods. - name: Pricing description: Public price list. paths: /v1/billing/portal-sessions: post: tags: - Billing summary: Open the billing portal description: > Creates a Stripe Customer Portal session for the organization and returns its URL. `flow` opens the portal directly on a plan change or cancellation of the live subscription; without a live subscription, or when the portal does not allow that flow, it opens on the portal's home page. Returns 404 when the organization has never started a checkout. operationId: createPortalSession parameters: - $ref: '#/components/parameters/OrganizationIdQuery' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PortalSessionRequest' responses: '200': description: The portal session was created. content: application/json: schema: $ref: '#/components/schemas/PortalSession' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' security: - token: [] - cliSession: [] - sessionCookie: [] csrfToken: [] components: parameters: OrganizationIdQuery: name: organization_id in: query required: false description: > The organization the request acts in. Required with a personal token or a session, which name no organization themselves; an identity token's organization is implied. schema: type: string format: uuid example: 3f8c2a1e-7b4d-4e9a-9c61-2d5e8f0a1b7c schemas: PortalSessionRequest: type: object properties: return_url: type: string format: uri description: Where the portal sends the customer back to. example: https://console.qumo-deploy.com/settings/billing flow: type: string enum: - '' - subscription_update - subscription_cancel description: | Opens the portal on a specific task for the live subscription: `subscription_update` (change plan) or `subscription_cancel`. Empty or omitted opens the portal's home page. example: subscription_update PortalSession: type: object required: - url properties: url: type: string format: uri description: The portal session URL to redirect the customer to. example: >- https://billing.stripe.com/p/session/live_YWNjdF8xUXhSN2FMa2RJd0h1N2l4 Error: type: object required: - error properties: error: type: string description: A human-readable message. example: organization_id is required responses: BadRequest: description: >- Malformed request or failed validation. See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Missing or invalid credentials. See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- Authenticated but not allowed (permission, token scope, IP allowlist or CSRF). See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: >- Not found, or not visible to the caller. See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: >- Rate limited; retry with backoff. See [Error codes](/guides/error-codes). content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: token: type: http scheme: bearer bearerFormat: qumo_pat_ description: > A personal access token (`POST /v1/auth/tokens`) or a machine identity token (`POST /v1/projects/{project_id}/identities/{identity_id}/tokens`), both prefixed `qumo_pat_`. A token's scopes cap what it can do; see [Scopes and permissions](/guides/scopes-permissions). A personal token names no organization: on a route whose path names no project or organization, pass `?organization_id=`. cliSession: type: http scheme: bearer description: | The session token `qumod login` obtains through the device flow (`POST /v1/auth/device/token`). It acts as the signed-in user, like a console session, and needs no CSRF token. sessionCookie: type: apiKey in: cookie name: __Host-qumo_session description: | The console's browser session. Accepted only on the console origin (`https://console.qumo-deploy.com`), never on `api.qumo-deploy.com`. A request that changes state must also send `X-CSRF-Token`. csrfToken: type: apiKey in: header name: X-CSRF-Token description: | CSRF token paired with `sessionCookie` on POST, PUT, PATCH and DELETE. Bearer requests do not send it. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.