Skip to main content
Brug konti til kunder, skabere, forhandlere, sælgere eller tilknyttede virksomheder, som din integration understøtter. Brug Accounts API til at oprette konti, liste konti, der er synlige for dine legitimationsoplysninger, hente eller opdatere en konto, suspendere eller slette en underkonto, som din platform administrerer, og hente den konto, der er knyttet til den aktuelle API-nøgle. Felterne business_type, industry_group og industry_type klassificerer konti. Se ordlisten over virksomhedstyper og brancher for alle gyldige værdier.

Endpoints

Gebyrtillæg

Gebyrtillæg lader en platform tilføje gebyrer eller subsidiere udbetalingsgebyrer for sine underkonti. Administrer dem gennem kontoens gebyrdokument: angiv standarder på platformskontoen, eller tilsidesæt individuelle gebyrer på en underkonto. Se Gebyrtillæg og subsidier for eksempler, grænser og krav til finansiering.

Gebyr-endpoints

Brug platformskontoens API-nøgle med tilladelsen company:update_child_fees til at konfigurere tillæg. Hvert returneret tillæg inkluderer adjustable og unadjustable_reason, så din integration kan afgøre, om redigering er mulig.

Læs gebyrer

Sektionen markups indeholder underkontoens gældende satser. Sektionen child_markups på en platformskonto indeholder dens standarder for underkonti. Et tillægs source er custom, når det er konfigureret på det niveau, eller default, når det falder tilbage til en nedarvet sats eller nul. Dets default-felt viser den sats, der ville gælde, hvis det tilpassede tillæg blev ryddet. Returnerede faste beløb bruger Money-objektet; opdateringer accepterer fixed som et tal i amerikanske dollars.

Angiv platformsstandarder

Opdater child_markups på platformskontoen. Dette eksempel angiver et betalingstillæg på 2 % uden fast gebyr:
percentage: 2 betyder 2 %. Standarder gælder for underkonti uden en tilsidesættelse for det pågældende gebyr. Betalingstillæg gælder, når der ikke er angivet et checkout-applikationsgebyr.

Angiv en tilsidesættelse for en underkonto

Opdater markups på underkontoen. Dette eksempel erstatter dens nedarvede betalingstillæg med 1 % plus $0.25:
Kun de nøgler, du sender, ændres. For andre transaktionstyper skal du bruge transfers, crypto_swaps, deposits opdelt efter rail eller payouts opdelt efter udbetalingsmetode. Se opdaterings-endpointet for de understøttede nøgler og request-skemaet.

Ryd et tillæg

Send null for tillægget for at rydde det. Rydning af en underkontos tilsidesættelse gendanner platformens standard eller nul, hvis der ikke er konfigureret nogen standard:
For at rydde en platformsstandard skal du sende child_markups: { payments: null } til platformskontoen. Et eksplicit { percentage: 0, fixed: 0 } forbliver en konfigureret sats; brug null for at gendanne nedarvning. En konto udgiver sine juridiske dokumenter som PDF-filer: terms_of_service, privacy_policy, return_policy, cancellation_policy, shipping_policy og eula. Hver læses tilbage som en File og angives via Update Account med id for en fil, du har uploadet. Nye tvister henter som standard deres politikbevis fra disse dokumenter. Pladsen til annulleringspolitik tager cancellation_policy, derefter terms_of_service og derefter return_policy. Pladsen til refusionspolitik tager return_policy og derefter terms_of_service. Begge pladser falder tilbage til Whops platformspolitik, når ingen er angivet, og shipping_policy følger med ved tvister om fysiske varer. Angiv dem én gang her, og brug kun Upload Dispute Evidence, når én tvist kræver en anden version af en politik.
Send null for et dokument for at fjerne det. Kun PDF-filer accepteres.

Attributter

string
påkrævet
Konto-ID med præfikset biz_.
number | null
påkrævet
Samlet opkrævet annonceforbrug for kontoen i hele dens levetid, i USD. Beregnes kun ved list for kaldere med stats:read på kontoen; ellers null.
object[]
påkrævet
Kontoens beholdninger, hver med USD-værdi. Tom, når total_usd er null.

Egenskaber

string
påkrævet
Samlet beholdt beløb i native enheder som en decimalstreng.
object
påkrævet
Saldo opdelt i tilgængelige, afventende og reserverede beløb som decimalstrenge i native enheder, med de dage, hvor det afventende beløb forventes at blive afregnet.

Egenskaber

string
påkrævet
Beløb, du kan bruge, sende eller hæve nu, i native enheder som en decimalstreng.
string
påkrævet
Den del af pending, der allerede er afregnet og venter på at blive flyttet til kontoens kryptowallet eller Whop Card, hvor det bliver available. Flytningen starter normalt inden for en time; mens den kører, rapporteres beløbet i stedet i in_transit. Penge, der kun flyttes for at fylde kontoens fastholdte minimumssaldo op, er ikke inkluderet. I native enheder som en decimalstreng.
string
påkrævet
Beløb, der flyttes mellem kontoens egne destinationer, såsom en kortopfyldning. I native enheder som en decimalstreng.
string
påkrævet
Beløb fra nylige betalinger, der stadig afregnes, i native enheder som en decimalstreng.
object[]
påkrævet
Hvornår det afventende beløb forventes at blive afregnet, én post pr. dag, tidligste først. Penge uden en planlagt afregningsdag, inklusive finishing_settlement, udelades, så disse poster plus finishing_settlement kan summere til mindre end pending, aldrig mere.

Egenskaber

string
påkrævet
Beløb forventet den dag, i native enheder som en decimalstreng.
string
påkrævet
Den dag, hvor disse penge forventes at være færdigafregnet, som en ISO 8601-dato.
string
påkrævet
Tilbageholdt beløb i native enheder som en decimalstreng. Hent kontoens reserver for at se, hvorfor det holdes tilbage, og hvornår det frigives.
string | null
påkrævet
URL til beholdningens ikon.
string
påkrævet
Beholdningens visningsnavn
number | null
påkrævet
USD-pris pr. enhed, eller null, når ingen vekselkurs er tilgængelig.
string
påkrævet
Beholdningens visningssymbol, såsom USDT, cbBTC eller EUR.
string | null
påkrævet
Beholdningens USD-værdi, eller null, når ingen vekselkurs er tilgængelig.
string | null
påkrævet
URL til kontoens bannerbillede.
object | null
påkrævet
Kontoens virksomhedsadresse, der bruges til at beregne skat, med line1, line2, city, state, postal_code og country. null, når ingen adresse er angivet.
string | null
påkrævet
Kontoens juridiske virksomhedsnavn, der bruges sammen med dens skatteadresse.
string | null
påkrævet
Overordnet virksomhedskategori for kontoen. Se ordlisten over virksomhedstyper og brancher for gyldige værdier.
boolean
påkrævet
Om afventende midler må overføres fra denne platformskonto til dens underkonti.
object | null
påkrævet
Kontoens dokument med annulleringspolitik, eller null, hvis den ikke har udgivet et.

Egenskaber

