Skip to main content
Det registrerer faktureringstilstand (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

string
påkrævet
Medlemskabs-ID med præfikset mem_.
object
påkrævet
Kontoen (sælgeren), som dette medlemskab tilhører.

Egenskaber

string
påkrævet
Konto-ID med præfikset biz_.
string | null
påkrævet
URL til kontoens logobillede. null, når kontoen ikke har angivet et.
string
påkrævet
Kontoens offentlige rute-identifikator, der bruges i butiksstien whop.com/\{route}.
string
påkrævet
Kontoens visningsnavn.
object | null
påkrævet
Medlemskabets affiliatekommission. null uden en affiliate, uden affiliate:basic:read på kontoen og altid i webhooks.

Egenskaber

string
påkrævet
Affiliate-ID med præfikset aff_.
string
påkrævet
Om kommissionen kun udbetales på medlemskabets første betaling eller på alle dets betalinger.Tilgængelige muligheder: first_payment, all_payments
object | null
påkrævet
Den faste kommission i medlemskabets valuta, eller null for en procentsats.

Egenskaber

string
påkrævet
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.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, men bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Formatér tallet i din egen locale ved hjælp af dette.
number | null
påkrævet
Den procentvise kommission i procentpoint, så 20 betyder 20 %, eller null for et fast gebyr.
string
påkrævet
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, global
string
påkrævet
Om kommissionen er en procentsats eller et fast gebyr.Tilgængelige muligheder: flat_fee, percentage
boolean
påkrævet
Om dette medlemskab udbetaler affiliatekommissioner. false betyder, at affiliaten bevares på medlemskabet, men ikke længere bliver betalt.
string
påkrævet
ID for affiliatens bruger med præfikset user_.
integer | null
påkrævet
Antal dage mellem tilbagevendende opkrævninger. null for medlemskaber, der ikke fornyes, eller medlemskaber med flere fornyelsesplaner.
boolean
påkrævet
Om medlemskabet er indstillet til at blive opsagt, når den aktuelle faktureringsperiode slutter. Kun meningsfuldt for tilbagevendende varianter.
string | null
påkrævet
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, testing
string | null
påkrævet
Hvornå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.
string | null
påkrævet
Fritekstforklaring angivet ved opsigelse. null, når der ikke blev angivet en årsag.
string | null
påkrævet
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_invoice
string
påkrævet
Hvornår medlemskabet blev oprettet, som et ISO 8601-tidsstempel.
string | null
påkrævet
Hvornå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.
string | null
påkrævet
Hvornår den aktuelle faktureringsperiode startede, som et ISO 8601-tidsstempel. null, når der ikke er registreret en faktureringsperiode.
string | null
påkrævet
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.
object[] | null
påkrævet
Medlemmets konti på eksterne platforme, såsom Discord og Telegram. Tom, når medlemmet ikke har nogen tilknyttet. null i webhooks.

Egenskaber

string
påkrævet
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.
string
påkrævet
Platformen, som medlemmets konto er på.Tilgængelige muligheder: discord, telegram
string | null
påkrævet
Medlemmets brugernavn på platformen. null, når Whop ikke kender det, såsom for et medlemskab importeret med kun et Discord-ID.
object | null
påkrævet
Kontoens egen opsigelsesårsag, som medlemmet valgte, sådan som de så den. null, når medlemmet valgte en standardkategori eller ikke angav nogen årsag.

Egenskaber

string
påkrævet
Valgmulighedens etiket, da medlemmet valgte den. En senere omdøbning af valgmuligheden ændrer den ikke.
object
påkrævet
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

string
påkrævet
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.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, men bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Formatér tallet i din egen locale ved hjælp af dette.
string | null
påkrævet
Softwarelicensnøglen for dette medlemskab. Kun til stede, når produktet inkluderer en softwarelicensoplevelse.
string | null
påkrævet
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.
object | null
påkrævet
Kalderens medlemsrække på kontoen. Kun til stede, når medlemskabet tilhører kalderen; null ved læsninger fra sælgersiden.

Egenskaber

string
påkrævet
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, customer
string | null
påkrævet
Hvornår medlemmet sidst åbnede kontoens indhold, som et ISO 8601-tidsstempel. null, hvis de aldrig har gjort det.
number | null
påkrævet
Medlemmets sorteringsposition i køberens egen kontoliste. null, indtil de arrangerer den.
string | null
påkrævet
Køberens medlemspost på kontoen med præfikset mber_. null, når medlemskabet ikke har nogen medlemspost, såsom et uindløst medlemskab.
object
påkrævet
Tilpassede nøgle-værdi-par gemt på medlemskabet, ofte brugt til softwarelicensering.
string | null
påkrævet
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_on
string | null
påkrævet
Hvornå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.
string | null
påkrævet
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.
object
påkrævet
Produktet, som dette medlemskab giver adgang til.

Egenskaber

string
påkrævet
Produkt-ID med præfikset prod_.
string | null
påkrævet
URL til produktets logobillede. null, når produktet ikke har noget logo.
string
påkrævet
Produktets visningsnavn.
string
påkrævet
Produktet, som dette medlemskab giver adgang til, med præfikset prod_.
string | null
påkrævet
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.
object | null
påkrævet
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

string
påkrævet
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.
string
påkrævet
Trebogstavs ISO 4217-valutakode med små bogstaver.
integer
påkrævet
Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
integer
påkrævet
Hvor mange decimaler der skal VISES. Normalt lig med decimals, men bevidst ikke altid: COP opkræves i centavos, men skrives i hele pesos, så det er 2 og 0. Formatér tallet i din egen locale ved hjælp af dette.
integer | null
påkrævet
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.
integer | null
påkrævet
Ratebetalinger, der kræves, før medlemskabet stopper faktureringen. null, når medlemskabet ikke har opdelt betaling.
string
påkrævet
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, unresolved
string
påkrævet
Hvornå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.
string | null
påkrævet
Køberen med præfikset user_. null, når køberen er en anden virksomhed, eller medlemskabet ikke er indløst.
string
påkrævet
Den variant, køberen købte, med præfikset plan_.
Membership