Skip to main content
PATCH
Update a product

Authorizations

Authorization
string
header
required

OAuth 2.1 access token.

Path Parameters

id
string<uuid>
required

UUID of the resource.

Body

application/json

All fields are optional. Only fields included in the body are modified.

name
string

New product name.

Required string length: 1 - 80
Example:

"Enterprise Plan v2"

currency
enum<string>

ISO 4217 currency code supported by Vendaze.

Available options:
AED,
ARS,
AUD,
BRL,
CAD,
CHF,
CLP,
CNY,
COP,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
JPY,
KWD,
MAD,
MXN,
MYR,
NGN,
NOK,
NZD,
PEN,
QAR,
SAR,
SEK,
SGD,
TRY,
USD,
UYU,
ZAR
Example:

"USD"

price_cts
integer

New price in the smallest currency unit.

Required range: 0 <= x <= 1000000000000000
Example:

149900

description
string | null

New description. Send null to clear.

Maximum string length: 1000
Example:

"Updated plan for enterprise customers."

code
string | null

New product code. Send null to clear.

Maximum string length: 60
Example:

"PLAN-ENT-V2"

is_active
boolean

Update active status.

Example:

false

billing_cycle
enum<string>

New billing cycle.

Available options:
one_time,
monthly,
quarterly,
annually
Example:

"annually"

image
string

New product image. Replaces the existing one.

Example:

"https://example.com/new-product.png"

Response

Product updated successfully.

data
object