Skip to main content
Den tilhører en konto, kan begrænses til ét produkt og styrer, hvem der kan indløse den, hvor mange gange, indtil hvornår, og i hvor mange faktureringsperioder rabatten varer. Brug Promo Codes API’et til at oprette koder for en konto, vise og hente dem, deaktivere en kode for at sætte indløsninger på pause eller aktivere den igen og arkivere koder, du ikke længere tilbyder.

Endpoints

Attributter

string
påkrævet
Promo code-id med præfikset promo_.
object
påkrævet
Den konto, der ejer rabatkoden.

Egenskaber

string
påkrævet
Konto-id med præfikset biz_.
string
påkrævet
Kontoens visningsnavn.
object | null
påkrævet
Den affiliate, der krediteres for henvisninger, som bruger rabatkoden, eller null, når ingen affiliate er tilknyttet.

Egenskaber

string
påkrævet
Affiliate-id med præfikset aff_.
object
påkrævet
Den bruger, der er affiliaten.

Egenskaber

string
påkrævet
Affiliatens bruger-id med præfikset user_.
string | null
påkrævet
Affiliatens visningsnavn.
string
påkrævet
Affiliatens avatar-URL, inklusive den genererede reserve, når der ikke er angivet en avatar.
string | null
påkrævet
Affiliatens offentlige brugernavn.
number
påkrævet
Rabatbeløb. Procentrabatter angives som en decimalbrøk.
boolean
påkrævet
Om rabatkoden er begrænset til tidligere kunder, der er faldet fra.
string | null
påkrævet
Koden, der indtastes i checkout.
string
påkrævet
Hvornår rabatkoden blev oprettet, som et ISO 8601-tidsstempel.
string
påkrævet
Den valuta, der bruges til en rabat med fast beløb.Tilgængelige muligheder: 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
påkrævet
Hvor længe rabatten gælder.Tilgængelige muligheder: forever, once, repeating
boolean
påkrævet
Om rabatkoden kun gælder for eksisterende medlemskaber.
string | null
påkrævet
Hvornår rabatkoden udløber, som et ISO 8601-tidsstempel.
object
påkrævet
Brugerdefinerede nøgle-værdi-metadata gemt på rabatkoden.
boolean
påkrævet
Om rabatkoden er begrænset til nye kunder.
boolean
påkrævet
Om hver kunde kun må indløse rabatkoden én gang.
object | null
påkrævet
Det produkt, som rabatkoden er begrænset til, eller null, når den ikke er afgrænset til et produkt.

Egenskaber

string
påkrævet
Produkt-id med præfikset prod_.
string
påkrævet
Produktets visningsnavn.
integer | null
påkrævet
De faktureringsintervaller, som rabatten gælder for.
string
påkrævet
Om rabatten er procentbaseret eller et fast beløb.Tilgængelige muligheder: percentage, flat_amount
string
påkrævet
Rabatkodens livscyklusstatus.Tilgængelige muligheder: active, inactive, archived
integer
påkrævet
Maksimalt antal anvendelser, når beholdningen er begrænset.
boolean
påkrævet
Om rabatkoden ikke har nogen indløsningsgrænse.
string
påkrævet
Hvornår rabatkoden blev opdateret, som et ISO 8601-tidsstempel.
integer
påkrævet
Medlemskaber, der har brugt rabatkoden.
PromoCode