Skip to main content
PATCH
cURL
Update a promo code’s billing interval, redemption limits, expiration, active status, or plan restrictions.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
predeterminado:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Parámetros de ruta

id
string
requerido

Cuerpo

application/json
billingInterval
enum<string> | null
Opciones disponibles:
weekly,
monthly,
quarterly,
yearly,
one_time
maxRedemptions
integer | null
Rango requerido: 0 < x <= 9007199254740991
expiresAt
string<date-time> | null
active
boolean
planIds
string<uuid>[]
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Respuesta

Success

id
string
requerido
code
string
requerido
offerId
string
requerido
billingInterval
enum<string> | null
requerido
Opciones disponibles:
weekly,
monthly,
quarterly,
yearly,
one_time
maxRedemptions
integer | null
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
expiresAt
string<date-time> | null
requerido
isActive
boolean
requerido
redemptionCount
integer
requerido
Rango requerido: -9007199254740991 <= x <= 9007199254740991
createdAt
string<date-time>
requerido
updatedAt
string<date-time>
requerido
object
string
requerido
Allowed value: "promo_code"
livemode
boolean
requerido