API reference · Account and billing

Usage and invoices

3 operations of the Ankra Cloud API: Usage, the billing log and invoices.

Invoices, newest month first#

GET/v1/invoices

Parameters
Name	In	Type	Description
`cursor`	query	string	The `next_cursor` of the previous page.

200A page of invoices.application/json · InvoiceList

200 response fields
Field	Type	Description
`items`required	array of Invoice
`id`required	string
`period`required	string
`period_start`required	string (date-time)
`period_end`required	string (date-time)
`currency`required	string
`total_cents`required	integer	The usage total, before credits.
`credit_applied_cents`	integer	The part of the total account credits paid.
`amount_due_cents`	integer	What is charged: `total_cents - credit_applied_cents`. An invoice credits pay in full is `paid` and never sent to Stripe.
`created_at`required	string (date-time)
`lines`required	array of InvoiceLine
`kind`required	string	`credit` lines are credits applied to the invoice: a negative `amount_cents`, the credit's label as `name` (for example "Welcome credit WELCOME500") and its id as `resource_id`.One of `usage`, `credit`
`resource_type`required	string
`resource_id`required	string
`name`required	string
`plan`required	string
`hours`required	integer
`amount_cents`required	integer
`cap_cents`required	integer
`payment_status`	string	`unbilled` until Stripe has the invoice (or when payments are not configured or it totals nothing); `overdue` after a failed charge.One of `unbilled`, `open`, `paid`, `overdue`
`hosted_invoice_url`	string \| null	Stripe's page to view and pay the invoice.
`next_cursor`required	string \| null	Pass as `?cursor=` for the next page; null on the last page.

400The request is invalid; detail says why.
401Not signed in, or the credential is invalid or expired.
403The role lacks the permission, the token is read-only (a read-only token also gets reason: read_only_token_cannot_read_credentials on every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified).
defaultAny other error, usually 500.

bash

curl 'https://cloud.ankra.app/v1/invoices' \
  -H "Authorization: Bearer $ANKRA_CLOUD_TOKEN"

GET/v1/usage/billing-log

Parameters
Name	In	Type	Description
`cursor`	query	string	The `next_cursor` of the previous page.
`limit`	query	integer

200A page of billing-log lines.application/json · BillingLogEntryList

200 response fields
Field	Type	Description
`items`required	array of BillingLogEntry
`date`required	string (date)
`resource_type`required	string
`resource_id`required	string
`name`required	string
`plan`required	string
`hours`required	integer
`hourly_price_millicents`required	integer
`amount_cents`required	integer
`next_cursor`required	string \| null	Pass as `?cursor=` for the next page; null on the last page.

400The request is invalid; detail says why.
401Not signed in, or the credential is invalid or expired.
403The role lacks the permission, the token is read-only (a read-only token also gets reason: read_only_token_cannot_read_credentials on every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified).
defaultAny other error, usually 500.

bash

curl 'https://cloud.ankra.app/v1/usage/billing-log' \
  -H "Authorization: Bearer $ANKRA_CLOUD_TOKEN"

GET/v1/usage/summary

200The usage summary.application/json · UsageSummary

200 response fields
Field	Type	Description
`currency`required	string
`period_start`required	string (date-time)
`period_end`required	string (date-time)
`metered_through`required	string (date-time) \| null
`month_to_date_cents`required	integer
`estimated_month_cents`required	integer
`resources`required	array of UsageResource
`resource_type`required	string
`resource_id`required	string
`name`required	string
`plan`required	string
`hours`required	integer
`amount_cents`required	integer
`cap_cents`required	integer
`hourly_price_millicents`required	integer
`is_active`required	boolean
`daily`required	array of UsageDay	The last 90 days including today, oldest first, zero-filled.
`date`required	string (date)
`amount_cents`required	integer
`credit_balance_cents`	integer	What the account's live credits have left; the next invoice spends it before charging.
`credit_next_expiry`	string (date-time) \| null	The soonest expiry of a live credit.

401Not signed in, or the credential is invalid or expired.
403The role lacks the permission, the token is read-only (a read-only token also gets reason: read_only_token_cannot_read_credentials on every credential read), the CSRF header is missing, a support session may not do this, or the route needs a verified email address and the caller's is not (reason: email_unverified).
defaultAny other error, usually 500.

bash

curl 'https://cloud.ankra.app/v1/usage/summary' \
  -H "Authorization: Bearer $ANKRA_CLOUD_TOKEN"