string
påkrævet
Filens ID med præfikset file_.
string | null
påkrævet
BlurHash-pladsholder for et billede eller en video. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Den originale fils MIME-type, for eksempel application/pdf. Den bevares, når moderation fjerner filen.
string
påkrævet
Hvornår filen blev oprettet, som et ISO 8601-tidsstempel.
number | null
påkrævet
Lyd- eller videovarighed i sekunder. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Det originale filnavn inklusive filtypenavnet.
integer | null
påkrævet
Billed- eller videohøjde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
Den bytestørrelse, hver del (undtagen den sidste) skal have. Kun til stede ved oprettelse og kun for multipart-uploads.
string | null
ID’et for multipart-uploaden, som sendes tilbage til complete. Kun til stede ved oprettelse og kun for multipart-uploads.
object[] | null
Den forudsignerede URL for hver del. Kun til stede ved oprettelse og kun for multipart-uploads.

Egenskaber

integer
påkrævet
Det 1-baserede indeks for denne del i multipart-uploaden.
string
påkrævet
Den forudsignerede URL, som denne dels bytes skal sendes til med PUT.
string
påkrævet
Typen af dette objekt, altid file.
boolean
påkrævet
Om moderation har fjernet filen. Når true, serverer url et erstatningsbillede. filename, size og content_type beskriver stadig den originale fil.
integer | null
påkrævet
Filstørrelsen i bytes. null, indtil uploaden er færdig.
object
Headers, der skal sendes med upload-PUT’en. Kun til stede ved oprettelse.
string
påkrævet
Hvor filen er i sin upload-livscyklus.Tilgængelige muligheder: pending, processing, ready, failed
string | null
Forudsigneret URL, som filens bytes skal sendes til med PUT. Kun til stede ved oprettelse og kun for single-part-uploads.
string | null
påkrævet
En URL til at downloade filen. Offentlige filer får en permanent CDN-URL, og private filer får en signeret URL, der udløber. null, indtil uploaden er færdig. Når moderation fjerner filen, en URL til et erstatningsbillede.
string
påkrævet
public-filer serveres fra en usigneret CDN-URL. private-filer serveres fra en signeret URL, der udløber.Tilgængelige muligheder: public, private
string | null
påkrævet
URL til lydens bølgeform. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
påkrævet
Billed- eller videobredde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
object | null
påkrævet
Betalingsrails, der er aktiveret for denne konto, hver active, inactive eller pending (onboarding eller gennemgang i gang). Beregnes kun ved retrieve og me for kaldere med scopet company:balance:read; ellers null.

Egenskaber

string
påkrævet
Bankindbetalinger: debiteringer, overførsler og lokale bankrailsTilgængelige muligheder: active, inactive, pending
string
påkrævet
Køb-nu-betal-senere-indbetalinger; kræver godkendelseTilgængelige muligheder: active, inactive, pending
string
påkrævet
Kortindbetalinger, inklusive Apple Pay og Google PayTilgængelige muligheder: active, inactive, pending
string
påkrævet
Indbetalinger via bankoverførsel eller ACH til kontoens virtuelle bankkontoTilgængelige muligheder: active, inactive, pending
string
påkrævet
Saldoopfyldninger ved at debitere en gemt betalingsmetodeTilgængelige muligheder: active, inactive, pending
string
påkrævet
Udstedelse af Whop-kort; kræver godkendelse af kortansøgningTilgængelige muligheder: active, inactive, pending
string
påkrævet
On-chain-indbetalinger til kontoens kryptowalletTilgængelige muligheder: active, inactive, pending
string
påkrævet
On-chain-udbetalinger til en kryptowalletTilgængelige muligheder: active, inactive, pending
string
påkrævet
Øjeblikkelige udbetalinger til en kvalificeret udbetalingsdestinationTilgængelige muligheder: active, inactive, pending
string
påkrævet
Lancering af annoncekampagner via Whop Ads. inactive, indtil kontoens identitet eller virksomhed er verificeret, mens en anmodet aftale om annoncetjenester afventer kontoens underskrift, og mens kontoen er suspenderet fra Whop Ads.Tilgængelige muligheder: active, inactive, pending
string
påkrævet
Standardudbetalinger til en ekstern udbetalingsdestinationTilgængelige muligheder: active, inactive, pending
string
påkrævet
Overførsler til andre kontiTilgængelige muligheder: active, inactive, pending
object | null
påkrævet
Detaljer om kontoens ansøgning om Whop Cards. Returneres ved list, retrieve og me for kaldere med scopet company:balance:read; ellers null, eller når kontoen ikke har nogen kortansøgning eller blokerende ansøgningsgennemgang.

Egenskaber

string | null
påkrævet
Årsag til, at kortudstederen afviste ansøgningen. unsupported_state erstatter unsupported_region for en verificeret person eller virksomhed i USA. compliance dækker sanktioner, politisk eksponerede personer og kontrol af negativ mediedækning. other dækker årsager, der ikke er på denne liste. null, når status ikke er denied, eller når udstederen ikke afviste ansøgningen.Tilgængelige muligheder: compromised_identity, duplicate, unsupported_region, compliance, fraud, verification_failed, unsupported_state, other
string | null
påkrævet
Om kortansøgningen verificerer en virksomhed (business, KYB) eller en person (individual, forbrugeridentitet). null, når ansøgningen endnu ikke er knyttet til en verifikation.Tilgængelige muligheder: individual, business
string
påkrævet
Hvor kortansøgningen står. approved betyder, at kort kan udstedes. needs_verification betyder, at ansøgeren endnu ikke har gennemført identitetsverifikation; needs_information betyder, at de har, men dokumenterne blev afvist af en årsag, der kan rettes, og skal indsendes igen. pending og manual_review er i gang. denied, locked og canceled er endelige.Tilgængelige muligheder: approved, pending, manual_review, denied, locked, canceled, needs_verification, needs_information
boolean
påkrævet
Om checkout viser et felt til moms-/skatte-ID, som købere valgfrit kan udfylde. Kræver ikke et moms-ID for at købe.
object
påkrævet
Kontoens status for virksomhedsstiftelse, administreret via Form Company. En draft status, indtil stiftelses-checkouten er betalt, derefter registreringsforløb med dokumenter, der kan downloades, og underskrifter, der afventer handling. Tom, når stiftelsesstatussen midlertidigt ikke er tilgængelig.

Egenskaber

object[]
Stiftelsesdokumenter, der kan downloades, såsom Articles of Organization og EIN-bekræftelsesbrevet. Til stede, når status forlader draft.

Egenskaber

string
påkrævet
Dokument-ID med præfikset file_.
string
påkrævet
Læsbart dokumentnavn, såsom Articles of Organization.
string
påkrævet
Dokumentkategori: articles_of_organization, operating_agreement, ein_letter, signed_ss4, signed_form8821 eller mail for postkorrespondance modtaget på virksomhedens vegne.
string
påkrævet
CDN-URL til download af dokumentet.
boolean
Om virksomhedens EIN er blevet udstedt af IRS. Til stede, når status forlader draft.
Registreret virksomhedsnavn inklusive selskabsformens endelse, for eksempel Acme, LLC. Til stede, når status forlader draft.
object
IRS-formularer, der stadig afventer en stifters underskrift, hver med en hostet underskrifts-URL. Til stede, når status forlader draft; tom, når intet skal underskrives.

Egenskaber

object
Underskriftsstatus for IRS Form 8821, fuldmagten til skatteoplysninger. Kun til stede, mens formularen stadig kræver stifterens handling.

Egenskaber

