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>"
}

Authorizations

Authorization

string

header

required

API Keys can be issued in the Orb's web application.

Path Parameters

block_id

string

required

Response

No Content

Fetch credit block Fetch customer credit balance by external customer id

⌘I

API documentation

Alert

Coupon

Credit

Credit note

Customer

Dimensional Price Group

Event

Invoice

Item

Metric

Availability

Plan

Price

Subscription Change

Subscription

Price interval

Delete credit block

Authorizations

Path Parameters

Response