BillKit/DocsConsole
Usage records

Get usage summary

See what the next period close will bill for a metered subscription.

GET/v1/subscriptions/{subscription_id}/usage_summary
Operation get_usage_summary·Scope usage_records:read·OpenAPI v1.1.0

Parameters

ParameterDescription
subscription_idstring · pathrequiredId of the subscription, which starts sub_.

Returns

Returns an UsageSummaryResponse object.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the usage_records:read scope.
404No such object in this account and mode.
409Conflicts with the object's current state (state_conflict, or a more specific code), or an operation still in flight (operation_pending).
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X GET https://api.billkit.eu/v1/subscriptions/sub_9XKp2vQ1/usage_summary \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "currency": "EUR",
  "gross_cents": 1900,
  "livemode": false,
  "minimum_charge_cents": 1900,
  "net_cents": 1900,
  "object": "usage_summary",
  "open_invoice_id": "open_invoice_9XKp2vQ1",
  "pending_quantity": 0,
  "pending_record_count": 0,
  "period_end": 0,
  "period_start": 0,
  "subscription_id": "sub_9XKp2vQ1",
  "tax_cents": 1900,
  "will_charge": false
}