string
Hvornår underskrifts-URL’en udløber, som et ISO 8601-tidsstempel. Kun til stede, når underskrifts-URL’en er inkluderet.
string
påkrævet
pending, når en underskriftssession er klar til stifteren; unknown, når underskriftsstatussen ikke kunne fastslås.Tilgængelige muligheder: pending, unknown
string
Hostet underskrifts-URL, hvor stifteren udfylder formularen. Til stede, mens status er pending, og kalderen har incorporation:write. Udeladt fra webhooks.
object
Underskriftsstatus for IRS Form SS-4, EIN-ansøgningen. Kun til stede, mens formularen stadig kræver stifterens handling.

Egenskaber

string
Hvornår underskrifts-URL’en udløber, som et ISO 8601-tidsstempel. Kun til stede, når underskrifts-URL’en er inkluderet.
string
påkrævet
pending, når en underskriftssession er klar til stifteren; unknown, når underskriftsstatussen ikke kunne fastslås.Tilgængelige muligheder: pending, unknown
string
Hostet underskrifts-URL, hvor stifteren udfylder formularen. Til stede, mens status er pending, og kalderen har incorporation:write. Udeladt fra webhooks.
boolean
Om registreringen af stiftelsen i delstaten er fuldført. Til stede, når status forlader draft.
string
Tilgængelige muligheder: draft, processing, filed, rejected, completed
string | null
påkrævet
Land, hvor kontoen er placeret.
string
påkrævet
Hvornår kontoen blev oprettet, som et ISO 8601-tidsstempel.
integer | null
påkrævet
Unikke kunder med en betalt kvittering hos kontoen inden for de sidste 30 dage, opdateret med få timers mellemrum. Beregnes kun ved retrieve for kaldere med stats:read på kontoen; ellers null, og når antallet ikke er tilgængeligt.
string | null
påkrævet
Kontoens salgsfremmende beskrivelse.
integer
Hvor mange teammedlemmer der rapporterer direkte til virksomheden uden en leder over sig. Til stede ved læsning af en enkelt konto.
boolean
påkrævet
Om Whop samler og indsender tvistbeviser for denne konto. Aktivering tilmelder kontoen det succesgebyr, der opkræves for tvister, den vinder.
boolean
påkrævet
Om Economic Intelligence er slået til for kontoen. Den slås automatisk fra, når dens bindingsperiode slutter. Mens den er slået fra, kan kontoen ikke aktivere et eksperiment eller køre en anbefaling.
string | null
påkrævet
Kontoejerens e-mailadresse.
object | null
påkrævet
Kontoens dokument med slutbrugerlicensaftale, eller null, hvis den ikke har udgivet et.

Egenskaber

string
påkrævet
Filens ID med præfikset file_.
string | null
påkrævet
BlurHash-pladsholder for et billede eller en video. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Den originale fils MIME-type, for eksempel application/pdf. Den bevares, når moderation fjerner filen.
string
påkrævet
Hvornår filen blev oprettet, som et ISO 8601-tidsstempel.
number | null
påkrævet
Lyd- eller videovarighed i sekunder. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Det originale filnavn inklusive filtypenavnet.
integer | null
påkrævet
Billed- eller videohøjde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
Den bytestørrelse, hver del (undtagen den sidste) skal have. Kun til stede ved oprettelse og kun for multipart-uploads.
string | null
ID’et for multipart-uploaden, som sendes tilbage til complete. Kun til stede ved oprettelse og kun for multipart-uploads.
object[] | null
Den forudsignerede URL for hver del. Kun til stede ved oprettelse og kun for multipart-uploads.

Egenskaber

integer
påkrævet
Det 1-baserede indeks for denne del i multipart-uploaden.
string
påkrævet
Den forudsignerede URL, som denne dels bytes skal sendes til med PUT.
string
påkrævet
Typen af dette objekt, altid file.
boolean
påkrævet
Om moderation har fjernet filen. Når true, serverer url et erstatningsbillede. filename, size og content_type beskriver stadig den originale fil.
integer | null
påkrævet
Filstørrelsen i bytes. null, indtil uploaden er færdig.
object
Headers, der skal sendes med upload-PUT’en. Kun til stede ved oprettelse.
string
påkrævet
Hvor filen er i sin upload-livscyklus.Tilgængelige muligheder: pending, processing, ready, failed
string | null
Forudsigneret URL, som filens bytes skal sendes til med PUT. Kun til stede ved oprettelse og kun for single-part-uploads.
string | null
påkrævet
En URL til at downloade filen. Offentlige filer får en permanent CDN-URL, og private filer får en signeret URL, der udløber. null, indtil uploaden er færdig. Når moderation fjerner filen, en URL til et erstatningsbillede.
string
påkrævet
public-filer serveres fra en usigneret CDN-URL. private-filer serveres fra en signeret URL, der udløber.Tilgængelige muligheder: public, private
string | null
påkrævet
URL til lydens bølgeform. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
påkrævet
Billed- eller videobredde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Den overordnede platforms egen identifikator for denne underkonto, unik blandt platformens underkonti. null, når den ikke er angivet.
object | null
påkrævet
Kontoens seneste finansieringsansøgning. Beregnes kun ved retrieve og me for kaldere med scopet company:balance:read; ellers null, eller når kontoen aldrig har ansøgt om finansiering.

Egenskaber

string
påkrævet
ID’et for kontoens seneste finansieringsansøgning, der starter med inrq_. Hent den for at se krav og feedback fra gennemgangen.
string
påkrævet
Gennemgangsstatus for den seneste finansieringsansøgning: requires_collection (venter på forhandleren, inklusive efter en anmodning om flere oplysninger), awaiting_review, approved, denied eller completed. Om finansieringsbetalingsmetoder er aktiveret, angives af capabilities.accept_bnpl_payments.Tilgængelige muligheder: requires_collection, awaiting_review, completed, approved, denied
string | null
påkrævet
Hvornår en suspenderet konto kan udbetale sin saldo til sin egen udbetalingsmetode, som et ISO 8601-tidsstempel. En tvist kan rykke det senere. Beregnes ved retrieve, me og suspend; ellers null, når status ikke er suspended, og når suspensionen tilbageholder saldoen.
string[]
påkrævet
Præferencer for kontoens offentlige startside.Tilgængelige muligheder: hide_member_count, hide_members_card
string | null
påkrævet
Specifik branchevertikal for kontoen. Se ordlisten over virksomhedstyper og brancher for gyldige værdier.
string | null
påkrævet
Præfiks, der bruges til kontoens fakturaer.
object | null
påkrævet
Whop Levels-fremskridt for kontoens owner, talt på tværs af alle konti, de ejer, så de alle viser det samme niveau. Beregnes kun ved retrieve og me for kaldere med scopet company:basic:read; ellers null, og når kontoen ikke er med i Whop Levels.

Egenskaber

integer
påkrævet
Denne kontos eget niveau ud fra dens egne point alene, fra 0 op til 10. current er højere, når ejerens andre konti løfter det.
integer
påkrævet
Det niveau, der gælder: det højeste, ejeren har nået denne måned eller i de 5 foregående måneder, fra 0 op til 10.
integer
påkrævet
Point optjent denne måned på tværs af alle konti, ejeren ejer, plus ejerens partnerpoint, rundet ned. En konto, hvis måned netto er under nul, tæller som nul.
object
påkrævet
Denne måneds point fordelt efter, hvor de blev optjent. Hver kilde er netto efter refusioner, så en kilde kan være negativ.

Egenskaber

