SynqDocs
Management APIOrgs

Read the org's billing state

Its plan and where it stands with billing: free, on a trial (and when it ends, whether a card is on file to carry on, and a payment to end it now that waits for the bank's confirmation), paying, past due, or set to end at the period's end and move to the free plan; a downgrade waiting for the period's end (a trial's, on a trial), never beside an end; and whether a trial is still open to it. Needs `org.billing.view`.

GET/v1/orgs/{org}/billing

Its plan and where it stands with billing: free, on a trial (and when it ends, whether a card is on file to carry on, and a payment to end it now that waits for the bank's confirmation), paying, past due, or set to end at the period's end and move to the free plan; a downgrade waiting for the period's end (a trial's, on a trial), never beside an end; and whether a trial is still open to it. Needs org.billing.view.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

The org's id

Match^org_[0-9a-hjkmnp-tv-z]{26}$

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/billing" \  -H "Authorization: Bearer $SYNQ_API_KEY"
{  "plan": "pro",  "status": "trialing",  "interval": "month",  "trial_ends_at": "2026-11-04T16:00:00.000Z",  "current_period_end": "2026-10-21T12:00:00.000Z",  "cancel_at": "2026-11-22T16:00:00.000Z",  "scheduled_change": {    "plan": "string",    "interval": "month",    "at": "2026-10-21T12:00:00.000Z"  },  "called_off_change": {    "plan": "string",    "interval": "month"  },  "card_on_file": true,  "payment_requires_action": {    "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1Abc/test_YWNj",    "invoice": {      "id": "in_1Abc",      "number": "SYNQ-0001",      "status": "paid",      "currency": "usd",      "total_cents": "2500",      "amount_due_cents": "2500",      "created": "2026-10-04T16:00:00.000Z",      "period_start": "2026-10-21T12:00:00.000Z",      "period_end": "2026-10-21T12:00:00.000Z",      "hosted_invoice_url": "https://example.com",      "invoice_pdf": "https://example.com"    },    "expires_at": "2026-11-17T16:00:00.000Z",    "change": "change_plan",    "plan": "scale",    "interval": "month"  },  "trial_available": true}