Skip to main content
Een promotiecode hoort bij een account, kan worden beperkt tot één product en bepaalt wie hem kan inwisselen, hoe vaak, tot wanneer en voor hoeveel factureringsperiodes de korting geldt. Gebruik de Promo Codes API om codes voor een account aan te maken, ze weer te geven en op te halen, een code te deactiveren om inwisselingen te pauzeren of weer te activeren, en codes te archiveren die je niet meer aanbiedt.

Endpoints

Attributen

string
vereist
Promotiecode-ID, met prefix promo_.
object
vereist
Account dat eigenaar is van de promotiecode.

Eigenschappen

string
vereist
Account-ID, met prefix biz_.
string
vereist
Weergavenaam van het account.
object | null
vereist
Affiliate die wordt gecrediteerd voor verwijzingen die de promotiecode gebruiken, of null als er geen affiliate is gekoppeld.

Eigenschappen

string
vereist
Affiliate-ID, met prefix aff_.
object
vereist
Gebruiker die de affiliate is.

Eigenschappen

string
vereist
Gebruikers-ID van de affiliate, met prefix user_.
string | null
vereist
Weergavenaam van de affiliate.
string
vereist
Avatar-URL van de affiliate, inclusief de gegenereerde fallback als er geen avatar is ingesteld.
string | null
vereist
Openbare gebruikersnaam van de affiliate.
number
vereist
Kortingsbedrag. Procentuele kortingen worden weergegeven als decimale breuk.
boolean
vereist
Of de promotiecode is beperkt tot vertrokken klanten.
string | null
vereist
Code die bij het afrekenen wordt ingevoerd.
string
vereist
Wanneer de promotiecode is aangemaakt, als ISO 8601-tijdstempel.
string
vereist
Valuta die wordt gebruikt voor een korting met een vast bedrag.Beschikbare opties: 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
vereist
Hoe lang de korting geldt.Beschikbare opties: forever, once, repeating
boolean
vereist
Of de promotiecode alleen geldt voor bestaande lidmaatschappen.
string | null
vereist
Wanneer de promotiecode verloopt, als ISO 8601-tijdstempel.
object
vereist
Aangepaste key-value-metadata die bij de promotiecode is opgeslagen.
boolean
vereist
Of de promotiecode is beperkt tot nieuwe klanten.
boolean
vereist
Of elke klant de promotiecode maar één keer mag inwisselen.
object | null
vereist
Product waartoe de promotiecode is beperkt, of null als hij niet aan een product is gebonden.

Eigenschappen

string
vereist
Product-ID, met prefix prod_.
string
vereist
Weergavenaam van het product.
integer | null
vereist
Factureringsintervallen waarop de korting van toepassing is.
string
vereist
Of de korting procentueel is of een vast bedrag.Beschikbare opties: percentage, flat_amount
string
vereist
Levenscyclusstatus van de promotiecode.Beschikbare opties: active, inactive, archived
integer
vereist
Maximaal aantal keren gebruik als de voorraad beperkt is.
boolean
vereist
Of de promotiecode geen limiet voor inwisselingen heeft.
string
vereist
Wanneer de promotiecode is bijgewerkt, als ISO 8601-tijdstempel.
integer
vereist
Lidmaatschappen die de promotiecode hebben gebruikt.
PromoCode