active, trialing, past_due osv.), den aktuelle periode, afventende opsigelser, tilpassede metadata og softwarelicensnøglen, når produktet inkluderer licensering.
Brug Memberships API til at liste en kontos medlemskaber eller dine egne, hente et ud fra ID eller licensnøgle, invitere en modtager til at blive medlem via en gratis variant og administrere livscyklussen: opsige straks eller ved periodens udløb, tilbageføre en planlagt opsigelse, sætte betalingsopkrævning på pause og genoptage den, forlænge eller genaktivere adgang, anvende en rabatkode eller affiliate, ændre fornyelseskadence, synkronisere adgang igen, generere et overførselslink og opdatere metadata.
Erstatter Legacy-ressourcen Memberships. Eksisterende Legacy-integrationer fortsætter med at fungere; se API-versioner for stabilitetsaftalen.
Endpoints
Attributter
Kontoen (sælgeren), som dette medlemskab tilhører.
Medlemskabets affiliatekommission.
null uden en affiliate, uden affiliate:basic:read på kontoen og altid i webhooks.Egenskaber
Egenskaber
Om kommissionen kun udbetales på medlemskabets første betaling eller på alle dets betalinger.Tilgængelige muligheder:
first_payment, all_paymentsDen faste kommission i medlemskabets valuta, eller
null for en procentsats.Egenskaber
Egenskaber
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det under overførslen.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Den procentvise kommission i procentpoint, så
20 betyder 20 %, eller null for et fast gebyr.Hvordan kommissionssatsen blev fastsat:
custom for en sats fastsat for denne affiliate, member for planens eller produktets medlemsaffiliatesats, global for produktets globale affiliatesats, eller marketplace for en henvisning fra Whop-marketplacet.Tilgængelige muligheder: custom, member, marketplace, globalOm kommissionen er en procentsats eller et fast gebyr.Tilgængelige muligheder:
flat_fee, percentageOm dette medlemskab udbetaler affiliatekommissioner.
false betyder, at affiliaten bevares på medlemskabet, men ikke længere bliver betalt.Antal dage mellem tilbagevendende opkrævninger.
null for medlemskaber, der ikke fornyes, eller medlemskaber med flere fornyelsesplaner.Om medlemskabet er indstillet til at blive opsagt, når den aktuelle faktureringsperiode slutter. Kun meningsfuldt for tilbagevendende varianter.
Den kategori, medlemmet valgte som årsag til opsigelsen.
null, når der ikke blev valgt en kategori.Tilgængelige muligheder: too_expensive, switching, missing_features, technical_issues, bad_experience, unused, other, testingHvornår opsigelsen blev anmodet om, eller hvornår medlemskabet blev opsagt, hvis der ikke er registreret et anmodningstidspunkt, som et ISO 8601-tidsstempel.
null, når ingen af delene er registreret.Fritekstforklaring angivet ved opsigelse.
null, når der ikke blev angivet en årsag.Hvordan fornyelser opkræves.
charge_automatically opkræver den gemte betalingsmetode hver periode; send_invoice e-mailer køberen en faktura hver periode. null, når den ikke er angivet.Tilgængelige muligheder: charge_automatically, send_invoiceHvornår den aktuelle faktureringsperiode fornyes, eller hvornår et medlemskab uden fornyelse udløber, som et ISO 8601-tidsstempel.
null for engangskøb uden udløb.Hvornår den aktuelle faktureringsperiode startede, som et ISO 8601-tidsstempel.
null, når der ikke er registreret en faktureringsperiode.Hvornår adgangen slutter for et medlemskab med en fast udløbsdato, som et ISO 8601-tidsstempel.
null, når medlemskabet ikke har noget udløb, såsom et medlemskab, der fornyes.Medlemmets konti på eksterne platforme, såsom Discord og Telegram. Tom, når medlemmet ikke har nogen tilknyttet.
null i webhooks.Egenskaber
Egenskaber
Medlemmets bruger-ID på platformen, såsom et Discord-bruger-ID. Med platformen som præfiks (
discord_\<external_id>) er det den external_account-værdi, som List Memberships filtrerer efter.Variantens aktuelle forudbetalte pris i variantens valuta. En listepris, ikke nødvendigvis hvad køberen betalte.
amount er "0.00", når den første opkrævning er gratis.Egenskaber
Egenskaber
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det under overførslen.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Softwarelicensnøglen for dette medlemskab. Kun til stede, når produktet inkluderer en softwarelicensoplevelse.
URL, hvor køberen kan logge ind for at administrere fakturering.
null uden en medlemspost, eller medmindre kalderen er køberen eller har member:manage på kontoen.Kalderens medlemsrække på kontoen. Kun til stede, når medlemskabet tilhører kalderen;
null ved læsninger fra sælgersiden.Egenskaber
Egenskaber
Hvad medlemmet har adgang til på kontoen:
customer for betalende medlemmer, admin for teammedlemmer, no_access når alle tildelinger er udløbet.Tilgængelige muligheder: no_access, admin, customerHvornår medlemmet sidst åbnede kontoens indhold, som et ISO 8601-tidsstempel.
null, hvis de aldrig har gjort det.Køberens medlemspost på kontoen med præfikset
mber_. null, når medlemskabet ikke har nogen medlemspost, såsom et uindløst medlemskab.Medlemskabets seneste livscyklushændelse, såsom
renewing_on eller canceled_on. Brug den sammen med most_recent_action_at. null, når der ikke er registreret nogen.Tilgængelige muligheder: 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_onHvornår
most_recent_action skete eller er planlagt til at ske, som et ISO 8601-tidsstempel. Et fremtidigt tidspunkt for kommende hændelser såsom renewing_on. null, når der ikke er registreret nogen handling.Køberens telefonnummer registreret for dette medlemskab, eller
null. Det nummer, der blev indsamlet (eller verificeret) ved checkout, når sælgerens telefonindsamling er slået til; falder tilbage til køberens kontonummer, når de har delt et med denne sælger.Rabatkoden, der giver rabat på dette medlemskab, med præfikset
promo_. null, når der ikke er anvendt nogen. Angives ved checkout eller af Apply Promo Code to Membership.Variantens fornyelsespris i variantens valuta efter en eventuel rabatkode, der stadig gælder. Et medlemskab, der faktureres i køberens lokale valuta, opkræves denne pris omregnet til vekselkursen på hver faktureringsdato.
null for medlemskaber, der ikke fornyes.Egenskaber
Egenskaber
Beløbet i hovedenheder som en eksakt decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det under overførslen.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Betalte rater, der indtil videre er talt med på et medlemskab med opdelt betaling.
null, når medlemskabet ikke har opdelt betaling, eller før dets første rate er talt med.Ratebetalinger, der kræves, før medlemskabet stopper faktureringen.
null, når medlemskabet ikke har opdelt betaling.Medlemskabets faktureringstilstand. Medlemskaber med
active/trialing giver adgang; past_due er henstandsperioden efter en mislykket betaling; engangskøb med completed beholder adgangen; canceled/expired gør ikke.Tilgængelige muligheder: trialing, active, past_due, completed, canceled, expired, unresolvedHvornår medlemskabet sidst blev ændret, som et ISO 8601-tidsstempel. Afspejler den seneste ændring af selve medlemskabet, så du kan afstemme mod webhook-genforsøg, genafspilninger og backfills.
Køberen med præfikset
user_. null, når køberen er en anden virksomhed, eller medlemskabet ikke er indløst.Membership

