Skip to main content
POST
Revoke buyer access
Revokes a buyer’s access. Download links stop working and the title leaves the buyer’s library. The optional reason is stored with the record. Revoking twice keeps the first reason and time. Granting the same access again reactivates the record. Requires the WRITE_INVENTORY scope.
These endpoints only work on a store whose type is digital. On any other store they return 403 with This is only available on digital stores. See Digital stores.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side , never send a shop id.

Path Parameters

id
string
required

The access record's ObjectId.

Body

application/json
reason
string

Why access was removed. Optional.

Maximum string length: 500

Response

Revoke buyer access: success.

status
integer
required
Example:

200

success
boolean
required
Example:

true

message
string
required
Example:

"Access revoked"

data
object
required

One buyer's access record. There is one record per buyer, product (or the all-access pass) and kind, so buying a pass again extends the same record.

Example: