Update credit block
This endpoint updates the metadata of a credit block. Keys you pass are added to the block’s existing
metadata or overwrite the value already stored for that key, and setting a key to null removes it. Passing
null for metadata clears all of the block’s metadata. The block’s increment entry in the
credits ledger reports the block’s metadata, so it shows the update too.
Other fields on a credit block cannot be changed through this endpoint. Deleted credit blocks return a 404.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Body
User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.
Response
OK
The Credit Block resource models prepaid credits within Orb.
User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.
active, pending_payment How this credit block was created: allocation (a subscription's recurring credit allocation), top_up (an automatic balance-threshold top-up), commitment (a subscription commitment true-up rolled forward as credit), or manual (a manual credit ledger increment, including credits voided or expired off another block).
allocation, top_up, commitment, manual The credit allocation this block was created from, including the catalog item it was allocated for. Null for blocks not created via an allocation.
The subscription commitment this block was rolled forward from. Null for blocks not created from a commitment true-up.