API documentation
Alert
Credit
- GETFetch credit block
- DELDelete credit block
- GETList invoices for 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
- POSTCreate portal session 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
- POSTCreate portal session
- POSTUpdate payment methods from payment provider
Dimensional Price Group
Event
Invoice
- POSTCreate invoice line item
- GETList invoices
- POSTCreate a one-off invoice
- GETList invoices summary
- POSTIssue invoice summary
- GETFetch upcoming invoice
- GETFetch invoice
- PUTUpdate invoice
- DELDelete invoice line item
- POSTIssue invoice
- POSTMark invoice as paid
- POSTPay invoice
- POSTRegenerate invoice PDF
- POSTRegenerate receipt PDF
- POSTVoid invoice
License
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
curl --request GET \
--url https://api.withorb.com/v1/credit_blocks/{block_id}/invoices \
--header 'Authorization: Bearer <token>'{
"block": {
"metadata": {},
"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>"
]
}
]
},
"invoices": [
{
"id": "<string>",
"invoice_number": "<string>",
"status": "issued",
"customer": {
"id": "<string>",
"external_customer_id": "<string>"
},
"subscription": {
"id": "<string>"
}
}
]
}List invoices for credit block
This endpoint returns the credit block and its associated purchasing invoices.
If a credit block was purchased (as opposed to being manually added), this endpoint returns the invoices that were created to charge the customer for the credit block. For credit blocks with payment schedules spanning multiple periods (e.g., monthly payments over 12 months), multiple invoices will be returned.
For credit blocks created by subscription allocation prices, this endpoint returns the subscription invoice containing the allocation line item that created the block.
If the credit block was not purchased (e.g., manual increment), an empty invoices list is returned.
Note: This endpoint is currently experimental and its interface may change in future releases. Please contact support before building production integrations against this endpoint.
curl --request GET \
--url https://api.withorb.com/v1/credit_blocks/{block_id}/invoices \
--header 'Authorization: Bearer <token>'{
"block": {
"metadata": {},
"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>"
]
}
]
},
"invoices": [
{
"id": "<string>",
"invoice_number": "<string>",
"status": "issued",
"customer": {
"id": "<string>",
"external_customer_id": "<string>"
},
"subscription": {
"id": "<string>"
}
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.withorb.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Was this page helpful?