Skip to main content
Gebruik accounts voor klanten, creators, merchants, verkopers of gekoppelde bedrijven die je integratie ondersteunt. Gebruik de Accounts API om accounts aan te maken, accounts weer te geven die zichtbaar zijn voor je inloggegevens, een account op te halen of bij te werken, een subaccount dat door je platform wordt beheerd te schorsen of te verwijderen, en het account op te halen dat bij de huidige API-sleutel hoort. De velden business_type, industry_group en industry_type classificeren accounts. Zie de woordenlijst met bedrijfstypen en branches voor alle geldige waarden.

Endpoints

Opslagen op kosten

Met opslagen op kosten kan een platform kosten toevoegen of uitbetalingskosten subsidiëren voor de subaccounts. Beheer ze via het kostendocument van het account: stel standaarden in op het platformaccount of overschrijf afzonderlijke kosten op een subaccount. Zie Opslagen en subsidies op kosten voor voorbeelden, limieten en financieringsvereisten.

Kosten-endpoints

Gebruik de API-sleutel van het platformaccount met de machtiging company:update_child_fees om opslagen te configureren. Elke geretourneerde opslag bevat adjustable en unadjustable_reason, zodat je integratie kan bepalen of bewerken mogelijk is.

Kosten lezen

De sectie markups bevat de effectieve tarieven van het subaccount. De sectie child_markups op een platformaccount bevat de standaarden voor subaccounts. De source van een opslag is custom wanneer deze op dat niveau is geconfigureerd, of default wanneer deze terugvalt op een overgenomen tarief of nul. Het veld default toont het tarief dat zou gelden als de aangepaste opslag werd gewist. Geretourneerde vaste bedragen gebruiken het Money-object; updates accepteren fixed als getal in Amerikaanse dollars.

Platformstandaarden instellen

Werk child_markups bij op het platformaccount. Dit voorbeeld stelt een betalingsopslag van 2% in zonder vaste kosten:
percentage: 2 betekent 2%. Standaarden gelden voor subaccounts zonder overschrijving voor die kosten. Betalingsopslagen gelden wanneer er geen applicatiekosten voor de checkout zijn ingesteld.

Een overschrijving voor een subaccount instellen

Werk markups bij op het subaccount. Dit voorbeeld vervangt de overgenomen betalingsopslag door 1% plus $0.25:
Alleen de keys die je verstuurt worden gewijzigd. Gebruik voor andere transactietypen transfers, crypto_swaps, deposits per rail, of payouts per uitbetalingsmethode. Zie het update-endpoint voor de ondersteunde keys en het request-schema.

Een opslag wissen

Stuur null voor de opslag om deze te wissen. Als je de overschrijving van een subaccount wist, wordt de platformstandaard hersteld, of nul als er geen standaard is geconfigureerd:
Om een platformstandaard te wissen, stuur je child_markups: { payments: null } naar het platformaccount. Een expliciete { percentage: 0, fixed: 0 } blijft een geconfigureerd tarief; gebruik null om overerving te herstellen. Een account publiceert de juridische documenten als pdf-bestanden: terms_of_service, privacy_policy, return_policy, cancellation_policy, shipping_policy en eula. Elk wordt teruggelezen als een File en wordt ingesteld via Update Account met de id van een bestand dat je hebt geüpload. Nieuwe geschillen nemen standaard hun beleidsbewijs over uit deze documenten. Het vak voor het annuleringsbeleid gebruikt cancellation_policy, dan terms_of_service, dan return_policy. Het vak voor het terugbetalingsbeleid gebruikt return_policy, dan terms_of_service. Beide vakken vallen terug op het platformbeleid van Whop wanneer er niets is ingesteld, en shipping_policy gaat mee bij geschillen over fysieke goederen. Stel ze hier één keer in en gebruik Upload Dispute Evidence alleen wanneer één geschil een andere versie van een beleid nodig heeft.
Stuur null voor een document om het te verwijderen. Alleen pdf-bestanden worden geaccepteerd.

Eigenschappen

string
vereist
Account-ID, met prefix biz_.
number | null
vereist
Totale in rekening gebrachte advertentie-uitgaven van het account, in USD. Alleen berekend bij list voor aanroepers met stats:read op het account; anders null.
object[]
vereist
Tegoeden van het account, elk met een waarde in USD. Leeg wanneer total_usd null is.

Eigenschappen

string
vereist
Totaal aangehouden bedrag in native eenheden, als decimale string.
object
vereist
Saldo uitgesplitst in beschikbare, lopende en gereserveerde bedragen, als decimale strings in native eenheden, met de dagen waarop het lopende bedrag naar verwachting wordt verrekend.

Eigenschappen

string
vereist
Bedrag dat je nu kunt uitgeven, versturen of opnemen, in native eenheden, als decimale string.
string
vereist
Het deel van pending dat al is verrekend en wacht om naar de crypto-wallet of Whop Card van het account te worden verplaatst, waar het available wordt. De verplaatsing begint meestal binnen een uur; zolang die loopt, wordt het bedrag in plaats daarvan in in_transit gerapporteerd. Geld dat alleen wordt verplaatst om het aangehouden minimumsaldo van het account aan te vullen, is niet inbegrepen. In native eenheden, als decimale string.
string
vereist
Bedrag dat wordt verplaatst tussen de eigen bestemmingen van het account, zoals het opwaarderen van een kaart. In native eenheden, als decimale string.
string
vereist
Bedrag uit recente betalingen dat nog wordt verrekend, in native eenheden, als decimale string.
object[]
vereist
Wanneer het lopende bedrag naar verwachting wordt verrekend, één item per dag, vroegste eerst. Geld zonder geplande verrekeningsdag, inclusief finishing_settlement, wordt weggelaten, dus deze items plus finishing_settlement kunnen samen minder zijn dan pending, maar nooit meer.

Eigenschappen

string
vereist
Bedrag dat die dag wordt verwacht, in native eenheden, als decimale string.
string
vereist
De dag waarop dit geld naar verwachting volledig is verrekend, als ISO 8601-datum.
string
vereist
Ingehouden bedrag, in native eenheden, als decimale string. Haal de reserves van het account op om te zien waarom het wordt ingehouden en wanneer het vrijkomt.
string | null
vereist
URL van het pictogram van het tegoed.
string
vereist
De weergavenaam van het tegoed
number | null
vereist
USD-prijs per eenheid, of null wanneer er geen wisselkoers beschikbaar is.
string
vereist
Weergavesymbool van het tegoed, zoals USDT, cbBTC of EUR.
string | null
vereist
USD-waarde van het tegoed, of null wanneer er geen wisselkoers beschikbaar is.
string | null
vereist
URL van de bannerafbeelding van het account.
object | null
vereist
Zakelijk adres van het account dat wordt gebruikt om belasting te berekenen, met line1, line2, city, state, postal_code en country. null wanneer er geen adres is ingesteld.
string | null
vereist
De wettelijke bedrijfsnaam van het account die samen met het belastingadres wordt gebruikt.
string | null
vereist
Algemene bedrijfscategorie van het account. Zie de woordenlijst met bedrijfstypen en branches voor geldige waarden.
boolean
vereist
Of lopende tegoeden van dit platformaccount naar de subaccounts mogen worden overgemaakt.
object | null
vereist
Het annuleringsbeleid van het account, of null als het account er geen heeft gepubliceerd.

