Docs/API

Billing API

Billing API

Billing endpoints help account owners unlock domain limits and manage the billing state.

Get Billing Status

GET /v1/billing/status

Returns the current plan, domain usage, and entitlement state for the account.

Refresh Billing Status

POST /v1/billing/status

Use this after checkout or portal changes when the dashboard needs a fresh billing view.

Create Checkout Session

POST /v1/billing/checkout-sessions

Returns a hosted Stripe Checkout URL.

Sync Checkout Session

PATCH /v1/billing/checkout-sessions

Use this to refresh local fulfillment state after returning from checkout.

Create Portal Session

POST /v1/billing/portal-sessions

Returns a hosted customer portal URL.

Change Plan

POST /v1/billing/plan-changes

Resume Subscription

POST /v1/billing/subscription-resume

Handling payment_required

When domain creation returns payment_required, show a billing action to an account owner and retry domain creation only after billing status is updated.