Skip to main content
Een lidmaatschap is de actieve relatie tussen een gebruiker en een product. Het houdt toegang, factureringsstatus en verlengingsschema bij. Je maakt lidmaatschappen niet direct aan, want dat doet de checkout voor je. Zodra een lidmaatschap bestaat, kun je het uitlezen, de facturering pauzeren of opzeggen, gratis tijd geven of metadata bijwerken.
De meeste apps hoeven lidmaatschappen helemaal niet te beheren. Gebruik deze methoden wanneer je beheertools, klantenservice-flows of selfservicedashboards bouwt waarmee gebruikers kunnen pauzeren of opzeggen.

Levenscyclus in één oogopslag

Ophalen en weergeven

Pauzeren en hervatten

Pauzeren stopt de volgende factureringscyclus. De gebruiker behoudt de bestaande toegang tot de huidige periode afloopt, maar de verlenging wordt niet uitgevoerd. Geef until mee om een automatische hervatting in te plannen.

Opzeggen

Er zijn twee opzegmodi. cancel_at_period_end: true behoudt de toegang tot de huidige verlengingsdatum en deactiveert dan. Laat het weg (of geef false mee) om de toegang direct in te trekken.
cancel_at_period_end: true zet cancel_at_period_end op het lidmaatschap op true. De gebruiker behoudt de toegang tot de verlenging, waarna het lidmaatschap wordt gedeactiveerd en membership.updated wordt verstuurd met previous_attributes.status ingesteld op de status die het verliet. Als je het veld weglaat, wordt de toegang direct ingetrokken, dus stuur het expliciet mee wanneer je aan het einde van de periode wilt opzeggen.

Een opzegging herstellen

Als de gebruiker zich bedenkt voordat de periode afloopt, wis je de openstaande opzegging aan het einde van de periode met een update. Dit heeft geen effect als het lidmaatschap niet gepland stond om te worden opgezegd.

Gratis dagen toevoegen

Geef de gebruiker extra tijd op de huidige periode. De volgende verlengingsdatum schuift days dagen op. Handig bij storingen, als gebaar van de klantenservice of als beloning voor doorverwijzingen.
days accepteert 1 tot en met 1095 (3 jaar).

Metadata bijwerken

Werk willekeurige metadata of andere schrijfbare velden op het lidmaatschap bij.

Luisteren naar levenscyclusevents

Abonneer je via webhooks. Dit zijn de events die gedurende de levenscyclus worden verstuurd: Bij pause / resume / extend verandert de status van het lidmaatschap niet, dus wordt er geen activerings- of deactiveringsevent verstuurd. Als je wilt bevestigen dat de wijziging is gelukt, haal je het lidmaatschap na de aanroep op of poll je volgens je eigen schema.

Volgende stappen

Betalingen accepteren

Waar lidmaatschappen vandaan komen. Eenmalige en terugkerende checkouts.

Betaalmethoden opslaan

Opgeslagen kaarten voor toekomstige verlengingen en off-session facturering.

Luisteren naar webhooks

Reageer op activering, deactivering en het aan- of uitzetten van opzeggingen.

API-referentie voor lidmaatschappen

De volledige resource: velden, statussen en elk endpoint.