Eigenschappen

string
vereist
De ID van het bestand, met prefix file_.
string | null
vereist
BlurHash-placeholder voor een afbeelding of video. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
Het MIME-type van het oorspronkelijke bestand, bijvoorbeeld application/pdf. Dit blijft behouden wanneer moderatie het bestand verwijdert.
string
vereist
Wanneer het bestand is aangemaakt, als ISO 8601-tijdstempel.
number | null
vereist
Duur van audio of video in seconden. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
De oorspronkelijke bestandsnaam, inclusief extensie.
integer | null
vereist
Hoogte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
De grootte in bytes die elk deel (behalve het laatste) moet hebben. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
string | null
De ID van de multipart-upload, die wordt teruggegeven aan complete. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
object[] | null
De presigned URL voor elk deel. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.

Eigenschappen

integer
vereist
De index (beginnend bij 1) van dit deel binnen de multipart-upload.
string
vereist
De presigned URL waarnaar je de bytes van dit deel met PUT verstuurt.
string
vereist
Het type van dit object, altijd file.
boolean
vereist
Of moderatie het bestand heeft verwijderd. Wanneer true, levert url een vervangende afbeelding. filename, size en content_type beschrijven nog steeds het oorspronkelijke bestand.
integer | null
vereist
De bestandsgrootte in bytes. null totdat de upload is voltooid.
object
Headers die met de upload-PUT moeten worden meegestuurd. Alleen aanwezig bij aanmaken.
string
vereist
Waar het bestand zich in de uploadlevenscyclus bevindt.Beschikbare opties: pending, processing, ready, failed
string | null
Presigned URL waarnaar je de bytes van het bestand met PUT verstuurt. Alleen aanwezig bij aanmaken, en alleen voor uploads uit één deel.
string | null
vereist
Een URL om het bestand te downloaden. Openbare bestanden krijgen een permanente CDN-URL en privébestanden krijgen een ondertekende URL die verloopt. null totdat de upload is voltooid. Wanneer moderatie het bestand verwijdert, een URL van een vervangende afbeelding.
string
vereist
public-bestanden worden geleverd via een niet-ondertekende CDN-URL. private-bestanden worden geleverd via een ondertekende URL die verloopt.Beschikbare opties: public, private
string | null
vereist
URL van de audiogolfvorm. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
vereist
Breedte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
object | null
vereist
Betaalrails die voor dit account zijn ingeschakeld, elk active, inactive of pending (onboarding of beoordeling bezig). Alleen berekend bij retrieve en me voor aanroepers met de scope company:balance:read; anders null.

Eigenschappen

string
vereist
Bankbetalingen: incasso’s, overboekingen en lokale bankrailsBeschikbare opties: active, inactive, pending
string
vereist
Betalingen via achteraf betalen (buy now, pay later); vereist goedkeuringBeschikbare opties: active, inactive, pending
string
vereist
Kaartbetalingen, inclusief Apple Pay en Google PayBeschikbare opties: active, inactive, pending
string
vereist
Stortingen via bankoverschrijving of ACH op de virtuele bankrekening van het accountBeschikbare opties: active, inactive, pending
string
vereist
Saldo-opwaarderingen door een opgeslagen betaalmethode te belastenBeschikbare opties: active, inactive, pending
string
vereist
Uitgifte van Whop-kaarten; vereist goedkeuring van de kaartaanvraagBeschikbare opties: active, inactive, pending
string
vereist
On-chain stortingen naar de crypto-wallet van het accountBeschikbare opties: active, inactive, pending
string
vereist
On-chain uitbetalingen naar een crypto-walletBeschikbare opties: active, inactive, pending
string
vereist
Directe uitbetalingen naar een geschikte uitbetalingsbestemmingBeschikbare opties: active, inactive, pending
string
vereist
Advertentiecampagnes lanceren via Whop Ads. inactive totdat de identiteit of het bedrijf van het account is geverifieerd, zolang een aangevraagde overeenkomst voor advertentiediensten wacht op de handtekening van het account, en zolang het account is geschorst van Whop Ads.Beschikbare opties: active, inactive, pending
string
vereist
Standaarduitbetalingen naar een externe uitbetalingsbestemmingBeschikbare opties: active, inactive, pending
string
vereist
Overboekingen naar andere accountsBeschikbare opties: active, inactive, pending
object | null
vereist
Gegevens van de Whop Cards-aanvraag voor het account. Geretourneerd bij list, retrieve en me voor aanroepers met de scope company:balance:read; anders null, of wanneer het account geen kaartaanvraag of blokkerende aanvraagbeoordeling heeft.

Eigenschappen

string | null
vereist
Reden waarom de kaartuitgever de aanvraag heeft afgewezen. unsupported_state vervangt unsupported_region voor een geverifieerde persoon of een geverifieerd bedrijf in de Verenigde Staten. compliance omvat controles op sancties, politiek prominente personen en negatieve media. other omvat redenen die niet in deze lijst staan. null wanneer status niet denied is, of wanneer de uitgever de aanvraag niet heeft afgewezen.Beschikbare opties: compromised_identity, duplicate, unsupported_region, compliance, fraud, verification_failed, unsupported_state, other
string | null
vereist
Of de kaartaanvraag een bedrijf (business, KYB) of een persoon (individual, consumentenidentiteit) verifieert. null wanneer de aanvraag nog niet aan een verificatie is gekoppeld.Beschikbare opties: individual, business
string
vereist
De status van de kaartaanvraag. approved betekent dat er kaarten kunnen worden uitgegeven. needs_verification betekent dat de aanvrager de identiteitsverificatie nog niet heeft voltooid; needs_information betekent dat dit wel is gebeurd, maar dat de documenten om een herstelbare reden zijn afgewezen en opnieuw moeten worden ingediend. pending en manual_review zijn in behandeling. denied, locked en canceled zijn definitief.Beschikbare opties: approved, pending, manual_review, denied, locked, canceled, needs_verification, needs_information
boolean
vereist
Of de checkout een veld voor een btw-/belasting-ID toont dat kopers optioneel kunnen invullen. Een btw-ID is niet vereist om een aankoop te doen.
object
vereist
Status van de bedrijfsoprichting voor het account, beheerd via Form Company. Een status van draft totdat de checkout voor de oprichting is betaald, daarna de voortgang van de registratie met downloadbare documenten en handtekeningen die op actie wachten. Leeg wanneer de oprichtingsstatus tijdelijk niet beschikbaar is.

Eigenschappen

object[]
Oprichtingsdocumenten die beschikbaar zijn om te downloaden, zoals de Articles of Organization en de EIN-bevestigingsbrief. Aanwezig zodra status niet meer draft is.

Eigenschappen

string
vereist
Document-ID, met prefix file_.
string
vereist
Leesbare documentnaam, zoals Articles of Organization.
string
vereist
Documentcategorie: articles_of_organization, operating_agreement, ein_letter, signed_ss4, signed_form8821 of mail voor post die namens het bedrijf is ontvangen.
string
vereist
CDN-URL om het document te downloaden.
boolean
Of de EIN van het bedrijf door de IRS is uitgegeven. Aanwezig zodra status niet meer draft is.
Geregistreerde bedrijfsnaam inclusief de rechtsvormaanduiding, bijvoorbeeld Acme, LLC. Aanwezig zodra status niet meer draft is.
object
IRS-formulieren die nog wachten op de handtekening van een oprichter, elk met een gehoste ondertekenings-URL. Aanwezig zodra status niet meer draft is; leeg wanneer er niets hoeft te worden ondertekend.

