Cancel a purchase

Records that a purchase was cancelled in the external commerce system and queues
revocation of the user's access to the product.

The operation is idempotent. Cancelling a purchase that is already cancelled, or one
in any other state, is accepted and has no further effect.

Cancellation is asynchronous, so fulfillment_status in the response will usually not
yet read cancelled. Poll GET /commerce/purchases/{purchase_id} to confirm that it
completed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

One of the following:

  • The UUID uniquely associated with a purchase
  • |
    A pair consisting of an External ID Namespace and an External ID, separated by a : character.
    The Namespace component may not contain the characters : or /.
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*