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
Delete credit block
curl --request DELETE \
--url https://api.withorb.com/v1/credit_blocks/{block_id} \
--header 'Authorization: Bearer <token>'{
"type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
"status": 400,
"detail": "<string>",
"title": "<string>"
}Credit
Delete credit block
This endpoint deletes a credit block by its ID.
When a credit block is deleted:
- The block is removed from the customer’s credit ledger.
- Any usage of the credit block is reversed, and the ledger is replayed as if the block never existed.
- If invoices were generated from the purchase of the credit block, they will be deleted if in draft status, voided if issued, or a credit note will be issued if the invoice is paid.
Issued invoices that had credits applied from this block will not be regenerated, but the ledger will reflect the state as if credits from the deleted block were never applied.
DELETE
/
credit_blocks
/
{block_id}
Delete credit block
curl --request DELETE \
--url https://api.withorb.com/v1/credit_blocks/{block_id} \
--header 'Authorization: Bearer <token>'{
"type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
"status": 400,
"detail": "<string>",
"title": "<string>"
}Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.