Eigenschappen

object
Ondertekeningsstatus van IRS-formulier 8821, de machtiging voor belastinginformatie. Alleen aanwezig zolang het formulier nog actie van de oprichter vereist.

Eigenschappen

string
Wanneer de ondertekenings-URL verloopt, als ISO 8601-tijdstempel. Alleen aanwezig wanneer de ondertekenings-URL is opgenomen.
string
vereist
pending wanneer een ondertekeningssessie klaarstaat voor de oprichter; unknown wanneer de ondertekeningsstatus niet kon worden bepaald.Beschikbare opties: pending, unknown
string
Gehoste ondertekenings-URL waar de oprichter het formulier invult. Aanwezig zolang status pending is en de aanroeper incorporation:write heeft. Weggelaten uit webhooks.
object
Ondertekeningsstatus van IRS-formulier SS-4, de EIN-aanvraag. Alleen aanwezig zolang het formulier nog actie van de oprichter vereist.

Eigenschappen

string
Wanneer de ondertekenings-URL verloopt, als ISO 8601-tijdstempel. Alleen aanwezig wanneer de ondertekenings-URL is opgenomen.
string
vereist
pending wanneer een ondertekeningssessie klaarstaat voor de oprichter; unknown wanneer de ondertekeningsstatus niet kon worden bepaald.Beschikbare opties: pending, unknown
string
Gehoste ondertekenings-URL waar de oprichter het formulier invult. Aanwezig zolang status pending is en de aanroeper incorporation:write heeft. Weggelaten uit webhooks.
boolean
Of de registratie van de oprichting bij de staat is voltooid. Aanwezig zodra status niet meer draft is.
string
Beschikbare opties: draft, processing, filed, rejected, completed
string | null
vereist
Land waar het account is gevestigd.
string
vereist
Wanneer het account is aangemaakt, als ISO 8601-tijdstempel.
integer | null
vereist
Unieke klanten met een betaald ontvangstbewijs bij het account in de afgelopen 30 dagen, elke paar uur vernieuwd. Alleen berekend bij retrieve voor aanroepers met stats:read op het account; anders null, en ook wanneer het aantal niet beschikbaar is.
string | null
vereist
Promotionele beschrijving van het account.
integer
Hoeveel teamleden rechtstreeks aan het bedrijf rapporteren, zonder manager boven zich. Aanwezig bij het lezen van een enkel account.
boolean
vereist
Of Whop bewijs voor geschillen verzamelt en indient voor dit account. Door dit in te schakelen kiest het account voor de succesvergoeding die wordt gerekend over gewonnen geschillen.
boolean
vereist
Of Economic Intelligence is ingeschakeld voor het account. Het wordt automatisch uitgeschakeld wanneer de vastgelegde periode afloopt. Zolang het is uitgeschakeld, kan het account geen experiment activeren of een aanbeveling uitvoeren.
string | null
vereist
E-mailadres van de accounteigenaar.
object | null
vereist
De licentieovereenkomst voor eindgebruikers (EULA) van het account, of null als het account er geen heeft gepubliceerd.

Eigenschappen

string
vereist
De ID van het bestand, met prefix file_.
string | null
vereist
BlurHash-placeholder voor een afbeelding of video. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
Het MIME-type van het oorspronkelijke bestand, bijvoorbeeld application/pdf. Dit blijft behouden wanneer moderatie het bestand verwijdert.
string
vereist
Wanneer het bestand is aangemaakt, als ISO 8601-tijdstempel.
number | null
vereist
Duur van audio of video in seconden. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
De oorspronkelijke bestandsnaam, inclusief extensie.
integer | null
vereist
Hoogte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
De grootte in bytes die elk deel (behalve het laatste) moet hebben. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
string | null
De ID van de multipart-upload, die wordt teruggegeven aan complete. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
object[] | null
De presigned URL voor elk deel. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.

Eigenschappen

integer
vereist
De index (beginnend bij 1) van dit deel binnen de multipart-upload.
string
vereist
De presigned URL waarnaar je de bytes van dit deel met PUT verstuurt.
string
vereist
Het type van dit object, altijd file.
boolean
vereist
Of moderatie het bestand heeft verwijderd. Wanneer true, levert url een vervangende afbeelding. filename, size en content_type beschrijven nog steeds het oorspronkelijke bestand.
integer | null
vereist
De bestandsgrootte in bytes. null totdat de upload is voltooid.
object
Headers die met de upload-PUT moeten worden meegestuurd. Alleen aanwezig bij aanmaken.
string
vereist
Waar het bestand zich in de uploadlevenscyclus bevindt.Beschikbare opties: pending, processing, ready, failed
string | null
Presigned URL waarnaar je de bytes van het bestand met PUT verstuurt. Alleen aanwezig bij aanmaken, en alleen voor uploads uit één deel.
string | null
vereist
Een URL om het bestand te downloaden. Openbare bestanden krijgen een permanente CDN-URL en privébestanden krijgen een ondertekende URL die verloopt. null totdat de upload is voltooid. Wanneer moderatie het bestand verwijdert, een URL van een vervangende afbeelding.
string
vereist
public-bestanden worden geleverd via een niet-ondertekende CDN-URL. private-bestanden worden geleverd via een ondertekende URL die verloopt.Beschikbare opties: public, private
string | null
vereist
URL van de audiogolfvorm. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
vereist
Breedte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
De eigen identifier van het bovenliggende platform voor dit subaccount, uniek binnen de subaccounts van het platform. null wanneer niet ingesteld.
object | null
vereist
De meest recente financieringsaanvraag van het account. Alleen berekend bij retrieve en me voor aanroepers met de scope company:balance:read; anders null, of wanneer het account nooit financiering heeft aangevraagd.

Eigenschappen

string
vereist
De ID van de meest recente financieringsaanvraag van het account, beginnend met inrq_. Haal deze op voor vereisten en feedback op de beoordeling.
string
vereist
De beoordelingsstatus van de meest recente financieringsaanvraag: requires_collection (wacht op de verkoper, ook na een verzoek om meer informatie), awaiting_review, approved, denied of completed. Of financieringsbetaalmethoden zijn ingeschakeld, staat in capabilities.accept_bnpl_payments.Beschikbare opties: requires_collection, awaiting_review, completed, approved, denied
string | null
vereist
Wanneer een geschorst account het saldo kan uitbetalen naar de eigen uitbetalingsmethode, als ISO 8601-tijdstempel. Een geschil kan dit moment uitstellen. Berekend bij retrieve, me en suspend; anders null, wanneer status niet suspended is, en wanneer de schorsing het saldo vasthoudt.
string[]
vereist
Voorkeuren voor de openbare startpagina van het account.Beschikbare opties: hide_member_count, hide_members_card
string | null
vereist
Specifieke branche van het account. Zie de woordenlijst met bedrijfstypen en branches voor geldige waarden.
string | null
vereist
Prefix dat wordt gebruikt voor facturen van het account.
object | null
vereist
De voortgang in Whop Levels van de owner van het account, geteld over alle accounts die deze persoon bezit, zodat ze allemaal hetzelfde level tonen. Alleen berekend bij retrieve en me voor aanroepers met de scope company:basic:read; anders null, en ook wanneer het account niet deelneemt aan Whop Levels.

