Skip to main content
POST
Redeem Receipt

Authorizations

Authorization
string
header
required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

Idempotency-Key
string
required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

Maximum string length: 64
Monime-Version
enum<string> | null

Specifies which version of the Monime API will handle this request.

Available options:
caph.2025-08-23,
caph.2025-06-20
Monime-Space-Id
string
required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Maximum string length: 64
Pattern: ^spc-.*$

Path Parameters

orderNumber
string
required

The order number of the receipt to be redeemed.

Maximum string length: 20

Body

application/json

Redeem one or more entitlements from a receipt. When processing a bulk redemption, if any entitlement is already exhausted, the entire operation is rejected.

redeemAll
boolean | null

Whether to redeem all entitlements in the receipt.

entitlements
object[] | null

List of entitlements to redeem. When set, it takes precedence over the 'redeemAll' flag.

metadata
object | null

Optional metadata for attaching context or tracking info.

Response

200 - application/json

OK

success
boolean

Represents the status of the query operation, confirming if it was successful. This field is always true

messages
any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

result
Redemption Result · object

Represents the outcome of redeeming entitlement(s) from a receipt.