Clerk API (unofficial showcase)
GET/billing/statements/{statementID}

Get a billing statement

Retrieves a billing statement by its unique identifier. Use statementID to inspect the statement’s payer, current status, totals, and grouped items.

1 parameter
statementIDstringrequired
The unique identifier of the billing statement to retrieve.

6 status codes
200Returns the billing statement object, including its identifier, instance, creation timestamp, payer, status, totals, and groups of items.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:commerce_statement
idstringrequired
Unique identifier for the billing statement.
instance_idstringrequired
The ID of the instance this statement belongs to.
timestampintegerrequired
Unix timestamp (in milliseconds) when the statement was created.
payerobjectrequired
The payer associated with this statement.
statusstringrequired
The current status of the statement.
Allowed:openclosed
totalsobjectrequired
Totals for the statement.
groupsarray<object>required
Array of statement groups.
400Returned when the request is not successful.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Returned when authentication is invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Returned when the billing statement cannot be found.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Returned when request parameters are invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
500Returned when the request is not successful.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned when the request is unsuccessful; a 401 when authentication is invalid; a 404 when the statement cannot be found; a 422 when request parameters are invalid; and a 500 when the request is unsuccessful. The statementID path parameter must identify an existing billing statement.