Eigenschappen

integer
vereist
Het eigen level van dit account op basis van alleen de eigen punten, van 0 tot 10. current is hoger wanneer de andere accounts van de eigenaar het optillen.
integer
vereist
Het level dat van toepassing is: het hoogste dat de eigenaar deze maand of in de 5 maanden ervoor heeft bereikt, van 0 tot 10.
integer
vereist
Punten die deze maand zijn verdiend over alle accounts van de eigenaar, plus de partnerpunten van de eigenaar, naar beneden afgerond. Een account met een netto negatieve maand telt als nul.
object
vereist
De punten van deze maand, uitgesplitst naar waar ze zijn verdiend. Elke bron is verrekend met de eigen terugbetalingen, dus een bron kan negatief zijn.

Eigenschappen

integer
vereist
Punten uit betaalde Whop Ads-kosten, na aftrek van terugbetalingen: 10 voor elke dollar, afgerond richting nul.
integer
vereist
Punten uit vastgelegde uitgaven met de Whop Card, na aftrek van terugbetalingen: 10 voor elke dollar, afgerond richting nul.
integer
vereist
Punten uit accounts die de eigenaar als partner heeft doorverwezen: 1 voor elke 3 die zij verdienen, afgerond richting nul.
integer
vereist
Punten uit handelsvolume in perpetuals dat via Whop is uitgevoerd: 1 voor elke verhandelde dollar, afgerond richting nul.
string
vereist
Wanneer de punten van deze maand worden teruggezet naar nul, als ISO 8601-tijdstempel.
string | null
vereist
URL van de logoafbeelding van het account.
object
vereist
Willekeurige key/value-metadata die bij het aanmaken van het account is opgegeven.
string | null
vereist
Type onboarding dat het account heeft voltooid.Beschikbare opties: platform, seller
string | null
vereist
URL van de Open Graph-afbeelding van het account.
string | null
vereist
Variant van de Open Graph-afbeelding van het account.Beschikbare opties: white, black, orange
boolean
vereist
Of betalingsorkestratie is ingeschakeld voor dit account.
string | null
vereist
Details over het bedrijfstype wanneer business_type other is.
string | null
vereist
Details over de branche wanneer industry_type other is.
object
vereist
De enige gebruiker die eigenaar is van het account, wiens e-mailadres de email hierboven is. Dit staat los van de rol owner voor teamleden, die door een onbeperkt aantal teamleden kan worden vervuld.

Eigenschappen

string
vereist
Gebruikers-ID, met prefix user_.
string | null
vereist
Weergavenaam.
object
vereist
Avatar-wrapper. De url is altijd aanwezig en is een gegenereerde placeholder wanneer de gebruiker geen foto heeft ingesteld.

Eigenschappen

string
vereist
URL van de avatarafbeelding. Altijd aanwezig. Het is een gegenereerde placeholder wanneer de gebruiker geen foto heeft ingesteld.
string
vereist
Openbare gebruikersnaam.
object | null
vereist
Bovenliggend account voor subaccounts, of null voor zelfstandige accounts.

Eigenschappen

string
vereist
Account-ID, met prefix biz_.
object
Opslagpercentages die dit bovenliggende account in rekening brengt bij het subaccount dat wordt gelezen, per kostentype (bijvoorbeeld crypto_deposit_markup), elk met percentage_fee en fixed_fee_usd. Bepaald waarbij de eigen overschrijvingen van het subaccount voorrang hebben op de standaard van het platform.
string | null
vereist
URL van de logoafbeelding van het account.
string
vereist
Openbare route-identifier van het account.
string
vereist
Weergavenaam van het account.
object | null
De actieve eerstelijnspartner van het account. Aanwezig in retrieve-responses; null wanneer er geen actieve eerstelijnspartner aan het account is toegeschreven. Weggelaten uit andere responses.

Eigenschappen

string
vereist
Gebruikers-ID, met prefix user_.
string | null
vereist
E-mailadres om contact op te nemen met de partner. Null wanneer de partner geen eigen e-mailadres heeft toegevoegd.
string | null
vereist
Weergavenaam.
object
vereist
Avatar-wrapper. De url is altijd aanwezig en is een gegenereerde placeholder wanneer de gebruiker geen foto heeft ingesteld.

Eigenschappen

string
vereist
URL van de avatarafbeelding. Altijd aanwezig. Het is een gegenereerde placeholder wanneer de gebruiker geen foto heeft ingesteld.
object | null
vereist
Het bedrijf namens welk de partner dit account heeft doorverwezen, wanneer de doorverwijzing bij hun team hoort. null voor een persoonlijke doorverwijzing.

Eigenschappen

string
vereist
Account-ID, met prefix biz_.
string
vereist
Weergavenaam van het account.
string
vereist
Openbare gebruikersnaam.
string | null
vereist
Wanneer de gebruiker een geverifieerde Whop Partner werd, als ISO 8601-tijdstempel. Null als niet geverifieerd.
object | null
vereist
Maatregelen voor betalingsgezondheid die momenteel op het account worden toegepast. Alleen berekend bij retrieve en me voor aanroepers met de scope company:balance:read; anders null.

Eigenschappen

object
vereist
Instellingen voor automatische terugbetaling bij waarschuwingen over geschillen vóór een chargeback.

Eigenschappen

boolean
vereist
Of de accounteigenaar wordt verhinderd deze drempel te wijzigen.
number | null
vereist
Maximaal bedrag van een geschilwaarschuwing dat automatisch wordt terugbetaald, in USD. null wanneer automatische terugbetalingen zijn uitgeschakeld.
number | null
vereist
Kosten die voor elke geschilwaarschuwing in rekening worden gebracht, in USD. null wanneer niet beschikbaar.
boolean
vereist
Of 3-D Secure wordt afgedwongen bij elke kaartbetaling in de checkout. Het account kan dit niet omzeilen zolang het is ingesteld.
boolean
vereist
Of de maatregelen voor betalingsgezondheid financiering expliciet uitschakelen. Dit staat los van de goedkeuring voor financiering in capabilities.accept_bnpl_payments.
number
vereist
Extra percentage verwerkingskosten voor verwerking met een hoog risico.
object[]
vereist
Betaalmethoden waarvoor het account een waarschuwing heeft gekregen dat ze de grens voor het geschilpercentage naderen. Elk item bevat payment_method, measure (disputes, disputes_and_tc40s of fraud_disputes), warned_at als ISO 8601-tijdstempel, en de rate, warning_rate en target_rate als fracties waarbij 0.01 gelijk is aan 1%. Leeg wanneer er geen waarschuwingen zijn. Een gewaarschuwde methode wordt gepauzeerd en verschijnt in restricted_payment_methods als deze ongeveer vier weken later nog steeds boven het doelpercentage zit.
number
vereist
Percentage kosten dat in rekening wordt gebracht wanneer een lopend, nog niet verrekend saldo wordt voorgeschoten om het kaartsaldo van het account te financieren, waarbij 2 2% betekent. 0 wanneer het account is vrijgesteld.
integer
vereist
Extra dagen dat betalingen in behandeling blijven voordat ze beschikbaar worden.
object
vereist
Reserve die momenteel wordt toegepast op het inkomende betalingsvolume.

