Skip to main content
Il appartient à un compte, peut être limité à un seul produit et définit qui peut l’utiliser, combien de fois, jusqu’à quand, et pendant combien de périodes de facturation la réduction s’applique. Utilisez l’API Promo Codes pour créer des codes pour un compte, les lister et les récupérer, désactiver un code pour suspendre son utilisation ou le réactiver, et archiver les codes que vous ne proposez plus.

Endpoints

Attributs

string
requis
ID du code promo, préfixé par promo_.
object
requis
Compte propriétaire du code promo.

Propriétés

string
requis
ID du compte, préfixé par biz_.
string
requis
Nom d’affichage du compte.
object | null
requis
Affilié crédité des parrainages qui utilisent le code promo, ou null si aucun affilié n’est associé.

Propriétés

string
requis
ID de l’affilié, préfixé par aff_.
object
requis
Utilisateur qui est l’affilié.

Propriétés

string
requis
ID utilisateur de l’affilié, préfixé par user_.
string | null
requis
Nom d’affichage de l’affilié.
string
requis
URL de l’avatar de l’affilié, y compris l’avatar de remplacement généré lorsqu’aucun avatar n’est défini.
string | null
requis
Nom d’utilisateur public de l’affilié.
number
requis
Montant de la réduction. Les réductions en pourcentage sont représentées sous forme de fraction décimale.
boolean
requis
Indique si le code promo est réservé aux clients perdus.
string | null
requis
Code saisi lors du paiement.
string
requis
Date de création du code promo, sous forme d’horodatage ISO 8601.
string
requis
Devise utilisée pour une réduction à montant fixe.Options disponibles : usd, sgd, inr, aud, brl, cad, dkk, eur, nok, gbp, sek, chf, hkd, huf, jpy, mxn, myr, pln, czk, nzd, aed, eth, ape, cop, ron, thb, bgn, idr, dop, php, try, krw, twd, vnd, pkr, clp, uyu, ars, zar, dzd, tnd, mad, kes, kwd, jod, all, xcd, amd, bsd, bhd, bob, bam, khr, crc, xof, egp, etb, gmd, ghs, gtq, gyd, ils, jmd, mop, mga, mur, mdl, mnt, nad, ngn, mkd, omr, pyg, pen, qar, rwf, sar, rsd, lkr, tzs, ttd, uzs, rub, btc, cny, usdt, kzt, awg, whop_usd, xau, hnl
string
requis
Durée d’application de la réduction.Options disponibles : forever, once, repeating
boolean
requis
Indique si le code promo s’applique uniquement aux abonnements existants.
string | null
requis
Date d’expiration du code promo, sous forme d’horodatage ISO 8601.
object
requis
Métadonnées clé-valeur personnalisées stockées sur le code promo.
boolean
requis
Indique si le code promo est réservé aux nouveaux clients.
boolean
requis
Indique si chaque client ne peut utiliser le code promo qu’une seule fois.
object | null
requis
Produit auquel le code promo est limité, ou null s’il n’est pas limité à un produit.

Propriétés

string
requis
ID du produit, préfixé par prod_.
string
requis
Nom d’affichage du produit.
integer | null
requis
Nombre d’intervalles de facturation auxquels la réduction s’applique.
string
requis
Indique si la réduction est un pourcentage ou un montant fixe.Options disponibles : percentage, flat_amount
string
requis
Statut du cycle de vie du code promo.Options disponibles : active, inactive, archived
integer
requis
Nombre maximal d’utilisations lorsque le stock est limité.
boolean
requis
Indique si le code promo n’a aucune limite d’utilisation.
string
requis
Date de mise à jour du code promo, sous forme d’horodatage ISO 8601.
integer
requis
Nombre d’abonnements ayant utilisé le code promo.
PromoCode