Skip to main content
GET
cURL
Answers the five steps on the dashboard’s Get started page, so a coding agent can see where setup stands without the dashboard. A Sandbox or Live key gets the same answer. Needs the Catalog permission at Read.
  • agentConnectedAt: when a Sandbox key first made a request. The dashboard shows “Agent connected” from then on.
  • plans, customer, usage: a paid plan, a customer, and a check or track exist in the Sandbox. Setting up with a coding agent is done when plans is.
  • live.activated: Go to production is done and Live takes real payments.
  • live.missing: the production steps left: stripe_connection and webhook (a live Stripe account Ledger can receive events from), catalog_sync (a paid plan in Live, every one synced to Stripe) and api_key (a Live key). Deploy walks through them.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Where the workspace is in Get started.

agentConnectedAt
string | null
required

When a Sandbox API key first made a request. Null until then.

plans
boolean
required

A paid plan exists in the Sandbox.

customer
boolean
required

A customer exists in the Sandbox.

usage
boolean
required

A check or track has been made in the Sandbox.

live
object
required