integer
påkrævet
Point fra betalte Whop Ads-gebyrer, netto efter refusioner: 10 for hver dollar, rundet mod nul.
integer
påkrævet
Point fra gennemført forbrug på Whop Card, netto efter refusioner: 10 for hver dollar, rundet mod nul.
integer
påkrævet
Point fra konti, ejeren har henvist som partner: 1 for hver 3, de optjener, rundet mod nul.
integer
påkrævet
Point fra handelsvolumen i perpetuals udført via Whop: 1 for hver handlet dollar, rundet mod nul.
string
påkrævet
Hvornår denne måneds point nulstilles, som et ISO 8601-tidsstempel.
string | null
påkrævet
URL til kontoens logobillede.
object
påkrævet
Vilkårlige nøgle/værdi-metadata angivet ved oprettelse af kontoen.
string | null
påkrævet
Typen af onboarding, kontoen har gennemført.Tilgængelige muligheder: platform, seller
string | null
påkrævet
URL til kontoens Open Graph-billede.
string | null
påkrævet
Variant af kontoens Open Graph-billede.Tilgængelige muligheder: white, black, orange
boolean
påkrævet
Om betalingsorkestrering er aktiveret for denne konto.
string | null
påkrævet
Detaljer om virksomhedstype, når business_type er other.
string | null
påkrævet
Detaljer om branche, når industry_type er other.
object
påkrævet
Den enkelte bruger, der ejer kontoen, og hvis e-mail er email ovenfor. Adskiller sig fra rollen owner på teammedlemmer, som et vilkårligt antal af dem kan have.

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. Den er en genereret pladsholder, når brugeren ikke har angivet et billede.
string
påkrævet
Offentligt brugernavn.
object | null
påkrævet
Overordnet konto for underkonti, eller null for selvstændige konti.

Egenskaber

string
påkrævet
Konto-ID med præfikset biz_.
object
Tillægssatser, som denne overordnede konto opkræver af den underkonto, der læses, opdelt efter gebyrtype (for eksempel crypto_deposit_markup), hver med percentage_fee og fixed_fee_usd. Fastlagt således, at underkontoens egne tilsidesættelser har forrang for platformens standard.
string | null
påkrævet
URL til kontoens logobillede.
string
påkrævet
Kontoens offentlige rute-identifikator.
string
påkrævet
Kontoens visningsnavn.
object | null
Kontoens aktive førsteniveaupartner. Til stede i retrieve-svar; null, når ingen aktiv førsteniveaupartner er tilknyttet kontoen. Udeladt fra andre svar.

Egenskaber

string
påkrævet
Bruger-ID med præfikset user_.
string | null
påkrævet
E-mailadresse til at kontakte partneren. Null, når partneren ikke har tilføjet sin egen e-mailadresse.
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. Den er en genereret pladsholder, når brugeren ikke har angivet et billede.
object | null
påkrævet
Den virksomhed, på hvis vegne partneren henviste denne konto, når henvisningen tilhører deres team. null for en personlig henvisning.

Egenskaber

string
påkrævet
Konto-ID med præfikset biz_.
string
påkrævet
Kontoens visningsnavn.
string
påkrævet
Offentligt brugernavn.
string | null
påkrævet
Hvornår brugeren blev en verificeret Whop Partner, som et ISO 8601-tidsstempel. Null, hvis ikke verificeret.
object | null
påkrævet
Kontroller for betalingssundhed, der i øjeblikket anvendes på kontoen. Beregnes kun ved retrieve og me for kaldere med scopet company:balance:read; ellers null.

Egenskaber

object
påkrævet
Indstillinger for automatisk refusion ved tvistadvarsler før chargeback.

Egenskaber

boolean
påkrævet
Om kontoejeren er forhindret i at ændre denne tærskel.
number | null
påkrævet
Maksimalt beløb for tvistadvarsler, der automatisk refunderes, i USD. null, når automatiske refusioner er deaktiveret.
number | null
påkrævet
Gebyr opkrævet for hver tvistadvarsel i USD. null, når det ikke er tilgængeligt.
boolean
påkrævet
Om 3-D Secure gennemtvinges ved hver kortbetaling i checkout. Kontoen kan ikke omgå det, mens det er angivet.
boolean
påkrævet
Om kontrollerne for betalingssundhed eksplicit deaktiverer finansiering. Dette er uafhængigt af finansieringsgodkendelse i capabilities.accept_bnpl_payments.
number
påkrævet
Ekstra procentvist behandlingsgebyr for højrisikobehandling.
object[]
påkrævet
Betalingsmetoder, som kontoen er blevet advaret om nærmer sig deres grænse for tvistrate. Hver post indeholder payment_method, measure (disputes, disputes_and_tc40s eller fraud_disputes), warned_at som et ISO 8601-tidsstempel samt rate, warning_rate og target_rate som brøker, hvor 0.01 er 1 %. Tom, når ingen er advaret. En advaret metode sættes på pause og vises i restricted_payment_methods, hvis den stadig er over sin målrate omkring fire uger senere.
number
påkrævet
Procentgebyr, der opkræves, når en afventende, endnu ikke afregnet saldo forudbetales for at finansiere kontoens kortsaldo, hvor 2 betyder 2 %. 0, når kontoen er fritaget.
integer
påkrævet
Ekstra dage, betalinger forbliver afventende, før de bliver tilgængelige.
object
påkrævet
Reserve, der i øjeblikket anvendes på indgående betalingsvolumen.

Egenskaber

integer
påkrævet
Antal dage, reserverede midler holdes tilbage, før de frigives.
number | null
påkrævet
Procentdel af indgående betalingsvolumen, der holdes i reserve. null, når der ikke anvendes nogen reserve.
object
påkrævet
Indstillinger for automatisk refusion for sager i resolution center.

Egenskaber

number | null
påkrævet
Maksimalt kortfinansieret sagsbeløb i resolution center, der automatisk refunderes, i USD. null, når automatiske refusioner er deaktiveret for kort.
number | null
påkrævet
Maksimalt finansieringsfinansieret sagsbeløb i resolution center, der automatisk refunderes, i USD. null, når automatiske refusioner er deaktiveret for finansiering.
boolean
påkrævet
Om kontoejeren er forhindret i at ændre disse tærskler.
number | null
påkrævet
Maksimalt PayPal-finansieret sagsbeløb i resolution center, der automatisk refunderes, i USD. null, når automatiske refusioner er deaktiveret for PayPal.
string[]
påkrævet
Kortmærker, der er blokeret i checkout for denne konto. Tom, når ingen er blokeret. Kontoen kan ikke selv genaktivere dem.Tilgængelige muligheder: card_visa, card_mastercard, card_american_express, card_discover_global_network, addi, affirm, afterpay_clearpay, alma, billie, capchase_pay, claritypay, flex_pay, klarna, kriya, kueski, mondu, oney, scalapay, sequra, sezzle, splitit, sunbit, tabby, tamara, zip, card_installments_three, card_installments_six, card_installments_twelve, oney_3x, oney_4x, klarna_pay_now, us_bank_account, sepa_debit, bacs_debit, au_becs_debit, acss_debit, pay_by_bank, payto, paypal, cashapp, venmo, amazon_pay, link, wechat_pay
string | null
påkrævet
Hvorfor afventende midler uden en afregningsdato endnu ikke flyttes. kyc_incomplete, pending_information_request og update_payout_profile er ting, forhandleren kan handle på. compliance_review betyder, at en verifikation, som forhandleren allerede har indsendt, er under gennemgang, så disse midler forbliver afventende, indtil den er godkendt. withdrawals_disabled betyder, at Whop har blokeret hævninger, så disse midler ikke kan blive tilgængelige. null, når der ikke er nogen årsag at vise — stadig under afregning eller tilbageholdt af en årsag, der ikke er nævnt her.Tilgængelige muligheder: kyc_incomplete, pending_information_request, update_payout_profile, compliance_review, withdrawals_disabled
object
påkrævet
Hvordan kontoens saldo automatisk hæves.

