Sign in

v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
Credit

Fetch credit block

This endpoint returns a credit block identified by its block_id.

get/credit_blocks/{block_id}

Path parameters

block_idstring required

Response

OK

metadataobject required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

idstring required
balancenumber required
effective_datestring date-time nullable required
expiry_datestring date-time nullable required
per_unit_cost_basisstring nullable required
status'active' | 'pending_payment' required
maximum_initial_balancenumber nullable required
credit_block_source'allocation' | 'top_up' | 'commitment' | 'manual' required

How this credit block was created: allocation (a subscription's recurring credit allocation), top_up (an automatic balance-threshold top-up), commitment (a subscription commitment true-up rolled forward as credit), or manual (a manual credit ledger increment, including credits voided or expired off another block).