Skip to main content
GET
/
credit_blocks
/
{block_id}
Fetch credit block
curl --request GET \
  --url https://api.withorb.com/v1/credit_blocks/{block_id} \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {},
  "id": "<string>",
  "balance": 123,
  "effective_date": "2023-11-07T05:31:56Z",
  "expiry_date": "2023-11-07T05:31:56Z",
  "per_unit_cost_basis": "<string>",
  "maximum_initial_balance": 123,
  "filters": [
    {
      "values": [
        "<string>"
      ]
    }
  ]
}

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