Sign in

d779de93a5ee

latestOpenAPI 3.0.42026-08-13351856967.1 KB
Billing

Gets the current-period usage and applicable limit for a customer.

Defaults to the authenticated customer when no customerId is provided.

get/billing/summary

Query parameters

organizationIdstring

The organization to get the billing summary for. Defaults to the caller's own organization.

Response

OK

mode'Usage' | 'Limited' | 'Prepaid' required
currentPeriodUsagenumber double required

The accumulated billable spend in the current billing period.

effectiveLimitnumber double nullable

The spending cap for the current period, or null when unlimited.

availableAmountnumber double nullable

The remaining prepaid balance, set only for prepaid customers.

minimumSpendCommitmentnumber double required

Dollars the customer has committed to spend per billing period; 0 means no commitment.

platformFeenumber double nullable

The recurring fee charged once per billing period. null means no platform fee and no line item; 0 is an explicit $0 fee that is still itemized.