Skip to main content
PATCH
Update a product
Authenticate with an API key that belongs to the product’s organization and has Full access or the products:products:write permission (Products under Can create and change in the dashboard). Only the Owner and Admin roles can grant it.
  • id is the ID of a product in your organization, whether it was created through the API or in the dashboard.
  • The body takes name and description, both optional. Only the fields you send change.
  • The response has the same shape as Get a product.
  • Unknown fields are rejected with 400. There is no Idempotency-Key for this endpoint.
Card checkout shows the product’s name and description, so a change shows up at once on the checkout of every existing payment link. A payment link’s own title is shown on the success page after payment; to change it, use Update a payment link.

Authorizations

X-API-Key
string
header
required

Merchant API key (format: ak_BASE64)

Path Parameters

id
string
required

Product ID

Body

application/json

Fields to change

name
string

New product name

Maximum string length: 255
description
string

New product description

Maximum string length: 2000

Response

OK

data
object
error
object
message
string
success
boolean