Skip to main content
GET
Fetch credit block

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

block_id
string
required

Response

OK

The Credit Block resource models prepaid credits within Orb.

metadata
Metadata · object
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.

id
string
required
balance
number
required
effective_date
string<date-time> | null
required
expiry_date
string<date-time> | null
required
per_unit_cost_basis
string | null
required
status
enum<string>
required
Available options:
active,
pending_payment
maximum_initial_balance
number | null
required
filters
PriceFilter · object[]
required
credit_block_source
enum<string>
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).

Available options:
allocation,
top_up,
commitment,
manual
credit_allocation
CreditBlockAllocation · object | null

The credit allocation this block was created from, including the catalog item it was allocated for. Null for blocks not created via an allocation.

credit_commitment
CreditBlockCommitment · object | null

The subscription commitment this block was rolled forward from. Null for blocks not created from a commitment true-up.