Skip to main content
PATCH
/
v1
/
purchases
/
{id}
/
revoke
Revoke
curl --request PATCH \
  --url https://{defaultHost}/v1/purchases/{id}/revoke \
  --header 'Authorization: Bearer <token>'
{
  "id": "8aa0d06d-1ab2-4b30-b560-3058240b1856",
  "object": "purchase",
  "live_mode": true,
  "quantity": 1,
  "revoked": true,
  "revoked_at": 1767909750,
  "revoke_at": null,
  "customer": "dd13b8ac-1f5a-4faa-857c-c899a2eda94e",
  "initial_order": "bca2d085-fb4e-4253-a471-c6ab4404ac3b",
  "license": null,
  "price": "148aba22-6363-4eaf-b253-554f44a0d8b6",
  "product": "bf7f38c5-fb34-4028-bd1a-55da7768d660",
  "subscription": null,
  "variant": null,
  "review": null,
  "created_at": 1767909750,
  "updated_at": 1767909750
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
revoke_at
integer | null

Time at which the purchase should be revoked.

​
live_mode
boolean

Set to true if this purchase is in live mode, and set to false if it is in test mode.

​
revoked
boolean

Whether or not this purchase is revoked.

​
revoked_at
integer | null

Time at which the purchase was revoked. Measured in seconds since the Unix epoch.

​
customer

Expandable – The associated customer ID.

​
initial_order

The first order that initiated this purchase.

Expandable – The associated order ID.

​
license

Expandable – The associated license ID.

​
license_key
string | null

License key for subscriptions

​
line_items

Expandable – Property not returned unless expanded.

​
price

Expandable – The associated price ID.

​
product

Expandable – The associated product ID.

​
subscription

Expandable – The associated subscription ID.

​
variant

Expandable – The associated variant ID.

​
review

Expandable – The associated review ID.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.