API documentation
Alert
Credit
- GETFetch credit block
- DELDelete credit block
- GETFetch customer credit balance by external customer id
- GETFetch customer credits ledger by external ID
- POSTCreate ledger entry by external ID
- GETList top-ups by external ID
- POSTCreate top-up by external ID
- DELDeactivate top-up by external ID
- GETFetch customer credit balance
- GETFetch customer credits ledger
- POSTCreate ledger entry
- GETList top-ups
- POSTCreate top-up
- DELDeactivate top-up
Customer
- GETList customers
- POSTCreate customer
- GETFetch customer by external ID
- PUTUpdate customer by external ID
- GETFetch customer costs by external ID
- POSTUpdate payment methods from payment provider
- GETFetch customer
- PUTUpdate customer
- DELDelete customer
- GETList balance transactions
- POSTCreate customer balance transaction
- GETFetch customer costs
- POSTUpdate payment methods from payment provider
Dimensional Price Group
Event
Invoice
Availability
Plan
- GETList plans
- POSTCreate plan
- GETFetch plan by external ID
- PUTUpdate plan by external ID
- POSTSet plan version as default by external ID
- POSTCreate plan version by external ID
- GETFetch plan version by external ID
- GETFetch plan
- PUTUpdate plan by id
- GETList migrations
- GETFetch migration
- POSTCancel migration
- POSTSet plan version as default
- POSTCreate plan version
- GETFetch plan version
Price
Subscription Change
Subscription
- GETList subscriptions
- POSTCreate subscription
- GETFetch subscription
- PUTUpdate subscription
- POSTCancel subscription
- GETFetch subscription costs
- POSTRedeem Coupon
- GETFetch subscription schedule
- POSTSchedule plan change
- POSTTrigger phase
- POSTUnschedule subscription cancellation
- POSTUnschedule fixed fee quantity updates
- POSTUnschedule plan change
- POSTUpdate price quantity
- POSTUpdate trial for subscription
- GETFetch subscription usage
Price interval
Fetch credit block
Copy
Ask AI
curl --request GET \
--url https://api.withorb.com/v1/credit_blocks/{block_id} \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"id": "<string>",
"balance": 123,
"effective_date": "2023-11-07T05:31:56Z",
"expiry_date": "2023-11-07T05:31:56Z",
"per_unit_cost_basis": "<string>",
"status": "active",
"maximum_initial_balance": 123,
"filters": [
{
"field": "price_id",
"operator": "includes",
"values": [
"<string>"
]
}
]
}Credit
Fetch credit block
This endpoint returns a credit block identified by its block_id.
GET
/
credit_blocks
/
{block_id}
Fetch credit block
Copy
Ask AI
curl --request GET \
--url https://api.withorb.com/v1/credit_blocks/{block_id} \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"id": "<string>",
"balance": 123,
"effective_date": "2023-11-07T05:31:56Z",
"expiry_date": "2023-11-07T05:31:56Z",
"per_unit_cost_basis": "<string>",
"status": "active",
"maximum_initial_balance": 123,
"filters": [
{
"field": "price_id",
"operator": "includes",
"values": [
"<string>"
]
}
]
}Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Response
OK
The Credit Block resource models prepaid credits within Orb.
Available options:
active, pending_payment Show child attributes
Show child attributes
The property of the price to filter on.
Available options:
price_id, item_id, price_type, currency, pricing_unit_id Should prices that match the filter be included or excluded.
Available options:
includes, excludes The IDs or values that match this filter.
Was this page helpful?
⌘I