Eigenschappen

integer
vereist
Aantal dagen dat gereserveerde tegoeden worden vastgehouden voordat ze worden vrijgegeven.
number | null
vereist
Percentage van het inkomende betalingsvolume dat in reserve wordt gehouden. null wanneer er geen reserve wordt toegepast.
object
vereist
Instellingen voor automatische terugbetaling bij zaken in het resolutiecentrum.

Eigenschappen

number | null
vereist
Maximaal bedrag van een met een kaart betaalde zaak in het resolutiecentrum dat automatisch wordt terugbetaald, in USD. null wanneer automatische terugbetalingen voor kaarten zijn uitgeschakeld.
number | null
vereist
Maximaal bedrag van een met financiering betaalde zaak in het resolutiecentrum dat automatisch wordt terugbetaald, in USD. null wanneer automatische terugbetalingen voor financiering zijn uitgeschakeld.
boolean
vereist
Of de accounteigenaar wordt verhinderd deze drempels te wijzigen.
number | null
vereist
Maximaal bedrag van een met PayPal betaalde zaak in het resolutiecentrum dat automatisch wordt terugbetaald, in USD. null wanneer automatische terugbetalingen voor PayPal zijn uitgeschakeld.
string[]
vereist
Kaartmerken die in de checkout voor dit account zijn geblokkeerd. Leeg wanneer er geen zijn geblokkeerd. Het account kan ze niet zelf opnieuw inschakelen.Beschikbare opties: 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
vereist
Waarom lopende tegoeden zonder verrekeningsdatum nog niet worden verplaatst. kyc_incomplete, pending_information_request en update_payout_profile zijn zaken waarop de verkoper actie kan ondernemen. compliance_review betekent dat een verificatie die de verkoper al heeft ingediend wordt beoordeeld, zodat deze tegoeden in behandeling blijven totdat die is afgerond. withdrawals_disabled betekent dat Whop opnames heeft geblokkeerd, zodat deze tegoeden niet beschikbaar kunnen worden. null wanneer er geen reden is om te tonen — nog in verrekening, of vastgehouden om een reden die hier niet wordt genoemd.Beschikbare opties: kyc_incomplete, pending_information_request, update_payout_profile, compliance_review, withdrawals_disabled
object
vereist
Hoe het saldo van het account automatisch wordt opgenomen.

Eigenschappen

integer | null
vereist
Dag waarop de automatische opname wordt uitgevoerd: 0-6 (zondag-zaterdag) voor weekly, 1-31 voor monthly. null voor manual en daily.
string
vereist
Hoe vaak het saldo van het account automatisch wordt opgenomen.Beschikbare opties: manual, daily, weekly, monthly
string | null
vereist
Volgende datum waarop de automatische opname gepland staat, als ISO 8601-datum. null voor manual en daily, waarbij geen enkele volgende datum van toepassing is.
object | null
vereist
De standaardbetaalmethoden van het account in de checkout. De eigen payment_method_configuration van een variant of checkoutconfiguratie heeft voorrang. null wanneer het account de platformstandaarden van Whop gebruikt.

Eigenschappen

string[]
vereist
Betaalmethoden die deze checkout achterhoudt, zelfs wanneer de standaarden ze zouden aanbieden.
string[]
vereist
Betaalmethoden die deze checkout aanbiedt bovenop wat de standaarden bieden.
boolean
vereist
Of de standaardset van Whop het uitgangspunt is. Wanneer false, wordt alleen enabled aangeboden.
object[]
vereist
Door Whop uitgegeven platformtegoeden per valuta, gelezen uit de saldocache. Tegoeden kunnen alleen worden besteed aan geschikte Whop-producten zoals Whop Ads, kunnen nooit worden opgenomen en zijn niet opgenomen in balances of total_usd. Leeg wanneer het account er geen heeft of total_usd null is.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object | null
vereist
Het privacybeleid van het account, of null als het account er geen heeft gepubliceerd.

Eigenschappen

string
vereist
De ID van het bestand, met prefix file_.
string | null
vereist
BlurHash-placeholder voor een afbeelding of video. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
Het MIME-type van het oorspronkelijke bestand, bijvoorbeeld application/pdf. Dit blijft behouden wanneer moderatie het bestand verwijdert.
string
vereist
Wanneer het bestand is aangemaakt, als ISO 8601-tijdstempel.
number | null
vereist
Duur van audio of video in seconden. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
De oorspronkelijke bestandsnaam, inclusief extensie.
integer | null
vereist
Hoogte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
De grootte in bytes die elk deel (behalve het laatste) moet hebben. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
string | null
De ID van de multipart-upload, die wordt teruggegeven aan complete. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
object[] | null
De presigned URL voor elk deel. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.

Eigenschappen

integer
vereist
De index (beginnend bij 1) van dit deel binnen de multipart-upload.
string
vereist
De presigned URL waarnaar je de bytes van dit deel met PUT verstuurt.
string
vereist
Het type van dit object, altijd file.
boolean
vereist
Of moderatie het bestand heeft verwijderd. Wanneer true, levert url een vervangende afbeelding. filename, size en content_type beschrijven nog steeds het oorspronkelijke bestand.
integer | null
vereist
De bestandsgrootte in bytes. null totdat de upload is voltooid.
object
Headers die met de upload-PUT moeten worden meegestuurd. Alleen aanwezig bij aanmaken.
string
vereist
Waar het bestand zich in de uploadlevenscyclus bevindt.Beschikbare opties: pending, processing, ready, failed
string | null
Presigned URL waarnaar je de bytes van het bestand met PUT verstuurt. Alleen aanwezig bij aanmaken, en alleen voor uploads uit één deel.
string | null
vereist
Een URL om het bestand te downloaden. Openbare bestanden krijgen een permanente CDN-URL en privébestanden krijgen een ondertekende URL die verloopt. null totdat de upload is voltooid. Wanneer moderatie het bestand verwijdert, een URL van een vervangende afbeelding.
string
vereist
public-bestanden worden geleverd via een niet-ondertekende CDN-URL. private-bestanden worden geleverd via een ondertekende URL die verloopt.Beschikbare opties: public, private
string | null
vereist
URL van de audiogolfvorm. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
vereist
Breedte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
object | null
vereist
Belastingclassificatiecode die standaard op de producten van het account wordt toegepast, met id, name en product_type. null wanneer er geen standaard is ingesteld.
VEROUDERD: Gebruik in plaats daarvan het endpoint GET /economic_intelligence?account_id=\{account_id}.

Eigenschappen