Egenskaber

integer | null
påkrævet
Dag, hvor den automatiske hævning kører: 0-6 (søndag-lørdag) for weekly, 1-31 for monthly. null for manual og daily.
string
påkrævet
Hvor ofte kontoens saldo automatisk hæves.Tilgængelige muligheder: manual, daily, weekly, monthly
string | null
påkrævet
Næste dato, hvor den automatiske hævning er planlagt til at køre, som en ISO 8601-dato. null for manual og daily, hvor der ikke gælder en enkelt næste dato.
object | null
påkrævet
Kontoens standardbetalingsmetoder i checkout. En variants eller checkout-konfigurations egen payment_method_configuration har forrang. null, når kontoen bruger Whops platformsstandarder.

Egenskaber

string[]
påkrævet
Betalingsmetoder, som denne checkout tilbageholder, selv når standarderne ville tilbyde dem.
string[]
påkrævet
Betalingsmetoder, som denne checkout tilbyder ud over det, standarderne giver.
boolean
påkrævet
Om Whops standardsæt er udgangspunktet. Når false, tilbydes kun enabled.
object[]
påkrævet
Platformskreditter udstedt af Whop pr. valuta, læst fra saldo-cachen. Kreditter kan kun bruges på kvalificerede Whop-produkter såsom Whop Ads, kan aldrig hæves og er ikke inkluderet i balances eller total_usd. Tom, når kontoen ikke har nogen, eller total_usd er null.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object | null
påkrævet
Kontoens dokument med privatlivspolitik, eller null, hvis den ikke har udgivet et.

Egenskaber

string
påkrævet
Filens ID med præfikset file_.
string | null
påkrævet
BlurHash-pladsholder for et billede eller en video. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Den originale fils MIME-type, for eksempel application/pdf. Den bevares, når moderation fjerner filen.
string
påkrævet
Hvornår filen blev oprettet, som et ISO 8601-tidsstempel.
number | null
påkrævet
Lyd- eller videovarighed i sekunder. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Det originale filnavn inklusive filtypenavnet.
integer | null
påkrævet
Billed- eller videohøjde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
Den bytestørrelse, hver del (undtagen den sidste) skal have. Kun til stede ved oprettelse og kun for multipart-uploads.
string | null
ID’et for multipart-uploaden, som sendes tilbage til complete. Kun til stede ved oprettelse og kun for multipart-uploads.
object[] | null
Den forudsignerede URL for hver del. Kun til stede ved oprettelse og kun for multipart-uploads.

Egenskaber

integer
påkrævet
Det 1-baserede indeks for denne del i multipart-uploaden.
string
påkrævet
Den forudsignerede URL, som denne dels bytes skal sendes til med PUT.
string
påkrævet
Typen af dette objekt, altid file.
boolean
påkrævet
Om moderation har fjernet filen. Når true, serverer url et erstatningsbillede. filename, size og content_type beskriver stadig den originale fil.
integer | null
påkrævet
Filstørrelsen i bytes. null, indtil uploaden er færdig.
object
Headers, der skal sendes med upload-PUT’en. Kun til stede ved oprettelse.
string
påkrævet
Hvor filen er i sin upload-livscyklus.Tilgængelige muligheder: pending, processing, ready, failed
string | null
Forudsigneret URL, som filens bytes skal sendes til med PUT. Kun til stede ved oprettelse og kun for single-part-uploads.
string | null
påkrævet
En URL til at downloade filen. Offentlige filer får en permanent CDN-URL, og private filer får en signeret URL, der udløber. null, indtil uploaden er færdig. Når moderation fjerner filen, en URL til et erstatningsbillede.
string
påkrævet
public-filer serveres fra en usigneret CDN-URL. private-filer serveres fra en signeret URL, der udløber.Tilgængelige muligheder: public, private
string | null
påkrævet
URL til lydens bølgeform. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
påkrævet
Billed- eller videobredde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
object | null
påkrævet
Skatteklassifikationskode, der som standard anvendes på kontoens produkter, med id, name og product_type. null, når ingen standard er angivet.
UDFASET: Brug i stedet endpointet GET /economic_intelligence?account_id=\{account_id}.

Egenskaber

string
påkrævet
Anbefalingen; nye værdier kan blive tilføjet, så håndter ukendte handlinger på en robust mådeTilgængelige muligheder: theme_business, create_product, create_plan, verify_identity, connect_affiliate_program, create_promotion, migrate_from_stripe, accept_first_payment, launch_first_ad, launch_draft_campaign, increase_ad_budget, refresh_ad_creatives, fix_ad_billing, exclude_customers_from_ads, retarget_abandoned_checkouts, fix_funnel_dropoff, invite_team_member, enable_tax_collection, create_card, apply_for_financing
string[]
påkrævet
Funktioner, dette ville låse op, eller tom
string
påkrævet
Den URL, som call-to-action linker til
string
påkrævet
Knaptekst
string
påkrævet
Understøttende tekst, eller tom
string | null
påkrævet
URL til illustrationsikon, eller null
integer | null
påkrævet
Anslået effekt fra 0-100, eller null, når den ikke er rangeret
string | null
påkrævet
Hvorfor denne handling blev anbefalet, eller null
string
påkrævet
Altid valgfri — aldrig blokerendeTilgængelige muligheder: optional
string
påkrævet
Overskrift for anbefalingen
boolean
påkrævet
Om autoriserede brugere skal aktivere tofaktorgodkendelse.
object[] | null
påkrævet
Handlinger, som kontoejeren skal udføre for at låse funktioner som udbetalinger og kortforbrug op, sorteret efter visningsprioritet. Beregnes kun ved retrieve og me for kaldere med scopet company:balance:read; ellers null.

Egenskaber

string
påkrævet
Hvad indehaveren skal gøre; nye værdier kan blive tilføjet, så håndter ukendte handlinger på en robust mådeTilgængelige muligheder: deposit_funds, review_held_payments, submit_information_request, update_automatic_withdrawal_method, reauthorize_payout_methods, update_payout_method, update_payout_profile, card_usage_review, verify_identity, scale_account_setup, sign_formation_documents, configure_tax_remitter, add_vat_registration, confirm_tax_details, accept_payout_terms, enable_two_factor_authentication, respond_to_abuse_report
string[]
påkrævet
Funktioner, der er spærret, indtil dette er løst
string | null
påkrævet
Den URL, som call-to-action linker til, eller null, når der ikke er nogen knap
string
påkrævet
Knaptekst, eller tom, når der ikke er nogen knap
string
påkrævet
Understøttende tekst, eller tom
string | null
påkrævet
URL’en til handlingens illustrationsikon, eller null, hvis den ikke har et
string
påkrævet
required (handl nu) eller pending (under gennemgang)Tilgængelige muligheder: required, pending
string
påkrævet
Overskrift for handlingen
object | null
påkrævet
Kontoens dokument med returpolitik, eller null, hvis den ikke har udgivet et.

Egenskaber

