Skip to main content
Het houdt de factureringsstatus bij (active, trialing, past_due, enzovoort), de huidige periode, openstaande annuleringen, aangepaste metadata en de softwarelicentiesleutel wanneer het product licenties bevat. Gebruik de Memberships API om de lidmaatschappen van een account of je eigen lidmaatschappen weer te geven, er een op te halen via ID of licentiesleutel, een ontvanger uit te nodigen om lid te worden via een gratis variant, en de levenscyclus te beheren: direct of aan het einde van de periode annuleren, een geplande annulering terugdraaien, het innen van betalingen pauzeren en hervatten, toegang verlengen of opnieuw activeren, een promotiecode of affiliate toepassen, de verlengingsfrequentie wijzigen, toegang opnieuw synchroniseren, een overdrachtslink genereren en metadata bijwerken.
Vervangt de Legacy-resource Memberships. Bestaande Legacy-integraties blijven werken; zie API-versies voor de stabiliteitsgarantie.

Endpoints

Attributen

string
vereist
Lidmaatschap-ID, met prefix mem_.
object
vereist
Het account (verkoper) waartoe dit lidmaatschap behoort.

Eigenschappen

string
vereist
Account-ID, met prefix biz_.
string | null
vereist
URL van de logoafbeelding van het account. null wanneer het account er geen heeft ingesteld.
string
vereist
Openbare route-identificatie van het account, gebruikt in het storefront-pad whop.com/\{route}.
string
vereist
Weergavenaam van het account.
object | null
vereist
De affiliatecommissie van het lidmaatschap. null zonder affiliate, zonder affiliate:basic:read op het account, en altijd in webhooks.

Eigenschappen

string
vereist
Affiliate-ID, met prefix aff_.
string
vereist
Of de commissie alleen over de eerste betaling van het lidmaatschap wordt uitbetaald of over al zijn betalingen.Beschikbare opties: first_payment, all_payments
object | null
vereist
De commissie als vast bedrag in de valuta van het lidmaatschap, of null bij een percentage.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. Bijvoorbeeld: "10.00" is tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Drieletterige ISO 4217-valutacode, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden GETOOND. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus is het 2 en 0. Maak het getal hiermee op in je eigen locale.
number | null
vereist
De procentuele commissie in procentpunten, dus 20 betekent 20%, of null bij een vast bedrag.
string
vereist
Hoe het commissietarief is vastgesteld: custom voor een tarief dat voor deze affiliate is ingesteld, member voor het affiliatetarief voor leden van het plan of product, global voor het wereldwijde affiliatetarief van het product, of marketplace voor een doorverwijzing via de Whop-marketplace.Beschikbare opties: custom, member, marketplace, global
string
vereist
Of de commissie een percentage of een vast bedrag is.Beschikbare opties: flat_fee, percentage
boolean
vereist
Of dit lidmaatschap affiliatecommissies uitbetaalt. false betekent dat de affiliate op het lidmaatschap blijft staan maar niet langer wordt betaald.
string
vereist
ID van de gebruiker van de affiliate, met prefix user_.
integer | null
vereist
Aantal dagen tussen terugkerende afschrijvingen. null voor niet-verlengende lidmaatschappen of lidmaatschappen met meerdere verlengingsschema’s.
boolean
vereist
Of het lidmaatschap is ingesteld om te worden geannuleerd wanneer de huidige factureringsperiode eindigt. Alleen relevant voor terugkerende varianten.
string | null
vereist
De categorie die het lid heeft gekozen als reden voor het annuleren. null wanneer er geen categorie is gekozen.Beschikbare opties: too_expensive, switching, missing_features, technical_issues, bad_experience, unused, other, testing
string | null
vereist
Wanneer de annulering is aangevraagd, of wanneer het lidmaatschap is geannuleerd als er geen aanvraagtijdstip is vastgelegd, als ISO 8601-tijdstempel. null wanneer geen van beide is vastgelegd.
string | null
vereist
Vrije toelichting die bij het annuleren is gegeven. null wanneer er geen reden is opgegeven.
string | null
vereist
Hoe verlengingen worden geïnd. charge_automatically schrijft elke periode af van de opgeslagen betaalmethode; send_invoice mailt de koper elke periode een factuur. null wanneer niet ingesteld.Beschikbare opties: charge_automatically, send_invoice
string
vereist
Wanneer het lidmaatschap is aangemaakt, als ISO 8601-tijdstempel.
string | null
vereist
Wanneer de huidige factureringsperiode wordt verlengd, of wanneer een niet-verlengend lidmaatschap verloopt, als ISO 8601-tijdstempel. null voor eenmalige aankopen zonder vervaldatum.
string | null
vereist
Wanneer de huidige factureringsperiode begon, als ISO 8601-tijdstempel. null wanneer er geen factureringsperiode is vastgelegd.
string | null
vereist
Wanneer de toegang eindigt voor een lidmaatschap met een vaste vervaldatum, als ISO 8601-tijdstempel. null wanneer het lidmaatschap geen vervaldatum heeft, zoals een verlengend lidmaatschap.
object[] | null
vereist
De accounts van het lid op externe platforms, zoals Discord en Telegram. Leeg wanneer het lid er geen heeft gekoppeld. null in webhooks.

Eigenschappen

string
vereist
De gebruikers-ID van het lid op het platform, zoals een Discord-gebruikers-ID. Met het platform als prefix (discord_\<external_id>) is het de external_account-waarde waarop List Memberships filtert.
string
vereist
Het platform waarop het account van het lid staat.Beschikbare opties: discord, telegram
string | null
vereist
De gebruikersnaam van het lid op het platform. null wanneer Whop deze niet kent, zoals bij een lidmaatschap dat is geïmporteerd met alleen een Discord-ID.
object | null
vereist
De eigen annuleringsreden van het account die het lid heeft gekozen, zoals het lid die zag. null wanneer het lid een standaardcategorie heeft gekozen of geen reden heeft opgegeven.

