Skip to main content
POST
Archive a product
Authenticate with an API key that belongs to the product’s organization and has Full access or the products:products:write permission. Only the Owner and Admin roles can grant it.
  • Send no body.
  • Only a published product can be archived. All of its payment links stop accepting payments. Publishing it again brings back only one link, not all of them.
  • The response has the same shape as Get a product, with status set to ARCHIVED.
  • To start selling again, publish the product.
  • There is no Idempotency-Key for this endpoint.

Authorizations

X-API-Key
string
header
required

Merchant API key (format: ak_BASE64)

Path Parameters

id
string
required

Product ID

Response

OK

data
object
error
object
message
string
success
boolean