string
påkrævet
Filens ID med præfikset file_.
string | null
påkrævet
BlurHash-pladsholder for et billede eller en video. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Den originale fils MIME-type, for eksempel application/pdf. Den bevares, når moderation fjerner filen.
string
påkrævet
Hvornår filen blev oprettet, som et ISO 8601-tidsstempel.
number | null
påkrævet
Lyd- eller videovarighed i sekunder. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Det originale filnavn inklusive filtypenavnet.
integer | null
påkrævet
Billed- eller videohøjde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
Den bytestørrelse, hver del (undtagen den sidste) skal have. Kun til stede ved oprettelse og kun for multipart-uploads.
string | null
ID’et for multipart-uploaden, som sendes tilbage til complete. Kun til stede ved oprettelse og kun for multipart-uploads.
object[] | null
Den forudsignerede URL for hver del. Kun til stede ved oprettelse og kun for multipart-uploads.

Egenskaber

integer
påkrævet
Det 1-baserede indeks for denne del i multipart-uploaden.
string
påkrævet
Den forudsignerede URL, som denne dels bytes skal sendes til med PUT.
string
påkrævet
Typen af dette objekt, altid file.
boolean
påkrævet
Om moderation har fjernet filen. Når true, serverer url et erstatningsbillede. filename, size og content_type beskriver stadig den originale fil.
integer | null
påkrævet
Filstørrelsen i bytes. null, indtil uploaden er færdig.
object
Headers, der skal sendes med upload-PUT’en. Kun til stede ved oprettelse.
string
påkrævet
Hvor filen er i sin upload-livscyklus.Tilgængelige muligheder: pending, processing, ready, failed
string | null
Forudsigneret URL, som filens bytes skal sendes til med PUT. Kun til stede ved oprettelse og kun for single-part-uploads.
string | null
påkrævet
En URL til at downloade filen. Offentlige filer får en permanent CDN-URL, og private filer får en signeret URL, der udløber. null, indtil uploaden er færdig. Når moderation fjerner filen, en URL til et erstatningsbillede.
string
påkrævet
public-filer serveres fra en usigneret CDN-URL. private-filer serveres fra en signeret URL, der udløber.Tilgængelige muligheder: public, private
string | null
påkrævet
URL til lydens bølgeform. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
påkrævet
Billed- eller videobredde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
object[]
Virksomhedsbelønninger tilknyttet via denne kontos aktive henvisningslink, med kontospecifikt fremskridt og ledgerstatus. Til stede i retrieve-svar; tom uden både læseadgang til saldo og statistik.

Egenskaber

string
påkrævet
Belønningsdefinitions-ID med præfikset prwd_. Fremskridt og status gælder for den konto, der indeholder den.
object
påkrævet
Kvalificerende USD-volumen, der kræves for at optjene denne belønning.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object
påkrævet
Kvalificerende USD-volumen for belønningens aktivitet, som denne konto har akkumuleret siden tilknytningen, beregnet ud fra opfyldelsesreglerne.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
string
påkrævet
Aktivitet, der kvalificerer denne konto til belønningen.Tilgængelige muligheder: sales, ad_spend
object
påkrævet
USD-beløb, der krediteres for denne belønning. Bruger det gemte tildelingsbeløb, når opfyldelsen er startet.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
string
påkrævet
Denne kontos belønningsstatus. Credited kræver en bogført ledgerpost; processing inkluderer et opfyldt krav, der afventer opfyldelse. Reversing og reversed afspejler en efterfølgende tilbageførsel af belønningen.Tilgængelige muligheder: in_progress, processing, credited, reversing, reversed, unavailable
string
påkrævet
Kontoens offentlige rute-identifikator.
boolean
påkrævet
Om Whop sender transaktionelle e-mails til kunder på vegne af denne konto.
object | null
påkrævet
Kontoens dokument med forsendelsespolitik, eller null, hvis den ikke har udgivet et.

Egenskaber

string
påkrævet
Filens ID med præfikset file_.
string | null
påkrævet
BlurHash-pladsholder for et billede eller en video. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Den originale fils MIME-type, for eksempel application/pdf. Den bevares, når moderation fjerner filen.
string
påkrævet
Hvornår filen blev oprettet, som et ISO 8601-tidsstempel.
number | null
påkrævet
Lyd- eller videovarighed i sekunder. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Det originale filnavn inklusive filtypenavnet.
integer | null
påkrævet
Billed- eller videohøjde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
Den bytestørrelse, hver del (undtagen den sidste) skal have. Kun til stede ved oprettelse og kun for multipart-uploads.
string | null
ID’et for multipart-uploaden, som sendes tilbage til complete. Kun til stede ved oprettelse og kun for multipart-uploads.
object[] | null
Den forudsignerede URL for hver del. Kun til stede ved oprettelse og kun for multipart-uploads.

Egenskaber

integer
påkrævet
Det 1-baserede indeks for denne del i multipart-uploaden.
string
påkrævet
Den forudsignerede URL, som denne dels bytes skal sendes til med PUT.
string
påkrævet
Typen af dette objekt, altid file.
boolean
påkrævet
Om moderation har fjernet filen. Når true, serverer url et erstatningsbillede. filename, size og content_type beskriver stadig den originale fil.
integer | null
påkrævet
Filstørrelsen i bytes. null, indtil uploaden er færdig.
object
Headers, der skal sendes med upload-PUT’en. Kun til stede ved oprettelse.
string
påkrævet
Hvor filen er i sin upload-livscyklus.Tilgængelige muligheder: pending, processing, ready, failed
string | null
Forudsigneret URL, som filens bytes skal sendes til med PUT. Kun til stede ved oprettelse og kun for single-part-uploads.
string | null
påkrævet
En URL til at downloade filen. Offentlige filer får en permanent CDN-URL, og private filer får en signeret URL, der udløber. null, indtil uploaden er færdig. Når moderation fjerner filen, en URL til et erstatningsbillede.
string
påkrævet
public-filer serveres fra en usigneret CDN-URL. private-filer serveres fra en signeret URL, der udløber.Tilgængelige muligheder: public, private
string | null
påkrævet
URL til lydens bølgeform. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
påkrævet
Billed- eller videobredde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
boolean
påkrævet
Om kontoen vises i tilmeldte whops på andre konti.
boolean
påkrævet
Om anmeldelser vises på produktsider direkte til forbrugeren.
boolean
påkrævet
Om kontoen viser brugere i brugerkataloget.
Kontoens sociale links.

Egenskaber

string
påkrævet
ID’et for det sociale link
string | null
påkrævet
Den valgfrie visningstitel for det sociale link
string
påkrævet
URL’en for det sociale link
string
påkrævet
Den sociale platform for dette linkTilgængelige muligheder: x, instagram, facebook, tiktok, youtube, linkedin, twitch, website, custom
string | null
påkrævet
Om kontoen kan operere på Whop: active eller suspended. Beregnes ved list, retrieve, me og suspend; ellers null.
string | null
påkrævet
Hvorfor kontoen blev suspenderet, som en etiket såsom Suspended - Fraudulent activity. Suspended, når der ikke er registreret nogen årsag. Beregnes ved retrieve, me og suspend. Ellers null, eller når status ikke er suspended.
object
påkrævet
Visningskonfiguration for kontoens butiksside.

Egenskaber