string
vereist
De aanbeveling; er kunnen nieuwe waarden worden toegevoegd, dus handel onbekende acties netjes afBeschikbare opties: 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[]
vereist
Mogelijkheden die dit zou ontgrendelen, of leeg
string
vereist
De URL waarnaar de call-to-action linkt
string
vereist
Knoplabel
string
vereist
Ondersteunende tekst, of leeg
string | null
vereist
URL van het illustratiepictogram, of null
integer | null
vereist
Geschatte impact van 0-100, of null wanneer niet gerangschikt
string | null
vereist
Waarom deze actie is aanbevolen, of null
string
vereist
Altijd optioneel — nooit blokkerendBeschikbare opties: optional
string
vereist
Kop van de aanbeveling
boolean
vereist
Of geautoriseerde gebruikers tweestapsverificatie moeten inschakelen.
object[] | null
vereist
Acties die de accounteigenaar moet ondernemen om mogelijkheden zoals uitbetalingen en kaartuitgaven te deblokkeren, gesorteerd op weergaveprioriteit. Alleen berekend bij retrieve en me voor aanroepers met de scope company:balance:read; anders null.

Eigenschappen

string
vereist
Wat de houder moet doen; er kunnen nieuwe waarden worden toegevoegd, dus handel onbekende acties netjes afBeschikbare opties: 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[]
vereist
Mogelijkheden die geblokkeerd zijn totdat dit is opgelost
string | null
vereist
De URL waarnaar de call-to-action linkt, of null wanneer er geen knop is
string
vereist
Knoplabel, of leeg wanneer er geen knop is
string
vereist
Ondersteunende tekst, of leeg
string | null
vereist
De URL van het illustratiepictogram van de actie, of null als die er geen heeft
string
vereist
required (nu actie ondernemen) of pending (in beoordeling)Beschikbare opties: required, pending
string
vereist
Kop van de actie
object | null
vereist
Het retourbeleid van het account, of null als het account er geen heeft gepubliceerd.

Eigenschappen

string
vereist
De ID van het bestand, met prefix file_.
string | null
vereist
BlurHash-placeholder voor een afbeelding of video. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
Het MIME-type van het oorspronkelijke bestand, bijvoorbeeld application/pdf. Dit blijft behouden wanneer moderatie het bestand verwijdert.
string
vereist
Wanneer het bestand is aangemaakt, als ISO 8601-tijdstempel.
number | null
vereist
Duur van audio of video in seconden. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
De oorspronkelijke bestandsnaam, inclusief extensie.
integer | null
vereist
Hoogte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
De grootte in bytes die elk deel (behalve het laatste) moet hebben. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
string | null
De ID van de multipart-upload, die wordt teruggegeven aan complete. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
object[] | null
De presigned URL voor elk deel. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.

Eigenschappen

integer
vereist
De index (beginnend bij 1) van dit deel binnen de multipart-upload.
string
vereist
De presigned URL waarnaar je de bytes van dit deel met PUT verstuurt.
string
vereist
Het type van dit object, altijd file.
boolean
vereist
Of moderatie het bestand heeft verwijderd. Wanneer true, levert url een vervangende afbeelding. filename, size en content_type beschrijven nog steeds het oorspronkelijke bestand.
integer | null
vereist
De bestandsgrootte in bytes. null totdat de upload is voltooid.
object
Headers die met de upload-PUT moeten worden meegestuurd. Alleen aanwezig bij aanmaken.
string
vereist
Waar het bestand zich in de uploadlevenscyclus bevindt.Beschikbare opties: pending, processing, ready, failed
string | null
Presigned URL waarnaar je de bytes van het bestand met PUT verstuurt. Alleen aanwezig bij aanmaken, en alleen voor uploads uit één deel.
string | null
vereist
Een URL om het bestand te downloaden. Openbare bestanden krijgen een permanente CDN-URL en privébestanden krijgen een ondertekende URL die verloopt. null totdat de upload is voltooid. Wanneer moderatie het bestand verwijdert, een URL van een vervangende afbeelding.
string
vereist
public-bestanden worden geleverd via een niet-ondertekende CDN-URL. private-bestanden worden geleverd via een ondertekende URL die verloopt.Beschikbare opties: public, private
string | null
vereist
URL van de audiogolfvorm. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
vereist
Breedte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
object[]
Zakelijke beloningen die via de actieve doorverwijslink van dit account zijn gekoppeld, met accountspecifieke voortgang en grootboekstatus. Aanwezig in retrieve-responses; leeg zonder leestoegang tot zowel saldo als statistieken.

Eigenschappen

string
vereist
ID van de beloningsdefinitie, met prefix prwd_. Voortgang en status gelden voor het bovenliggende account.
object
vereist
Kwalificerend USD-volume dat nodig is om deze beloning te verdienen.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
Kwalificerend USD-volume voor de activiteit van de beloning dat dit account sinds de toeschrijving heeft opgebouwd, berekend volgens de uitvoeringsregels.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string
vereist
Activiteit waardoor dit account in aanmerking komt voor de beloning.Beschikbare opties: sales, ad_spend
object
vereist
USD-bedrag dat voor deze beloning wordt bijgeschreven. Gebruikt het opgeslagen toekenningsbedrag zodra de uitvoering is gestart.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string
vereist
De beloningsstatus van dit account. Credited vereist een geboekte grootboekpost; processing omvat een behaalde vereiste die wacht op uitvoering. Reversing en reversed weerspiegelen een latere terugdraaiing van de beloning.Beschikbare opties: in_progress, processing, credited, reversing, reversed, unavailable
string
vereist
Openbare route-identifier van het account.
boolean
vereist
Of Whop namens dit account transactionele e-mails naar klanten stuurt.
object | null
vereist
Het verzendbeleid van het account, of null als het account er geen heeft gepubliceerd.

Eigenschappen

string
vereist
De ID van het bestand, met prefix file_.
string | null
vereist
BlurHash-placeholder voor een afbeelding of video. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
Het MIME-type van het oorspronkelijke bestand, bijvoorbeeld application/pdf. Dit blijft behouden wanneer moderatie het bestand verwijdert.
string
vereist
Wanneer het bestand is aangemaakt, als ISO 8601-tijdstempel.
number | null
vereist
Duur van audio of video in seconden. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
De oorspronkelijke bestandsnaam, inclusief extensie.
integer | null
vereist
Hoogte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
De grootte in bytes die elk deel (behalve het laatste) moet hebben. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
string | null
De ID van de multipart-upload, die wordt teruggegeven aan complete. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
object[] | null
De presigned URL voor elk deel. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.

Eigenschappen

integer
vereist
De index (beginnend bij 1) van dit deel binnen de multipart-upload.
string
vereist
De presigned URL waarnaar je de bytes van dit deel met PUT verstuurt.
string
vereist
Het type van dit object, altijd file.
boolean
vereist
Of moderatie het bestand heeft verwijderd. Wanneer true, levert url een vervangende afbeelding. filename, size en content_type beschrijven nog steeds het oorspronkelijke bestand.
integer | null
vereist
De bestandsgrootte in bytes. null totdat de upload is voltooid.
object
Headers die met de upload-PUT moeten worden meegestuurd. Alleen aanwezig bij aanmaken.
string
vereist
Waar het bestand zich in de uploadlevenscyclus bevindt.Beschikbare opties: pending, processing, ready, failed
string | null
Presigned URL waarnaar je de bytes van het bestand met PUT verstuurt. Alleen aanwezig bij aanmaken, en alleen voor uploads uit één deel.
string | null
vereist
Een URL om het bestand te downloaden. Openbare bestanden krijgen een permanente CDN-URL en privébestanden krijgen een ondertekende URL die verloopt. null totdat de upload is voltooid. Wanneer moderatie het bestand verwijdert, een URL van een vervangende afbeelding.
string
vereist
public-bestanden worden geleverd via een niet-ondertekende CDN-URL. private-bestanden worden geleverd via een ondertekende URL die verloopt.Beschikbare opties: public, private
string | null
vereist
URL van de audiogolfvorm. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
vereist
Breedte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
boolean
vereist
Of het account verschijnt in de whops waarvan andere accounts lid zijn.
boolean
vereist
Of reviews worden getoond op productpagina’s die rechtstreeks aan consumenten verkopen.
boolean
vereist
Of het account gebruikers toont in de gebruikersgids.
Sociale links van het account.

