Get billing summary

GET

/billing/summary

const url = 'https://example.com/api/billing/summary';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/billing/summary \
  --header 'Authorization: Bearer <token>'

Returns the current plan, subscription status, and Stripe identifiers.

Authorizations

bearerApiKey
cookieAuth

Responses

200

Billing summary

application/json

object

plan

required

string

Example

free

planLabel

required

string

Example

Free

status

Stripe subscription status

string | null

Example

active

currentPeriodEnd

string | null format: date-time

cancelAtPeriodEnd

required

boolean

billingAccountId

string | null format: uuid

stripeCustomerId

string | null

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean