Skip to main content
PATCH
/
v1
/
purchases
/
{id}
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/purchases/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "purchase": {
    "revoke_at": "2026-01-09 22:02:30 UTC"
  }
}
'
{
  "id": "1b1d0bf7-5097-4bb1-a7f1-6de28a1b44be",
  "object": "purchase",
  "live_mode": true,
  "quantity": 1,
  "revoked": false,
  "revoked_at": null,
  "revoke_at": 1767996150,
  "customer": "195aaa79-168e-4383-94ea-ca0d32ba00e8",
  "initial_order": "4c62fd6c-21bc-4f17-a339-0a44dcd4b24b",
  "license": null,
  "price": "d91627d8-1600-4b71-adee-95960ec34d5e",
  "product": "bab3a17c-34b4-4d71-b556-599fca722dc3",
  "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

Body

application/json
​
purchase
object

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.