Get billing insights

GET

/billing/insights

const url = 'https://example.com/api/billing/insights';
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/insights \
  --header 'Authorization: Bearer <token>'

Returns plan, usage counters, upcoming invoice, recent invoices, and payment method sourced from Stripe. Falls back gracefully when no Stripe customer is linked or the secret key is unset.

Authorizations

bearerApiKey
cookieAuth

Responses

200

Billing insights

application/json

object

key

additional properties

any

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