OverviewPlatformsAPI Reference
Billing

Get a receipt link

For a paid order from GET /v1/billing/invoices, returns a receipt PDF URL that expires soon.

GET
/v1/billing/invoices/{id}/url

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Path Parameters

id*string

Which paid order. Ids come from GET /v1/billing/invoices.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/billing/invoices/string/url"
{  "url": "string"}
Was this page helpful?

Start a top-up

Returns a hosted checkout link with `amountCents` filled in. The buyer can change it there, from $20 to $5,000. The balance is credited within a minute of payment, and tracking paused for balance resumes right away. This call charges nothing by itself. `successUrl` must be on an origin this deployment trusts. Leave it out to return to the dashboard's billing page.

Get the balance

Returns every detail of the prepaid balance. That covers the ledger total, pending mention charges, the effective balance used for pausing, the daily spend and days left, running and paused keywords, the cost of a day and of resuming, the welcome credit, the latest top-up, the top-up limits and the auto-recharge settings. `GET /v1/usage` gives a shorter version.