MOmonime
Receipt

Redeem Receipt

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

post/v1/receipts/{orderNumber}/redeem

Request

  • Base URL
    https://api.monime.io
  • URL
    https://api.monime.io/v1/receipts/{orderNumber}/redeem
  • Auth
    HTTP bearer

Path parameters

orderNumberstring required

The order number of the receipt to be redeemed.

Headers

Idempotency-Keystring required

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

Monime-Version'caph.2025-08-23' | 'caph.2025-06-20' nullable

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

Monime-Space-Idstring required

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

Request body

redeemAllboolean nullable

Whether to redeem all entitlements in the receipt.

metadataobject nullable

Optional metadata for attaching context or tracking info.

Response

OK

successboolean

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

Changes

No recorded changes to this operation across all 2 revisions of this API.