BillKit/DocsConsole
Usage records

List usage records

List the usage reported against one metered subscription.

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

Parameters

ParameterDescription
subscription_idstring · pathrequiredId of the subscription, which starts sub_.
invoice_idstring | null · queryoptionalFilter by billing state: 'pending' for records not yet invoiced, or an invoice id for the records it billed. At most 64 characters.
limitinteger · queryoptionalMaximum number of objects to return. Defaults to 10. Between 1 and 100.
starting_afterstring | null · queryoptionalCursor for pagination: the id of the last object on the previous page. Returns the objects listed after it. An id that names no such object is a 400. At most 128 characters.

Cursor-paginated. limit caps a page and starting_after takes the last id you saw.

Returns

Returns a page of UsageRecordResponse objects. data holds the page and has_more says whether another one exists. Page forward by passing the last id of the page as starting_after; a short page is not the end of the list.

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_records \
  -H "Authorization: Bearer $BILLKIT_API_KEY"
Response · 200 OK
{
  "data": [
    {
      "created": 1789392000,
      "id": "ur_9XKp2vQ1",
      "identifier": "string",
      "invoice_id": "inv_9XKp2vQ1",
      "livemode": false,
      "metadata": {
        "key": "value"
      },
      "object": "usage_record",
      "occurred_at": 1789392000,
      "quantity": 0,
      "subscription_id": "sub_9XKp2vQ1",
      "written_off_at": 1789392000
    }
  ],
  "has_more": false,
  "object": "list"
}