What is measured
The unit of measure is the active instance-day. For each billable instance, the API counts the days committed in the cycle, and the cycle’s total is the sum of those days across all your instances.- An instance active for the whole cycle counts the full cycle.
- An instance that becomes billable mid-cycle commits the days from that point until renewal.
- Deleting an instance does not reduce the days already committed. See How billing works.
- An instance still on trial does not count while it is in that state.
Account billing summary
GET /api/account/billing/summary
Returns the summary of the account’s current cycle. Authenticate with the account TokenAccount, or with the global token passing ?account=<account-name>.
200 OK
boolean
true when the account is Enterprise. If it comes false, the other fields do not appear.integer
Your contract’s monthly credit (base), in cents. It is the invoice floor.
integer
The usage amount already committed in the cycle, in cents, proportional to the instance-days.
integer
The projected charge for the cycle, in cents: the greater of
baseCents and committedCents.integer
The sum of billable instance-days in the cycle.
integer
The peak of simultaneous billable instances in the cycle.
string
Start of the current cycle.
string
End of the current cycle.
string
When the next charge happens (the end of the cycle).
Before the first renewal, the cycle window may not be filled in yet, and the summary shows the
base as the projected floor.Per-instance billing in the listing
GET /api/instance/list already brings, for each instance, a billing block with the billing state. It appears only on calls with an account or global token, never with an instance token.
string
trial or billable.string | null
When the trial ends.
null when the instance is already billable.string | null
Since when the instance is billed.
null while on trial.integer
Days left on the trial, rounded up.
0 outside the trial.boolean
true when the instance is already billable.Tracking in real time
To react to each state change, use the Enterprise webhooks. They notify you when a trial starts, when it is about to end and when an instance becomes billable, which lets you mirror that state in your own dashboard.Next
Usage statement
The itemized invoice for the period, instance by instance.
Connection history
The timeline of when each number was connected.
How billing works
Credit, trial and the committed model in detail.
Enterprise webhooks
Track the state changes in real time.