Eigenschappen

string
vereist
De ID van de sociale link
string | null
vereist
De optionele weergavetitel van de sociale link
string
vereist
De URL van de sociale link
string
vereist
Het sociale platform voor deze linkBeschikbare opties: x, instagram, facebook, tiktok, youtube, linkedin, twitch, website, custom
string | null
vereist
Of het account op Whop kan opereren: active of suspended. Berekend bij list, retrieve, me en suspend; anders null.
string | null
vereist
Waarom het account is geschorst, als label zoals Suspended - Fraudulent activity. Suspended wanneer er geen reden is vastgelegd. Berekend bij retrieve, me en suspend. Anders null, of wanneer status niet suspended is.
object
vereist
Weergaveconfiguratie van de winkelpagina van het account.

Eigenschappen

string | null
vereist
Accentkleur die op de winkelpagina van het account wordt gebruikt.Beschikbare opties: 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
vereist
Indeling die op de winkelpagina van het account wordt gebruikt.Beschikbare opties: featured, compact
string | null
vereist
Profielweergave die op de winkelpagina van het account wordt gebruikt.Beschikbare opties: personal, business
Of de winkelpagina van het account een Whop-affiliatelink toont.
string | null
vereist
Doelgroep voor dit account.
string[]
vereist
Codes van Amerikaanse staten (van de 50 staten plus DC) waar het account belasting int: de volledige set wanneer Whop afdraagt (tax_remitted_by whop), de geconfigureerde subset wanneer het account zelf afdraagt (self), en leeg wanneer geen van beide. Stuur bij een update de volledige lijst om deze te vervangen (alleen toegestaan bij self).
object[]
vereist
Belasting-/btw-registraties van het account. Leeg wanneer er geen zijn ingesteld.

Eigenschappen

string
vereist
ID van de belastingidentifier.
string
vereist
Type belasting-ID.Beschikbare opties: 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
vereist
Waarde van de belasting-ID, bijvoorbeeld DE123456789. Zie de gids voor belasting-ID’s.
string | null
vereist
Wie belasting berekent en afdraagt voor het account. whop betekent dat Whop berekent en afdraagt. self betekent dat Whop berekent, en dat het account int en afdraagt. none betekent geen van beide, en het account is verantwoordelijk. Nieuwe bedrijven beginnen op whop en nieuwe gekoppelde accounts beginnen op none. null betekent dat het account nog geen instelling heeft.Beschikbare opties: whop, self, none
string | null
vereist
Hoe belasting op de prijzen van het account wordt toegepast: inclusive (belasting inbegrepen in de vermelde prijs) of exclusive (belasting wordt erbovenop gerekend). Standaard exclusive wanneer niet ingesteld; alleen null wanneer het account geen betalingskoppeling heeft.Beschikbare opties: inclusive, exclusive
object | null
vereist
De servicevoorwaarden van het account, of null als het account er geen heeft gepubliceerd.

Eigenschappen

string
vereist
De ID van het bestand, met prefix file_.
string | null
vereist
BlurHash-placeholder voor een afbeelding of video. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
Het MIME-type van het oorspronkelijke bestand, bijvoorbeeld application/pdf. Dit blijft behouden wanneer moderatie het bestand verwijdert.
string
vereist
Wanneer het bestand is aangemaakt, als ISO 8601-tijdstempel.
number | null
vereist
Duur van audio of video in seconden. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
De oorspronkelijke bestandsnaam, inclusief extensie.
integer | null
vereist
Hoogte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
De grootte in bytes die elk deel (behalve het laatste) moet hebben. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
string | null
De ID van de multipart-upload, die wordt teruggegeven aan complete. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
object[] | null
De presigned URL voor elk deel. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.

Eigenschappen

integer
vereist
De index (beginnend bij 1) van dit deel binnen de multipart-upload.
string
vereist
De presigned URL waarnaar je de bytes van dit deel met PUT verstuurt.
string
vereist
Het type van dit object, altijd file.
boolean
vereist
Of moderatie het bestand heeft verwijderd. Wanneer true, levert url een vervangende afbeelding. filename, size en content_type beschrijven nog steeds het oorspronkelijke bestand.
integer | null
vereist
De bestandsgrootte in bytes. null totdat de upload is voltooid.
object
Headers die met de upload-PUT moeten worden meegestuurd. Alleen aanwezig bij aanmaken.
string
vereist
Waar het bestand zich in de uploadlevenscyclus bevindt.Beschikbare opties: pending, processing, ready, failed
string | null
Presigned URL waarnaar je de bytes van het bestand met PUT verstuurt. Alleen aanwezig bij aanmaken, en alleen voor uploads uit één deel.
string | null
vereist
Een URL om het bestand te downloaden. Openbare bestanden krijgen een permanente CDN-URL en privébestanden krijgen een ondertekende URL die verloopt. null totdat de upload is voltooid. Wanneer moderatie het bestand verwijdert, een URL van een vervangende afbeelding.
string
vereist
public-bestanden worden geleverd via een niet-ondertekende CDN-URL. private-bestanden worden geleverd via een ondertekende URL die verloopt.Beschikbare opties: public, private
string | null
vereist
URL van de audiogolfvorm. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
vereist
Breedte van de afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
3D Secure-gedrag voor ondersteunde on-session kaartbetalingen. mandate_challenge vereist een 3DS-challenge voordat de betaling wordt verwerkt; mandate_if_required vereist alleen een challenge wanneer de betalingsverwerker dat vereist; frictionless_if_required gebruikt de gewone frictieloze 3DS-flow. Betalingen van $1,000 of meer gebruiken mandate_if_required, tenzij mandate_challenge is geselecteerd. Vereisten voor risico en herstel van authenticatie kunnen de voorkeur overschrijven. null gebruikt de standaard checkout-flow.Beschikbare opties: mandate_challenge, mandate_if_required, frictionless_if_required
string
vereist
Weergavenaam van het account.
number | null
vereist
Totale verkopen van het account, genormaliseerd naar USD. Alleen berekend bij retrieve en me voor aanroepers met de scope stats:read; anders null.
string | null
vereist
Totale USD-waarde van de saldi met bekende wisselkoersen. Alleen berekend bij het lezen van een enkel account (retrieve en me); null bij list-responses, schrijfacties, ontbrekende leesrechten voor het saldo of een niet-beschikbare saldobron.
trading_account | null
vereist
Het adres van het handelsaccount, een momentopname van de margin en open posities, en de WebSocket-abonnementen. Schakel in met include_trading=true bij het lezen van een enkel account. Anders null, zonder handelsrechten, of zonder Ethereum-wallet.