Eigenschappen

string
vereist
Het label van de optie op het moment dat het lid deze koos. Het later hernoemen van de optie verandert dit niet.
object
vereist
De huidige vooruitbetaalde prijs van de variant, in de valuta van de variant. Een catalogusprijs, niet noodzakelijk wat de koper heeft betaald. amount is "0.00" wanneer de eerste afschrijving gratis is.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. Bijvoorbeeld: "10.00" is tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Drieletterige ISO 4217-valutacode, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden GETOOND. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus is het 2 en 0. Maak het getal hiermee op in je eigen locale.
string | null
vereist
De softwarelicentiesleutel voor dit lidmaatschap. Alleen aanwezig wanneer het product een experience voor softwarelicenties bevat.
string | null
vereist
URL waar de koper kan inloggen om de facturering te beheren. null zonder ledenrecord of tenzij de aanroeper de koper is of member:manage op het account heeft.
object | null
vereist
De ledenrij van de aanroeper op het account. Alleen aanwezig wanneer het lidmaatschap van de aanroeper is; null bij leesbewerkingen aan de verkoperszijde.

Eigenschappen

string
vereist
Waartoe het lid toegang heeft op het account: customer voor betalende leden, admin voor teamleden, no_access zodra elke toekenning is verlopen.Beschikbare opties: no_access, admin, customer
string | null
vereist
Wanneer het lid voor het laatst de content van het account heeft geopend, als ISO 8601-tijdstempel. null als dat nooit is gebeurd.
number | null
vereist
De sorteerpositie van het lid in de eigen accountlijst van de koper. null totdat die deze ordent.
string | null
vereist
Het ledenrecord van de koper op het account, met prefix mber_. null wanneer het lidmaatschap geen ledenrecord heeft, zoals een niet-geclaimd lidmaatschap.
object
vereist
Aangepaste sleutel-waardeparen die op het lidmaatschap zijn opgeslagen, vaak gebruikt voor softwarelicenties.
string | null
vereist
De meest recente levenscyclusgebeurtenis van het lidmaatschap, zoals renewing_on of canceled_on. Combineer dit met most_recent_action_at. null wanneer er niets is vastgelegd.Beschikbare opties: canceled_on, finished_split_pay_at, canceling_on, ending_on, renewing_on, past_due, next_payment_attempt, paused_at, trial_ends_at, unresolved_at, trial_canceling_on
string | null
vereist
Wanneer most_recent_action plaatsvond of gepland staat, als ISO 8601-tijdstempel. Een toekomstig tijdstip voor aankomende gebeurtenissen zoals renewing_on. null wanneer er geen actie is vastgelegd.
string | null
vereist
Het telefoonnummer van de koper dat voor dit lidmaatschap is vastgelegd, of null. Het nummer dat bij de checkout is verzameld (of geverifieerd) wanneer telefoonverzameling van de verkoper is ingeschakeld; valt terug op het accountnummer van de koper als die het met deze verkoper heeft gedeeld.
object
vereist
Het product waartoe dit lidmaatschap toegang geeft.

Eigenschappen

string
vereist
Product-ID, met prefix prod_.
string | null
vereist
URL van de logoafbeelding van het product. null wanneer het product geen logo heeft.
string
vereist
Weergavenaam van het product.
string
vereist
Het product waartoe dit lidmaatschap toegang geeft, met prefix prod_.
string | null
vereist
De promotiecode die korting geeft op dit lidmaatschap, met prefix promo_. null wanneer er geen is toegepast. Ingesteld bij de checkout of via Apply Promo Code to Membership.
object | null
vereist
De verlengingsprijs van de variant, in de valuta van de variant, na een eventuele promotiecode die nog van toepassing is. Een lidmaatschap dat in de lokale valuta van de koper wordt gefactureerd, wordt op elke factuurdatum deze prijs omgerekend tegen de wisselkoers in rekening gebracht. null voor niet-verlengende lidmaatschappen.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. Bijvoorbeeld: "10.00" is tien dollar. Het is een string zodat geen enkele float het onderweg afrondt.
string
vereist
Drieletterige ISO 4217-valutacode, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de afschrijving zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen er moeten worden GETOOND. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt afgeschreven in centavos maar geschreven in hele peso’s, dus is het 2 en 0. Maak het getal hiermee op in je eigen locale.
integer | null
vereist
Betaalde termijnen die tot nu toe zijn geteld voor een lidmaatschap met gespreide betaling. null wanneer het lidmaatschap geen gespreide betaling heeft, of voordat de eerste termijn is geteld.
integer | null
vereist
Termijnbetalingen die nodig zijn voordat het lidmaatschap stopt met factureren. null wanneer het lidmaatschap geen gespreide betaling heeft.
string
vereist
Factureringsstatus van het lidmaatschap. active/trialing-lidmaatschappen geven toegang; past_due is de respijtperiode na een mislukte betaling; completed eenmalige aankopen behouden toegang; canceled/expired niet.Beschikbare opties: trialing, active, past_due, completed, canceled, expired, unresolved
string
vereist
Wanneer het lidmaatschap voor het laatst is gewijzigd, als ISO 8601-tijdstempel. Geeft de meest recente wijziging aan het lidmaatschap zelf weer, zodat je kunt afstemmen met webhook-herhalingen, replays en backfills.
string | null
vereist
De koper, met prefix user_. null wanneer de koper een ander bedrijf is of het lidmaatschap niet is geclaimd.
string
vereist
De variant die de koper heeft gekocht, met prefix plan_.
Membership