Skip to main content
Det registrerer, om de er tilmeldt eller har forladt kontoen, deres adgangsniveau, og hvornår de sidst åbnede kontoens indhold. Brug Members API til at liste og søge i en kontos medlemmer, hente et enkelt medlem og læse et medlems aktivitetslog. Medlemsrækker oprettes og vedligeholdes af medlemskabets livscyklus; for at give eller tilbagekalde adgang skal du i stedet arbejde med medlemskaber.
Erstatter Legacy-ressourcen Members. Eksisterende Legacy-integrationer fortsætter med at fungere; se API-versioner for stabilitetsaftalen.

Endpoints

Attributter

string
påkrævet
Medlems-ID med præfikset mber_.
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
påkrævet
Den konto, dette medlem tilhører, med præfikset biz_.
string
påkrævet
Hvornår medlemsposten blev oprettet, som et ISO 8601-tidsstempel.
string
påkrævet
Navnet, der skal vises for dette medlem: brugerens navn eller deres brugernavn, når de ikke har angivet et. Den købende virksomheds navn, når user er null.
object | null
påkrævet
Brugerens bruttoindkomst på tværs af Whop i USD, opdateret periodisk. null, når brugeren skjuler sin indtjening, eller køberen er en anden virksomhed.

Egenskaber

string
påkrævet
Bruttoindkomst i USD over de seneste 24 timer.
string
påkrævet
Bruttoindkomst i USD over de seneste 30 dage.
string
påkrævet
Bruttoindkomst i USD over de seneste 7 dage.
string
påkrævet
Samlet bruttoindkomst i USD gennem tiden.
string | null
påkrævet
Brugerens e-mailadresse. null uden member:email:read på kontoen, når køberen er en anden virksomhed, eller når brugeren ikke har nogen tildelt e-mail.
string
påkrævet
Hvornår medlemmet første gang blev tilknyttet kontoen, som et ISO 8601-tidsstempel.
string | null
påkrævet
Hvornår medlemmet sidst åbnede kontoens indhold, som et ISO 8601-tidsstempel. null, hvis de aldrig har gjort det.
message | null
påkrævet
Hvad der skete ved last_activity_at. object angiver, hvilken type aktivitet det er. null uden support_chat:read på kontoen, eller når last_activity_at er null.

Egenskaber

string
påkrævet
Beskedens ID.
object | null
påkrævet
Hvem der sendte beskeden: medlemmet eller en person i kontoens team. null, når afsenderens konto ikke længere eksisterer.

Egenskaber

string
påkrævet
Bruger-ID med præfikset user_.
string | null
påkrævet
Visningsnavn.
object
påkrævet
Avatar-wrapper. Dens url er altid til stede og er en genereret pladsholder, når brugeren ikke har angivet et billede.

Egenskaber

string
påkrævet
URL til avatarbillede. Altid til stede. Det er en genereret pladsholder, når brugeren ikke har angivet et billede.
string
påkrævet
Offentligt brugernavn.
string
påkrævet
Supportchatten, som beskeden blev sendt i.
string
påkrævet
Hvornår beskeden blev sendt, som et ISO 8601-tidsstempel.
string
påkrævet
Altid message.
string | null
påkrævet
Beskedteksten uden formatering. null, når beskeden ikke har nogen tekst, såsom en vedhæftning alene.
string | null
påkrævet
Hvornår medlemmet og kontoen sidst interagerede, som et ISO 8601-tidsstempel. For eksempel en besked i medlemmets supportchat.
object | null
påkrævet
Dine egne nøgle-værdi-data gemt på dette medlem. null, når der ikke er angivet nogen.
string | null
påkrævet
Medlemmets seneste livscyklustilstand på kontoen, afledt af deres medlemskaber, såsom paid_subscriber, canceling eller churned. null, indtil den beregnes første gang.Tilgængelige muligheder: canceling, churned, finished_split_pay, paused, paid_subscriber, paid_once, expiring, joined, left, trialing, pending_entry, renewing, past_due
string | null
påkrævet
Hvornår most_recent_action trådte i kraft, som et ISO 8601-tidsstempel. null, når most_recent_action er null.
string | null
påkrævet
Det navn, kontoen har givet denne kunde med PATCH /members/:id. Fakturaer viser det som kundenavnet på hver faktura for dette medlem i stedet for brugerens eget navn. null, når kontoen ikke har angivet et.
string | null
påkrævet
Medlemmets telefonnummer: det seneste nummer indsamlet (eller verificeret) ved checkout, ellers deres kontonummer, når de har delt et med denne sælger. null uden member:phone:read på kontoen, eller når der ikke er nogen af delene.
string
påkrævet
joined, mens medlemmet er en del af kontoen, left, efter de forlader den.Tilgængelige muligheder: joined, left
number
påkrævet
Medlemmets aktuelle tokensaldo for denne konto, beregnet ud fra tokentransaktioner.
string | null
påkrævet
unsubscribed, når medlemmet fravælger kontoens markedsføringskommunikation, null, mens de abonnerer. Kun medlemmet kan ændre det.Tilgængelige muligheder: unsubscribed
object
påkrævet
Hvor meget medlemmet har brugt på kontoens produkter, i USD.

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.
object | null
påkrævet
Brugeren bag dette medlem. null, når køberen er en anden virksomhed frem for en person.

Egenskaber

string
påkrævet
Bruger-ID med præfikset user_.
string | null
påkrævet
Brugerens by, afledt af deres IP-adresse. null, når den er ukendt, eller brugeren har slået placeringsdeling fra.
string | null
påkrævet
Brugerens land som en ISO 3166-1 alpha-2-kode, som US, afledt af deres IP-adresse. null, når det er ukendt, eller brugeren har slået placeringsdeling fra.
string | null
påkrævet
Visningsnavn.
object
påkrævet
Avatar-wrapper. Dens url er altid til stede og er en genereret pladsholder, når brugeren ikke har angivet et billede.

Egenskaber

string
påkrævet
URL til avatarbillede. Altid til stede. Det er en genereret pladsholder, når brugeren ikke har angivet et billede.
string | null
påkrævet
Brugerens stat- eller regionskode, som CA, afledt af deres IP-adresse. null, når den er ukendt, eller brugeren har slået placeringsdeling fra.
string
påkrævet
Offentligt brugernavn.
Member