Eigenschappen

string
vereist
De ID van de Whop-wallet achter dit handelsaccount, met prefix cwal_.
string | null
vereist
Het account dat eigenaar is van dit handelsaccount, met prefix biz_. null wanneer een gebruiker eigenaar is.
object | null
vereist
Hyperliquid-specifieke status. Aanwezig wanneer provider hyperliquid is, anders null.

Eigenschappen

string
vereist
Walletadres in kleine letters dat het Hyperliquid-account aanhoudt.
string | null
vereist
USDT0 in de Whop-wallet op Plasma dat een deposit-trade naar dit account kan verplaatsen, als decimale string. null wanneer de chain niet kon worden gelezen.
object | null
vereist
Accountwaarde en margin over de hoofdexchange en de xyz-markten, maximaal eens per seconde gelezen van Hyperliquid. null wanneer Hyperliquid niet kon worden gelezen. Gebruik websocket_subscriptions voor live updates.

Eigenschappen

object
vereist
Totale accountwaarde in USD, inclusief niet-gerealiseerde winst en verlies.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
Margin die over open posities is verdeeld, in USD.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
Gecombineerde nominale waarde van open posities, in USD.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
USD die nu kan worden opgenomen zonder posities te sluiten.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
trading_position[] | null
vereist
Open perpetual-posities over de hoofdexchange en de xyz-markten, maximaal eens per seconde gelezen van Hyperliquid. null wanneer Hyperliquid niet kon worden gelezen. Gebruik websocket_subscriptions voor live updates.

Eigenschappen

string
vereist
ID van de handelspositie, met prefix trdpos_. Stabiel voor een markt binnen één handelsaccount.
object | null
vereist
Gemiddelde instapprijs in USD, of null wanneer de provider deze weglaat.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object | null
vereist
Details van Hyperliquid-perpetuals. Aanwezig bij Hyperliquid-posities, anders null.

Eigenschappen

object
vereist
Funding die over meerdere periodes op de positie is betaald, in USD.

Eigenschappen

object | null
vereist
Funding die over de hele geschiedenis van het account op deze markt is betaald, in USD, of null wanneer niet beschikbaar.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object | null
vereist
Funding die is betaald sinds de positiegrootte voor het laatst is gewijzigd, in USD, of null wanneer niet beschikbaar.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object | null
vereist
Funding die is betaald sinds de positie is geopend, in USD, of null wanneer niet beschikbaar.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
Marginmodus en multiplier voor de positie.

Eigenschappen

string
vereist
cross deelt margin over posities. isolated beperkt de margin tot deze positie.Beschikbare opties: cross, isolated
integer
vereist
Multiplier die op de margin van de positie wordt toegepast, zoals 10 voor 10x.
object | null
vereist
Geschatte liquidatieprijs in USD, of null wanneer Hyperliquid er geen rapporteert.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
Margin die aan de positie is toegewezen, in USD.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string
vereist
Rendement op eigen vermogen als string met een decimale ratio, zoals 0.1 voor 10%.
string
vereist
Marktsymbool bij de provider, zoals ETH.
string
vereist
object
vereist
Huidige waarde van de positie in USD.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string
vereist
Beschikbare opties: long, short
string
vereist
Absolute positiegrootte als decimale string.
object
vereist
Niet-gerealiseerde winst of verlies in USD. Negatief bij een verlies.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object[]
vereist
Abonnementen voor live accountupdates. Stuur elk message ongewijzigd na het verbinden met websocket_url.

Eigenschappen

string
vereist
De live updatestream die dit abonnement opent.Beschikbare opties: clearinghouse_state, open_orders, order_updates, user_fills, user_events
string
vereist
JSON-abonnementsbericht om ongewijzigd via de Hyperliquid-WebSocket te versturen.
string
vereist
Hyperliquid-WebSocket-URL om rechtstreeks verbinding mee te maken voor live updates.
string
vereist
string
vereist
Handelsplatform dat de posities en orders aanhoudt.Beschikbare opties: hyperliquid
object | null
vereist
Spot-tegoeden in de Whop-wallet met hun instapprijs en winst en verlies. null wanneer deze niet konden worden gelezen.

Eigenschappen

object[]
vereist
Elk spot-asset dat de wallet nog aanhoudt, met de gemiddelde instapprijs en winst en verlies. De kostprijs telt de oudste eenheden als eerst verkocht en omvat assets die van buiten Whop zijn binnengekomen.

Eigenschappen

object | null
vereist
De gemiddelde prijs die per eenheid is betaald voor wat nog wordt aangehouden, in USD, waarbij de oudste eenheden als eerst verkocht worden geteld. null wanneer onbekend.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
Wat in USD is betaald voor de eenheden die nog worden aangehouden.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string
vereist
De id van de spotmarkt uit GET /trades/markets, zoals BTC, XAUT of de ticker van een getokeniseerd aandeel zoals AAPL.
object
vereist
Winsten en verliezen die al door verkoop zijn vastgelegd, in USD.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
De waarde van de eenheden die nog worden aangehouden minus hun cost_basis, in USD.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
number | null
vereist
unrealized_pnl als percentage van cost_basis, waarbij 2 een stijging van 2% betekent. null wanneer onbekend.
string | null
vereist
De gebruiker die eigenaar is van dit handelsaccount, met prefix user_. null wanneer een account eigenaar is.
boolean
vereist
Of het account het logo gebruikt als fallback voor de Open Graph-afbeelding.
object
vereist
Status van de identiteitsverificatie van het account voor de profielen individual (KYC) en business (KYB). Elk is null totdat het is aangemaakt, anders een status van not_started, pending, manual_review, approved of rejected.
number | null
vereist
Volume via het account in de afgelopen 30 dagen (GMV uit betaalde ontvangstbewijzen), genormaliseerd naar USD. Alleen berekend bij list voor aanroepers met stats:read op het account; anders null.
number | null
vereist
Totaal volume via het account — verkopen plus ontvangen overboekingen — genormaliseerd naar USD. Alleen berekend bij list voor aanroepers met stats:read op het account; anders null.
object | null
vereist
Primaire crypto-wallet van het account, of null als er nog geen is aangemaakt.

Eigenschappen

string
vereist
Wallet-ID, met prefix wallet_.
string
vereist
Het on-chain adres van de wallet
string
vereist
Het blockchainnetwerk waarop de wallet staatBeschikbare opties: solana, ethereum, bitcoin
string | null
vereist
De URL van de bedrijfswebsite van het account, of null als er geen is opgegeven. Als je deze instelt, wordt ook een website-item toegevoegd aan social_links.
string | null
Wanneer het account de Whop Partner-modus heeft ingeschakeld, als ISO 8601-tijdstempel. Aanwezig bij het lezen van een enkel account en in update-responses; null totdat het account de Whop Partner-modus inschakelt door whop_partner_enabled: true te sturen bij een update.
Account

Bedrijfstypen en branches

Drie velden classificeren accounts: business_type, industry_group en industry_type. De volledige taxonomie staat op een eigen pagina:

Bedrijfstypen en branches