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
curl --request GET \
--url https://api.withorb.com/v1/customers/{customer_id}/credits/top_ups \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"currency": "<string>",
"threshold": "<string>",
"amount": "<string>",
"per_unit_cost_basis": "<string>",
"invoice_settings": {
"auto_collection": true,
"net_terms": 123,
"memo": "<string>",
"require_successful_payment": false
},
"expires_after": 123,
"expires_after_unit": "day"
}
],
"pagination_metadata": {
"has_more": true,
"next_cursor": "<string>"
}
}List top-ups
curl --request GET \
--url https://api.withorb.com/v1/customers/{customer_id}/credits/top_ups \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"currency": "<string>",
"threshold": "<string>",
"amount": "<string>",
"per_unit_cost_basis": "<string>",
"invoice_settings": {
"auto_collection": true,
"net_terms": 123,
"memo": "<string>",
"require_successful_payment": false
},
"expires_after": 123,
"expires_after_unit": "day"
}
],
"pagination_metadata": {
"has_more": true,
"next_cursor": "<string>"
}
}Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Query Parameters
The number of items to fetch. Defaults to 20.
1 <= x <= 100Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.
Response
OK
Show child attributes
Show child attributes
The currency or custom pricing unit to use for this top-up. If this is a real-world currency, it must match the customer's invoicing currency.
The threshold at which to trigger the top-up. If the balance is at or below this threshold, the top-up will be triggered.
The amount to increment when the threshold is reached.
How much, in the customer's currency, to charge for each unit.
Settings for invoices generated by triggered top-ups.
Show child attributes
Show child attributes
Whether the credits purchase invoice should auto collect with the customer's saved payment method.
The net terms determines the difference between the invoice date and the issue date for the invoice. If you intend the invoice to be due on issue, set this to 0.
An optional memo to display on the invoice.
When true, credit blocks created by this top-up will require that the corresponding invoice is paid before they are drawn down from. If any topup block is pending payment, further automatic top-ups will be paused until the invoice is paid or voided.
The number of days or months after which the top-up expires. If unspecified, it does not expire.
The unit of expires_after.
day, month Was this page helpful?