string | null
påkrævet
Accentfarve, der bruges på kontoens butiksside.Tilgængelige muligheder: ruby, tomato, red, crimson, pink, plum, purple, violet, iris, cyan, teal, jade, green, grass, brown, blue, orange, indigo, sky, mint, yellow, amber, lime, lemon, magenta, gold, bronze, gray
string | null
påkrævet
Layout, der bruges på kontoens butiksside.Tilgængelige muligheder: featured, compact
string | null
påkrævet
Profilpræsentation, der bruges på kontoens butiksside.Tilgængelige muligheder: personal, business
Om kontoens butiksside viser et Whop-affiliate-link.
string | null
påkrævet
Målgruppe for denne konto.
string[]
påkrævet
Amerikanske delstatskoder (af de 50 delstater plus DC), hvor kontoen opkræver skat: det fulde sæt, når Whop afregner (tax_remitted_by whop), det konfigurerede undersæt, når kontoen selv afregner (self), og tom, når ingen af delene. Ved opdatering skal du sende den komplette liste for at erstatte den (kun tilladt ved self).
object[]
påkrævet
Kontoens skatte-/momsregistreringer. Tom, når ingen er angivet.

Egenskaber

string
påkrævet
Skatteidentifikatorens ID.
string
påkrævet
Type af skatte-ID.Tilgængelige muligheder: ad_nrt, ao_tin, ar_cuit, al_tin, am_tin, aw_tin, au_abn, au_arn, eu_vat, az_tin, bs_tin, bh_vat, bd_bin, bb_tin, by_tin, bj_ifu, bo_tin, ba_tin, br_cnpj, br_cpf, bg_uic, bf_ifu, kh_tin, cm_niu, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cv_nif, cl_tin, cn_tin, co_nit, cd_nif, cr_tin, hr_oib, do_rcn, ec_ruc, eg_tin, sv_nit, et_tin, eu_oss_vat, ge_vat, gh_tin, de_stn, gb_vat, gn_nif, hk_br, hu_tin, is_vat, in_gst, id_npwp, il_vat, jp_cn, jp_rn, jp_trn, kz_bin, ke_pin, kg_tin, la_tin, li_uid, li_vat, my_frp, my_itn, my_sst, mr_nif, mx_rfc, md_vat, me_pib, ma_vat, np_pan, nz_gst, ng_tin, mk_vat, no_vat, no_voec, om_vat, pe_ruc, ph_tin, pl_nip, ro_tin, ru_inn, ru_kpp, sa_vat, sn_ninea, rs_pib, sg_gst, sg_uen, si_tin, za_vat, kr_brn, es_cif, ch_uid, ch_vat, tw_vat, tj_tin, tz_vat, th_vat, tr_tin, ug_tin, ua_vat, ae_trn, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, zm_tin, zw_tin, sr_fin, xi_vat
string
påkrævet
Værdi for skatte-ID, for eksempel DE123456789. Se guiden til skatte-ID’er.
string | null
påkrævet
Hvem der beregner og afregner skat for kontoen. whop betyder, at Whop beregner og afregner. self betyder, at Whop beregner, og kontoen opkræver og afregner. none betyder ingen af delene, og kontoen er ansvarlig. Nye virksomheder starter på whop, og nye tilknyttede konti starter på none. null betyder, at kontoen endnu ikke har nogen indstilling.Tilgængelige muligheder: whop, self, none
string | null
påkrævet
Hvordan skat anvendes på kontoens priser: inclusive (skat inkluderet i den angivne pris) eller exclusive (skat lagt oveni). Standard er exclusive, når den ikke er angivet; kun null, når kontoen ikke har nogen betalingsforbindelse.Tilgængelige muligheder: inclusive, exclusive
object | null
påkrævet
Kontoens dokument med servicevilkår, eller null, hvis den ikke har udgivet et.

Egenskaber

string
påkrævet
Filens ID med præfikset file_.
string | null
påkrævet
BlurHash-pladsholder for et billede eller en video. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Den originale fils MIME-type, for eksempel application/pdf. Den bevares, når moderation fjerner filen.
string
påkrævet
Hvornår filen blev oprettet, som et ISO 8601-tidsstempel.
number | null
påkrævet
Lyd- eller videovarighed i sekunder. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
Det originale filnavn inklusive filtypenavnet.
integer | null
påkrævet
Billed- eller videohøjde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
Den bytestørrelse, hver del (undtagen den sidste) skal have. Kun til stede ved oprettelse og kun for multipart-uploads.
string | null
ID’et for multipart-uploaden, som sendes tilbage til complete. Kun til stede ved oprettelse og kun for multipart-uploads.
object[] | null
Den forudsignerede URL for hver del. Kun til stede ved oprettelse og kun for multipart-uploads.

Egenskaber

integer
påkrævet
Det 1-baserede indeks for denne del i multipart-uploaden.
string
påkrævet
Den forudsignerede URL, som denne dels bytes skal sendes til med PUT.
string
påkrævet
Typen af dette objekt, altid file.
boolean
påkrævet
Om moderation har fjernet filen. Når true, serverer url et erstatningsbillede. filename, size og content_type beskriver stadig den originale fil.
integer | null
påkrævet
Filstørrelsen i bytes. null, indtil uploaden er færdig.
object
Headers, der skal sendes med upload-PUT’en. Kun til stede ved oprettelse.
string
påkrævet
Hvor filen er i sin upload-livscyklus.Tilgængelige muligheder: pending, processing, ready, failed
string | null
Forudsigneret URL, som filens bytes skal sendes til med PUT. Kun til stede ved oprettelse og kun for single-part-uploads.
string | null
påkrævet
En URL til at downloade filen. Offentlige filer får en permanent CDN-URL, og private filer får en signeret URL, der udløber. null, indtil uploaden er færdig. Når moderation fjerner filen, en URL til et erstatningsbillede.
string
påkrævet
public-filer serveres fra en usigneret CDN-URL. private-filer serveres fra en signeret URL, der udløber.Tilgængelige muligheder: public, private
string | null
påkrævet
URL til lydens bølgeform. Null, når den ikke er tilgængelig eller er fjernet af moderation.
integer | null
påkrævet
Billed- eller videobredde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderation.
string | null
påkrævet
3D Secure-adfærd for understøttede on-session-kortbetalinger. mandate_challenge kræver en 3DS-udfordring før betalingsbehandling; mandate_if_required kræver kun en udfordring, når betalingsbehandleren kræver det; frictionless_if_required bruger det almindelige friktionsfrie 3DS-flow. Betalinger på $1,000 eller mere bruger mandate_if_required, medmindre mandate_challenge er valgt. Krav til risiko og genoprettelse af godkendelse kan tilsidesætte præferencen. null bruger det almindelige checkout-flow.Tilgængelige muligheder: mandate_challenge, mandate_if_required, frictionless_if_required
string
påkrævet
Kontoens visningsnavn.
number | null
påkrævet
Kontoens samlede salg i hele dens levetid, normaliseret til USD. Beregnes kun ved retrieve og me for kaldere med scopet stats:read; ellers null.
string | null
påkrævet
Samlet USD-værdi på tværs af saldi med kendte vekselkurser. Beregnes kun ved læsning af en enkelt konto (retrieve og me); null i list-svar, skrivninger, ved manglende tilladelse til at læse saldo eller utilgængelig saldokilde.
trading_account | null
påkrævet
Handelskontoens adresse, et øjebliksbillede af dens margin og åbne positioner samt dens WebSocket-abonnementer. Tilvælg med include_trading=true ved læsning af en enkelt konto. Ellers null, uden handelstilladelse eller uden en Ethereum-wallet.

Egenskaber

