Billing mAPI reference
Complete reference documentation for the Billing resource.
Billing
#Use the billing API to retrieve a snapshot of your account's current draft invoice, including amount due, plan, per-metric usage, and remaining credit blocks. See Knock plans for details on plans and usage.
Endpoints
Get billing summary
#Returns a snapshot of the current draft invoice for the account, including amount due, plan, per-metric usage, and remaining credit blocks.
Endpoint
Returns
A snapshot of the current draft Orb invoice for the account, including plan, per-metric usage, and remaining credit blocks.
The amount due on the draft invoice, as a decimal string.
Unexpired Orb credit blocks for custom pricing units on the draft invoice, including scheduled and depleted allotments.
The Orb custom pricing-unit identifier, such as mnr_credits or ai_credits.
When the block becomes effective.
When the block expires.
The Orb credit block id.
The display name for the credit currency.
The block's original allocation.
The block's remaining balance.
Derived block status: scheduled when not yet effective, depleted when remaining is zero or less, otherwise active.
The invoice currency code, such as USD.
The Orb draft invoice id, if present.
The end of the current usage period, hoisted from the first usage line item.
The start of the current usage period, hoisted from the first usage line item.
The Knock plan currently assigned to the account.
The human-readable plan name.
The unique identifier of the plan.
The plan type.
The date the draft invoice is scheduled to be issued.
Per-metric usage line items from the draft invoice.
The billed dollar amount for this metric after credits and adjustments.
Prepaid credits applied to this metric during the current service period.
The Orb billable metric id.
The Orb billable metric name.
The Orb price currency for this line item, used to correlate usage with credit blocks.
Orb line-item usage quantity for this period. This is not replaced by credits_applied.
Whether the GraphQL usage quantity is raw usage or credits applied. Prefer quantity and credits_applied for new clients.
Returned when the account exceeds one request per second for this endpoint.
BillingSummary
#A snapshot of the current draft Orb invoice for the account, including plan, per-metric usage, and remaining credit blocks.
Attributes
The amount due on the draft invoice, as a decimal string.
Unexpired Orb credit blocks for custom pricing units on the draft invoice, including scheduled and depleted allotments.
The Orb custom pricing-unit identifier, such as mnr_credits or ai_credits.
When the block becomes effective.
When the block expires.
The Orb credit block id.
The display name for the credit currency.
The block's original allocation.
The block's remaining balance.
Derived block status: scheduled when not yet effective, depleted when remaining is zero or less, otherwise active.
The invoice currency code, such as USD.
The Orb draft invoice id, if present.
The end of the current usage period, hoisted from the first usage line item.
The start of the current usage period, hoisted from the first usage line item.
The Knock plan currently assigned to the account.
The human-readable plan name.
The unique identifier of the plan.
The plan type.
The date the draft invoice is scheduled to be issued.
Per-metric usage line items from the draft invoice.
The billed dollar amount for this metric after credits and adjustments.
Prepaid credits applied to this metric during the current service period.
The Orb billable metric id.
The Orb billable metric name.
The Orb price currency for this line item, used to correlate usage with credit blocks.
Orb line-item usage quantity for this period. This is not replaced by credits_applied.
Whether the GraphQL usage quantity is raw usage or credits applied. Prefer quantity and credits_applied for new clients.