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 POST \
--url https://api.withorb.com/v1/customers/{customer_id}/credits/top_ups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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",
"active_from": "2023-11-07T05:31:56Z"
}
'{
"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"
}Create top-up
This endpoint allows you to create a new top-up for a specified customer’s balance. While this top-up is active, the customer’s balance will added in increments of the specified amount whenever the balance reaches the specified threshold.
If a top-up already exists for this customer in the same currency, the existing top-up will be replaced.
curl --request POST \
--url https://api.withorb.com/v1/customers/{customer_id}/credits/top_ups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"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",
"active_from": "2023-11-07T05:31:56Z"
}
'{
"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"
}Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Body
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
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 The date from which the top-up is active. If unspecified, the top-up is active immediately. This should not be more than 10 days in the past.
Response
Created
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
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?