string
påkrævet
ID’et for den Whop-wallet, der understøtter denne handelskonto, med præfikset cwal_.
string | null
påkrævet
Den konto, der ejer denne handelskonto, med præfikset biz_. null, når en bruger ejer den.
object | null
påkrævet
Hyperliquid-specifik tilstand. Til stede, når provider er hyperliquid, ellers null.

Egenskaber

string
påkrævet
Wallet-adresse med små bogstaver, der indeholder Hyperliquid-kontoen.
string | null
påkrævet
USDT0 i Whop-walleten på Plasma, som en deposit-handel kan flytte ind på denne konto, som en decimalstreng. null, når kæden ikke kunne læses.
object | null
påkrævet
Kontoværdi og margin på tværs af hovedbørsen og xyz-markederne, læst fra Hyperliquid højst én gang i sekundet. null, når Hyperliquid ikke kunne læses. Brug websocket_subscriptions til liveopdateringer.

Egenskaber

object
påkrævet
Samlet kontoværdi i USD, inklusive urealiseret gevinst og tab.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object
påkrævet
Margin fordelt på tværs af åbne positioner, i USD.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object
påkrævet
Samlet nominel værdi af åbne positioner, i USD.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object
påkrævet
USD, der kan hæves nu uden at lukke positioner.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
trading_position[] | null
påkrævet
Åbne perpetual-positioner på tværs af hovedbørsen og xyz-markederne, læst fra Hyperliquid højst én gang i sekundet. null, når Hyperliquid ikke kunne læses. Brug websocket_subscriptions til liveopdateringer.

Egenskaber

string
påkrævet
Handelspositions-ID med præfikset trdpos_. Stabilt for et marked inden for én handelskonto.
object | null
påkrævet
Gennemsnitlig indgangspris i USD, eller null, når udbyderen udelader den.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object | null
påkrævet
Detaljer om Hyperliquid-perpetuals. Til stede på Hyperliquid-positioner, ellers null.

Egenskaber

object
påkrævet
Funding betalt på positionen over flere vinduer, i USD.

Egenskaber

object | null
påkrævet
Funding betalt på dette marked på tværs af kontoens historik, i USD, eller null, når den ikke er tilgængelig.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object | null
påkrævet
Funding betalt, siden positionsstørrelsen sidst ændrede sig, i USD, eller null, når den ikke er tilgængelig.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object | null
påkrævet
Funding betalt, siden positionen blev åbnet, i USD, eller null, når den ikke er tilgængelig.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object
påkrævet
Marginmodus og multiplikator for positionen.

Egenskaber

string
påkrævet
cross deler margin på tværs af positioner. isolated begrænser margin til denne position.Tilgængelige muligheder: cross, isolated
integer
påkrævet
Multiplikator anvendt på positionens margin, såsom 10 for 10x.
object | null
påkrævet
Anslået likvidationspris i USD, eller null, når Hyperliquid ikke rapporterer nogen.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object
påkrævet
Margin tildelt positionen, i USD.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
string
påkrævet
Egenkapitalforrentning som en decimal ratio-streng, såsom 0.1 for 10 %.
string
påkrævet
Markedssymbol hos udbyderen, såsom ETH.
string
påkrævet
object
påkrævet
Nuværende positionsværdi i USD.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
string
påkrævet
Tilgængelige muligheder: long, short
string
påkrævet
Absolut positionsstørrelse som en decimalstreng.
object
påkrævet
Urealiseret gevinst eller tab i USD. Negativ ved tab.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object[]
påkrævet
Abonnementer til liveopdateringer af kontoen. Send hver message uændret efter at have oprettet forbindelse til websocket_url.

Egenskaber

string
påkrævet
Den livestrøm af opdateringer, som dette abonnement åbner.Tilgængelige muligheder: clearinghouse_state, open_orders, order_updates, user_fills, user_events
string
påkrævet
JSON-abonnementsbesked, der skal sendes uændret over Hyperliquid-WebSocket.
string
påkrævet
Hyperliquid-WebSocket-URL at oprette direkte forbindelse til for liveopdateringer.
string
påkrævet
string
påkrævet
Handelssted, der holder positionerne og ordrerne.Tilgængelige muligheder: hyperliquid
object | null
påkrævet
Spotbeholdninger i Whop-walleten med deres indgangspris og gevinst og tab. null, når de ikke kunne læses.

Egenskaber

object[]
påkrævet
Hvert spotaktiv, som walleten stadig har, med dets gennemsnitlige indgangspris og gevinst og tab. Anskaffelsesværdien regner de ældste enheder som solgt først og inkluderer aktiver, der er kommet udefra Whop.

Egenskaber

object | null
påkrævet
Den gennemsnitlige pris betalt pr. enhed af det, der stadig er beholdt, i USD, hvor de ældste enheder regnes som solgt først. null, når den ikke er kendt.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object
påkrævet
Hvad der blev betalt i USD for de enheder, der stadig er beholdt.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
string
påkrævet
Spotmarkedets id fra GET /trades/markets, såsom BTC, XAUT eller en tokeniseret akties ticker såsom AAPL.
object
påkrævet
Gevinster og tab, der allerede er låst fast ved salg, i USD.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
object
påkrævet
Værdien af de enheder, der stadig er beholdt, minus deres cost_basis, i USD.

Egenskaber

string
påkrævet
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er "10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.
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 lokalitet ved hjælp af dette.
number | null
påkrævet
unrealized_pnl som en procentdel af cost_basis, hvor 2 betyder op med 2 %. null, når den ikke er kendt.
string | null
påkrævet
Den bruger, der ejer denne handelskonto, med præfikset user_. null, når en konto ejer den.
boolean
påkrævet
Om kontoen bruger sit logo som reserve-Open Graph-billede.
object
påkrævet
Status for kontoens identitetsverifikation for profilerne individual (KYC) og business (KYB). Hver er null, indtil den oprettes, ellers en status på not_started, pending, manual_review, approved eller rejected.
number | null
påkrævet
Volumen gennem kontoen inden for de sidste 30 dage (GMV fra betalte kvitteringer), normaliseret til USD. Beregnes kun ved list for kaldere med stats:read på kontoen; ellers null.
number | null
påkrævet
Samlet volumen gennem kontoen i hele dens levetid — salg plus modtagne overførsler — normaliseret til USD. Beregnes kun ved list for kaldere med stats:read på kontoen; ellers null.
object | null
påkrævet
Kontoens primære kryptowallet, eller null, hvis der ikke er oprettet nogen.

Egenskaber

string
påkrævet
Wallet-ID med præfikset wallet_.
string
påkrævet
Wallettens on-chain-adresse
string
påkrævet
Det blockchain-netværk, walleten findes påTilgængelige muligheder: solana, ethereum, bitcoin
string | null
påkrævet
Kontoens URL til virksomhedens hjemmeside, eller null, hvis der ikke er angivet nogen. Hvis den angives, tilføjes der også en website-post til social_links.
string | null
Hvornår kontoen slog Whop Partner-tilstand til, som et ISO 8601-tidsstempel. Til stede ved læsning af en enkelt konto og i opdateringssvar; null, indtil kontoen slår Whop Partner-tilstand til ved at sende whop_partner_enabled: true ved opdatering.
Account

Virksomhedstyper og brancher

Tre felter klassificerer konti: business_type, industry_group og industry_type. Den fulde taksonomi findes på sin egen side:

Virksomhedstyper og brancher