API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Billing

AdminUpdated Sep 11, 2026

Billing

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

4 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/dashboard/accounts/:accountId/billing

Read the account plan, whether a subscription is live, and whether Stripe billing is configured on this deployment.

POST /v1/dashboard/accounts/:accountId/billing/checkout

Start a Stripe Checkout Session to upgrade to pro and return its URL. Owner or admin; 503 when Stripe is not configured. Never changes the plan itself.

POST /v1/dashboard/accounts/:accountId/billing/portal

Open a Stripe Billing Portal session to manage or cancel the subscription and return its URL. Owner or admin; 503 when Stripe or the customer is absent.

POST /v1/dashboard/accounts/:accountId/billing/subscriptions/:subscriptionId/allocate

Allocate (move) a platform subscription to one application. Each subscription powers a single app.

Was this page helpful?