Skip to main content
Current API er versioneret med datoer. Ændringer, der bryder kompatibiliteten, udgives kun i en ny dateret version, som du selv vælger at tage i brug. Fastlås en version, så ændres de anmodnings- og svarformer, du har bygget mod, aldrig. Officielle SDK’er sender automatisk den version, der blev brugt til at generere dem.
Hvis du ikke angiver en Api-Version-Date eller har en gemt fastlåsning på API-nøglen, bruges den stabile API-model. Anmodninger uden nogen af delene betjenes med adfærden fra før versioneringen, så eksisterende integrationer fortsætter uændret. Fastlås en dateret version for at tage det nyeste API i brug.

Versionsfastlåsning på API-nøgler

API-nøgler har deres egen fastlåste API-version. Anmodninger, der er autentificeret med en API-nøgle, bruger den fastlåsning, når de udelader Api-Version-Date. Eksisterende nøgler uden en gemt fastlåsning bruger 2025-01-01. Nyoprettede nøgler bruger den senest udgivne version. En eksplicit Api-Version-Date-header har altid forrang frem for API-nøglens fastlåsning, så du kan teste en opgradering, før du ændrer den gemte version. Alle versioner får automatisk nye endpoints og valgfrie felter. Ændringer, der bryder kompatibiliteten, skaber en ny dateret version, som ændringsloggen nedenfor viser. Når du opgraderer, skal du gennemgå hver post efter din nuværende fastlåsning og frem til din målversion, ikke kun poster fra målmåneden. Især krydser en opgradering fra 2026-07-20 til september migreringen af medlemmer og medlemskaber i 2026-07-23.

Ændringslog

TypeScript SDK-udgivelserne nedenfor bruger som standard API-versionen i den pågældende post. Tilsidesættelse af apiVersionDate ændrer svarversionen, men ikke SDK-typerne.
Latest
Et niveau beholder kun sit niveau og sine point
level på Retrieve user og Retrieve account har nu current, points, points_by_source og resets_at, plus account_level på en konto.Disse felter fjernes fra level: levels, points_to_next, monthly_qualifying_spend, monthly_card_spend, monthly_ads_spend og monthly_trading_volume. boosted fjernes fra en kontos level. En konto er boostet, når dens account_level er under current.
Et niveaus `applied_level` er nu `current`
level.applied_level omdøbes til level.current på Retrieve user og Retrieve account. Værdien er uændret: det niveau, der gælder, fra 0 op til 10.
Listen over henviste brugere holder op med at svare efter 17. november
GET /partners/referred_users holder op med at svare efter 17. november 2026. Fra 18. november returnerer alle versioner en 410. Indtil da har hvert svar Deprecation- og Sunset-headere. Listen har ingen erstatning.
Attributionsanmodninger til en bruger er ophørt
Partnere kan ikke længere sende en attributionsanmodning til en bruger. Det gælder alle API-versioner, ikke kun denne.Create a partner referral request afviser target_user_id, target_username og target_email med en 400, hvis code er user_referral_requests_retired. Send account_id eller account_url for at anmode om attribution for en virksomhed. Anmodninger, der blev sendt til en bruger, vises eller hentes ikke længere, filteret target_user_id på list partner referral requests returnerer ingen anmodninger, og user på en anmodning er altid null.
En brugers niveau er offentligt
Retrieve user returnerer level for enhver bruger, hvis konti er med i Whop Levels, ikke kun for dig selv. level.applied_level er brugerens niveau, fra 0 op til 10.De øvrige felter i level, såsom points, points_by_source, monthly_*-beløbene og levels, er null, medmindre du henter dig selv med det reserverede ID me og har scope til at læse saldo. Tjek dem for null, før du læser dem.
Vis og hent dine egne køb
Med en brugerlegitimation returnerer user_id=me på list payments dine egne betalinger. Det dækker dine køb fra alle konti og dine betalinger på konti, du sælger for. Tilføj account_id for en konto, du har købt fra, for kun at vise de køb. Retrieve payment returnerer en betaling, du har foretaget.Et køb viser det, du kan se som køber. Felter på kontosiden, såsom amount_after_fees, usd_total, holds og metadata, er null eller tomme på det. amount_charged angiver, hvad du blev opkrævet, inklusive købergebyrer.
Teammedlemmer har deres konto som et objekt
Teammedlemmer har ikke længere et account_id på øverste niveau. Læs konto-ID’et fra account.id. Objektet account har også kontoens title, route og logo_url.
Leads-API'et er udfaset
/leads-endpoints er udfaset og vises ikke længere i API-referencen. I denne version og senere returnerer de en 410. Tidligere versioner fortsætter med at virke indtil 20. november 2026 med Deprecation-, Sunset- og efterfølger-Link-headere. Efter den dato returnerer alle versioner en 410.Hvert lead er også medlem af sin virksomhed, med leadets ID i medlemmets metadata som lead_id. Brug List members i stedet for at vise leads. Tilføj et medlem via e-mail med Create member. Læs eller opdatér et med Retrieve member og Update member.
Listen over henviste brugere er udfaset
GET /partners/referred_users er udfaset og vises ikke længere i API-referencen. Det fortsætter med at svare for eksisterende integrationer, med en Deprecation-header på hvert svar, og har ingen erstatning.
Tilbagevendende fakturaer inkluderer det forudbetalte gebyr
Oprettelse af en faktura eller udskiftning af dens varer opkræver en tilbagevendende variants initial_price plus renewal_price på den første faktura. Fornyelsesfakturaer opkræver kun renewal_price. Redigering af andre felter bevarer fakturaens gemte priser.Betaling af den første faktura starter straks en betalt faktureringsperiode uden variantens prøveperiode. Et begrænset antal betalinger inkluderer den faktura: et forudbetalt gebyr på $75 med tre rater på $40 fakturerer $115, derefter $40 og så $40.
Det fornyende Economic Intelligence-tilbud er `3_days`
TypeScript SDK: @whop/sdk@2.8.0.Det fornyende tilbud i economic_intelligence_offers på Retrieve account preferences har nu nøglen 3_days. Det fornyes hver 3. dag. For at slå det til skal du sende economic_intelligence_duration_key: "3_days" til Update account preferences. Nøglen weekly afvises.
Annoncestatistik tager ikke længere `clicks`
Feltet clicks fjernes fra Create ad stats. En times clicks er annoncens sidevisninger registreret af Whop-pixlen, og en clicks-værdi sendt på en hvilken som helst version ignoreres.
Chat-API: kanaler, medlemmer og beskeder
Byg chat ind i din app. Kanaler dækker direkte beskeder, gruppechats, community-chats og supportchats. Kanalmedlemmer tilføjer og fjerner personer. Beskeder kan sendes, redigeres, fastgøres, reageres på og stemmes på./messages ændrer form fra denne version. En besked har channel_id og author i stedet for user, og edited og pinned i stedet for is_edited og is_pinned. Fastgør med POST /messages/{id}/pin og /unpin i stedet for en opdatering. Delete message returnerer 204. Reagér og stem med POST /messages/{id}/react, /unreact og /vote.
Hovedbogslinjetypen `bank_transfer` er udfaset
Iron-bankindbetalinger er ledger activity-linjer med line_type onchain_deposit, og deres source.sender_address er iron. Filteret line_types på finansiel aktivitet og finansielle rapporter accepterer ikke længere bank_transfer.
Udbetalingslister inkluderer Whop Card
List saved payout methods inkluderer kontoens Whop Card. List payouts inkluderer de udbetalinger, der flyttede midler over på det. En gemt udbetalingsmetode og payout_method på en udbetaling har en type. external sender midler ud af Whop. whop_card flytter midler over på kontoens eget Whop Card. Udelad whop_card-metoder i en liste, hvor en bruger vælger, hvor der skal hæves til.
En indsendelse til en tvist, der er undervejs, rapporterer `generating_response`
En tvist, hvis dokumentation ligger hos betalingsbehandleren og endnu ikke er accepteret, rapporterer generating_response i stedet for under_review. Når behandleren accepterer den, flytter tvisten til under_review. Når behandleren afviser den, vender tvisten tilbage til needs_response, og når du henter den, får du submission_failure_reason. Begge skift sendes som dispute.updated.
Whop Levels: det anvendte niveau er `applied_level`
På level for en bruger og en konto er current nu applied_level, og processing_rate_percentage er fjernet. Læs et niveaus standardprocent for kortbehandling fra dets post i levels, og en kontos egen sats fra Retrieve account fees. En kontos level tilføjer også account_level, det niveau, dens egne point når.
Annoncecertificeringer er fjernet
Whop tilbyder ikke længere annoncecertificeringer. Retrieve account preferences og Update account preferences returnerer ikke længere ads_certifications, og en opdatering accepterer det ikke længere.
Forbundne konti er nu underkonti
Platformens underordnede konti kaldes underkonti. På List payments og List disputes samt på deres opsummerings-endpoints er include_connected_accounts nu include_subaccounts. På Update account preferences er covers_connected_account_negative_balances nu covers_subaccount_negative_balances i både svaret og opdateringens body. Rækker i finansielle rapporter, der brugte grupperingen connected_accounts, bruger nu subaccounts.
Udbetalingsanmodninger kræver et tilbud
Create a payout kræver nu quote_token. Kald først POST /payouts/quotes, og indsend derefter dets token med de samme udbetalingsdetaljer, før tilbuddet udløber. Manglende eller ugyldige tilbud returnerer 400 med invalid_payout_quote. Når du prøver en usikker udbetaling igen, skal du sende det oprindelige token og Idempotency-Key igen, så den eksisterende udbetaling kan genfindes, selv efter at dens tilbud er udløbet.
En fakturas kunde kan ikke ændres, efter at kladden er oprettet
På Update invoice returnerer et member_id, der afviger fra kladdens nuværende kunde, en 400, inklusive null. For at fakturere en anden skal du først annullere kladden. Opret derefter en ny faktura. En kladde, der er gemt uden en kunde, kan stadig få en.
Snapchat-forbindelser er fjernet
Connect an External Account tager ikke længere snapchat, den sidste platform, der brugte scopet advertise, så dens felt scopes er også væk. Afsendelse af snapchat eller nogen scopes returnerer en 400.
Annoncekampagner dropper bid_type
Annoncekampagner tager og returnerer ikke længere bid_type. Hvert annoncenetværk vælger sin egen kampagnebudgivning, og desired_cost_per_result er dit mål på alle netværk: det ændrer aldrig, hvordan annoncer byder. Afsendelse af bid_type returnerer en 400.
Annonceforbindelser er fjernet
Annoncer kører under Whops egne sider og profiler, så du forbinder ikke længere konti til annoncering. Connect an External Account tager ikke længere meta_business, og tiktok tager ikke længere scopet advertise. Afsendelse af en af dem returnerer en 400.
Regler for konverteringsværdi er fjernet
Regler for konverteringsværdi er fjernet, og annoncenetværk modtager hver konverterings oprindelige værdi. Visning af regler for konverteringsværdi er udfaset: det returnerer en tom liste, det er ikke længere dokumenteret, og dets svar har en Deprecation-header. Alle andre endpoints for regler for konverteringsværdi returnerer en 410.
Målgrupper dropper engagementsregler, og regelmål dropper platform
Målgrupper kan ikke længere bygges ud fra socialt engagement. Eksisterende engagementsmålgrupper vises stadig med source_type engagement, men de returnerer ikke længere engagement. Afsendelse af engagement, eller engagement som source_type, til Create audience returnerer en 400. Mål for regler for konverteringsværdi tager og returnerer ikke længere platform. Hvert mål dækker alle netværk, Whop kører det på, og afsendelse af platform på et mål returnerer en 400.
Partnere for eksterne konti er udfaset
Partnerskabsannoncer er ikke længere tilgængelige. Visning af en ekstern kontos partnere returnerer en tom liste. Tilføjelse eller fjernelse af en partner returnerer en 400. Disse endpoints er ikke længere dokumenteret, og deres svar har en Deprecation-header.
Dubletter dropper preserve_engagement, og lister over opslag og leadformularer er udfaset
Duplikering af en annoncekampagne, annoncegruppe eller annonce tager ikke længere preserve_engagement. Afsendelse af det til Duplicate an Ad Campaign, Duplicate an Ad Group eller Duplicate an Ad returnerer en 400. Visning af en ekstern kontos opslag eller leadformularer er udfaset: begge returnerer en tom liste, de er ikke længere dokumenteret, og deres svar har en Deprecation-header.
Annoncer dropper post_id, og søgning i målretning er udfaset
Annoncer returnerer ikke længere post_id. Søgning i målretningsmuligheder for annoncegrupper og estimering af annoncegruppers rækkevidde er udfaset: begge fortsætter med at virke, men de er ikke længere dokumenteret, og deres svar har en Deprecation-header. Et mål for en regel for konverteringsværdi kan udelade platform for at dække alle netværk, Whop kører det på.
Annoncer dropper netværksspecifikke felter og målet awareness
Annoncekampagner, annoncegrupper og annoncer returnerer ikke længere platform, og Create an Ad Campaign tager det ikke længere. Nye kampagner kan ikke bruge målet awareness. Eksisterende awareness-kampagner returnerer det stadig. Annoncer tager og returnerer ikke længere existing_post_id, post_source, external_accounts eller translations og returnerer ikke længere post_thumbnail_url. Afsendelse af et fjernet felt, eller awareness som mål, til Create an Ad Campaign, Create ad eller Update ad returnerer en 400.
Annoncer dropper avancerede leverings- og kreativfelter
Annoncekampagner returnerer ikke længere optimization_goal. Annoncegrupper tager og returnerer ikke længere optimization_goal, conversion_location, message_apps, minimum_daily_spend, dynamic_creative, placements, frequency_cap eller detailed_targeting, og Whop indstiller levering ud fra kampagnens objective. Annoncer tager og returnerer ikke længere messaging_config, multi_advertiser_ads, lead_form, lead_form_id eller music. Afsendelse af et af disse til Create ad group, Update ad group, Create ad eller Update ad returnerer en 400, der navngiver feltet.
Kontoens variantlister udelader varianter fra ældre fakturaer
List variants med account_id udelader varianter, der er genereret til en ældre faktura, inklusive en, hvis faktura siden er slettet. For at læse en sådan skal du hente varianten ud fra ID. Den udfasede GET /plans-liste opfører sig på samme måde.
Swaps afviser et beløb over wallet-saldoen
På Create swap returnerer et decimal-amount over wallet’ens from_token-saldo en 400. Fejlen angiver den tilgængelige saldo. Tidligere versioner starter swappet, som derefter fejler on chain. Tjekket springes over, når saldoen ikke kan læses. USDT tjekkes ikke, da et USDT-swap også kan trække på kortsaldoen.
Alle andre ressourcer kalder varianter for varianter
Medlemskaber, medlemmer og ventelisteposter. På medlemskaber og ventelisteposter er plan_id nu variant_id, og på den variant, der er indlejret i en ventelistepost, er plan_type nu billing_type. Invite to a membership og Create waitlist entry tager variant_id, og Approve all waitlist entries tager og returnerer variant_id. List memberships filtrerer med variant_id og variant_ids, List members med variant_ids og List waitlist entries med variant_id i stedet for plan_id og plan_ids.Betalinger, fakturaer og tvister. På betalinger, tvister og sager i Resolution Center er plan_id nu variant_id, og på deres line_items er plan_id og plan_title nu variant_id og variant_title. På line_items for betalingstilbud og fakturaer er plan_id nu variant_id. List payments filtrerer med variant_ids i stedet for plan_ids. Create payment og Create payment quote tager variant_id og variant i stedet for plan_id og plan, i body’en og på hver post i line_items. Oprettelse og opdatering af en faktura tager variant_id og variant i stedet for plan_id og plan på hver post i items. En inline variant tager billing_type i stedet for plan_type. På hændelser er related.plan nu related.variant.Checkout. På checkout-konfigurationer er plan nu variant, og dens plan_type er nu billing_type. Create checkout configuration tager variant_id i stedet for plan_id og en inline variant (med billing_type) i stedet for plan, og List checkout configurations filtrerer med variant_id. Anmodninger og svar for checkout-sessioner bruger items[].variant i stedet for items[].plan.Rabatkoder og partnere. List promo codes filtrerer med variant_ids i stedet for plan_ids, og Create promo code tager variant_ids.
Produkter og varianter kalder varianter for varianter
På produkter er default_plan nu default_variant. På varianter og på de varianter, der er indlejret i et produkt, er plan_type nu billing_type. Create variant tager billing_type, og List variants og List products filtrerer med billing_types i stedet for plan_types.Brug /variants og SDK-navnerummet variants i stedet for /plans. /plans-endpoints svarer stadig på alle versioner, med Deprecation- og efterfølger-Link-headere. For at få vist moms på forhånd skal du oprette et betalingstilbud i stedet for at kalde POST /variants/{id}/calculate_tax eller POST /plans/{id}/calculate_tax, som er udfaset på samme måde.Variant-ID’er beholder præfikset plan_, og tilladelsesscopes plan:* og webhook-hændelsesnavne plan.* er uændrede.
Invitationer returnerer det ventende teammedlem
Når Create team member sender en invitation i stedet for at tilføje medlemmet, er 202-svaret nu det ventende teammedlem. Dets status er pending, og dets ID starter med ausri_. Svaret indeholder ikke længere object eller invitation_sent.
Kvitteringsbaserede fakturaer
Det native Invoices API bruger pay_-ID’er og variantbaserede items, inklusive inline oprettelse af varianter. Oprettelse gemmer en kladde. Du kan opdatere kladder og annullere en kladde, du ikke længere har brug for. Den fakturerede kunde er et medlem. En e-mail, der ikke tilhører en Whop-bruger, opretter en. recipient_emails er fakturaens egne leveringsadresser, adskilt fra det fakturerede medlem. Købergebyret er en justerbar procentsats.
Konti indeholder ikke længere stablecoin_rails
Konti indeholder ikke længere stablecoin_rails.
Typer af verifikationsdokumenter skrives med små bogstaver
På Create verification og på ejere i owners tager document_type værdier med små bogstaver: passport, id_card, drivers eller residence_permit. Guiden om identitetsdokumenter viser, hvilke hvert land accepterer.
Kortopkrævning ved indbetaling flyttet under methods
På Create deposit er opkrævningen af en gemt betalingsmetode flyttet fra card på øverste niveau til methods.card, ved siden af bank og crypto. Dens felter er uændrede, og den er stadig null, medmindre payment_method_id blev angivet. Kaldere, der er fastlåst til en tidligere version, beholder card på øverste niveau.
Domæner for betalingsmetoder er udfaset til fordel for domæner
Endpoints for domæner for betalingsmetoder er udfaset og vises ikke længere i API-referencen. Tilføj, tjek og fjern i stedet Apple Pay-domæner med apple_pay-funktionen i domains-API’et:
  • GET /payment_method_domains: GET /domains med apple_pay=any, eller apple_pay=ready for verificerede domæner. Filtrér efter værtsnavn med domain i stedet for hostname.
  • GET /payment_method_domains/{id}: GET /domains/{id}.
  • POST /payment_method_domains: POST /domains med domain, account_id og apple_pay: {}. Hvis kontoen allerede har domænet, så PATCH /domains/{id} med apple_pay: {}.
  • POST /payment_method_domains/{id}/verify: POST /domains/{id}/check.
  • DELETE /payment_method_domains/{id}: PATCH /domains/{id} med apple_pay: null. DELETE /domains/{id} fjerner hele domænet, inklusive ethvert website på det.
  • status: verified er apple_pay.state: ready. status: pending er apple_pay.state: pending, mens Whop registrerer domænet, eller action_required, indtil du hoster tilknytningsfilen og tjekker domænet.
Registreringen kører i baggrunden, så oprettelse eller tjek af et domæne returnerer pending. Hent domænet, indtil apple_pay.state er ready eller action_required./payment_method_domains-endpoints svarer stadig på alle versioner, med Deprecation- og efterfølger-Link-headere. Et domæne beholder sit ID, så /domains/{id} tager det ID, som et domæne for en betalingsmetode returnerede. Domains-API’et kræver tilladelserne domain:read og domain:manage i stedet for company:manage_checkout.
Native anmeldelser
TypeScript SDK: @whop/sdk@2.5.0.Anmeldelser bruger nu en native ressource.
  • Visning og hentning af anmeldelser returnerer kun offentliggjorte anmeldelser. Hentning af en ventende eller fjernet anmeldelse returnerer 404.
  • En hentet anmeldelse returnerer account i stedet for company.
  • Visning af anmeldelser filtrerer efter account_id eller product_id, sorterer med order og direction og returnerer som standard 20 anmeldelser pr. side. Uden et filter viser en bruger de anmeldelser, vedkommende har skrevet, og en konto- eller app-API-nøgle viser sin kontos anmeldelser.
  • company_id accepteres ikke længere. Brug account_id.
  • DELETE /reviews/{id} sletter en anmeldelse, som den indloggede bruger har skrevet, og kræver scopet review:delete.
Konti har ikke længere en branchegruppe, og kontoklassificering er skrivebeskyttet
Konti indeholder ikke længere industry_group, og PATCH /accounts/{id} accepterer det ikke længere. business_type og industry_type klassificerer en konto.Kontoklassificering er skrivebeskyttet. Whop indstiller business_type og industry_type, og PATCH /accounts/{id} accepterer dem ikke længere.
Apps viser ikke længere tidligere hostede URL'er
TypeScript SDK: @whop/sdk@2.4.0.Apps indeholder ikke længere previous_hosted_urls. En apps adresser er de domæner, der leverer den: vis dem med GET /domains, eller læs domains på appen.
Overførselsprofiler, beløb og oprettelsestyper
Overførsler returnerer origin- og destination-profiler med name og logo_url. Pengeobjekterne amount og fee indeholder modtagerens kredit og alle overførselsgebyrer. Svar indeholder også tilgængelige tidsstempler for fejl og en sporings-URL. Ukendte historiske beløb og overgangstidspunkter er null.Uden kontofiltre viser GET /transfers overførsler på tværs af kalderens tilladte konti og personlige wallet. Kontoafgrænsede legitimationsoplysninger forbliver begrænset til deres konto.POST /transfers kræver type, enten balance eller claim_link. Anmodninger uden den returnerer 400. Typen ledger omdøbes til balance, og wallet_send fjernes. Tidligere versioner accepterer ledger og wallet_send og opretter en balance-overførsel, når type udelades.
Generér en betalings kvittering som PDF
Betalinger indeholder ikke længere pdf_url. For at få en betalings kvittering som PDF skal du kalde POST /payments/{id}/generate_pdf. Det returnerer en url til at downloade filen og expires_at, hvornår linket holder op med at virke.
Ventende midler kan afvente en compliance-gennemgang
TypeScript SDK: @whop/sdk@2.3.0.En kontos payment_controls.undated_pending_reason kan være compliance_review. Det betyder, at en verifikation, som forhandleren allerede har indsendt, er under gennemgang, så ventende midler forbliver ventende, indtil den er godkendt. Kaldere, der er fastlåst tidligere, ser null for denne tilstand.
Economic Intelligence kan fornyes hver uge
economic_intelligence_offers indeholder et weekly-tilbud, der fornyes hver uge, indtil det slås fra. Hvert tilbud har auto_renew, og weekly er det anbefalede tilbud. For at slå det til skal du sende economic_intelligence_duration_key: "weekly" til PATCH /accounts/{account_id}/preferences.economic_intelligence_offers viser kun det, kontoen kan vælge nu. Det er ikke længere null, mens Economic Intelligence er slået til: i en bindende periode viser det kun weekly som en opgradering, og mens weekly fornyes, er det tomt. Tidligere versioner beholder null, mens Economic Intelligence er slået til, udelader weekly og anbefaler 1_day.
Betalinger med gemt kort er som standard med køber til stede
En opkrævning på en gemt betalingsmetode (member_id og payment_method_id) med en return_url behandler nu køberen som til stede. Det gælder, når du udelader off_session. Hvis udstederen beder køberen om at godkende, er betalingen requires_action med en next_action. Når du opkræver kortet uden køberen, såsom en fornyelse efter din egen tidsplan, skal du angive off_session: true.
Modtagere af regningsbetaling behøver ikke længere Whop-konti
Oprettelse af en udbetalingsmetode med recipient opretter en ikke-standard udbetalingskonto for modtageren, der er knyttet til afsenderens hovedbog. Den opretter ingen Whop-bruger, Whop-konto eller modtagerhovedbog. Modtagersvaret indeholder first_name, last_name og country. Det indeholder ikke længere user_id. Tidligere API-versioner udelader modtageroplysninger, når der ikke er nogen Whop-bruger. Tidligere versioner bevarer bruger-ID’et for eksisterende modtagere.
App-builds tager ikke længere en AI-prompt
Oprettelse af et app-build accepterer ikke længere ai_prompt_id.
En metriks tidsserie har sin egen sti
Hent en metriks tidsserie fra GET /stats/time_series/{metric}. GET /stats/{metric} leverer den stadig og angiver efterfølgeren i en Deprecation-header.
Sociale konti er eksterne konti
Sociale konti er nu eksterne konti. Brug /external_accounts og SDK-navnerummet externalAccounts. De tidligere /social_accounts-endpoints svarer stadig på alle versioner, med Deprecation- og efterfølger-Link-headere. ID’er for eksterne konti beholder deres sacc_-præfiks, og tilladelsesscopes social_account:* er uændrede.Annoncer kalder deres konti external_accounts i stedet for social_accounts i både anmodninger og svar. Engagementsregler for målgrupper kalder deres konto external_account_id i stedet for social_account_id. På /external_accounts er en Instagram-kontos ejende side parent_external_account i stedet for parent_social_account. Annonce-webhooks uden en fastlåst API-version modtager external_accounts.
Brugere indeholder ikke længere sociale konti
Brugere returnerer ikke længere social_accounts.
Setup intents gemmes i baggrunden
Oprettelse af et setup intent returnerer det nu som processing og gemmer betalingsmetoden i baggrunden. Oprettelse af en betaling fungerer allerede sådan. For at kende resultatet skal du polle setup intent’et eller sende dets client_secret til handleNextAction. Det ender med at blive gemt, afvist eller med at vente på et trin fra køberen. Tidligere versioner gemmer det fortsat under anmodningen.
Forhindrede tvister rapporterer prevented
TypeScript SDK: @whop/sdk@2.1.0, @whop/sdk@2.2.0.En tvist, hvor kunden fik pengene tilbage før nogen afgørelse, har nu status: prevented i stedet for closed. Refusionen kom fra kortnetværket (Visa RDR) eller fra en tidligere refusion.
Economic Intelligence-kørsler har deres egne statusser
En anbefaling, som Whop AI er i gang med at udføre, har status: running. Når kørslen slutter, bliver den executed, eller incomplete, hvis den sluttede uden at udføre anbefalingen. Tidligere versioner viser en kørende anbefaling som ready og en ufuldstændig som superseded.Anbefalinger returnerer også run_started_at, run_ended_at, run_by_user_id, result_url og acknowledged_at. For selv at køre en anbefaling skal du sende status: running til PATCH /economic_intelligence/{id} og derefter status: executed (med en valgfri result_url) eller status: incomplete. Send status: acknowledged for at markere en udført kørsel som set. Anbefalingen forbliver executed og registrerer acknowledged_at.
Varigheder for Economic Intelligence vælges ud fra nøgle
For at slå Economic Intelligence til skal du sende economic_intelligence_duration_key til PATCH /accounts/{account_id}/preferences i stedet for economic_intelligence_duration_days. Brug key fra en post i economic_intelligence_offers.Hver post i economic_intelligence_offers har key, duration og duration_unit i stedet for duration_days. En varighed kan tælles i hours eller days.
Annoncetekst er sprogmærket, og Meta-annoncer kan køre på andre sprog
En annonces primary_texts, headlines og descriptions er arrays af { language, text }-objekter i anmodninger og svar. På en annonce uden oversættelser skal du udelade language. API’et afviser almindelige strenge, så send i stedet [{ "text": "…" }].En Meta-annonce kan også køre på andre sprog. Sæt translations: { source_language, automatic_languages } til sproget i annoncens egen tekst og de sprog, Meta automatisk oversætter til. Hver tekst- og creatives-post på den annonce angiver derefter sit language. Annoncens egen tekst og kreativ bruger source_language, og hvert sprog, du selv skriver, får en primary_texts- og en headlines-post plus valgfrie descriptions- og creatives-poster. translations: null slår de andre sprog fra.Tidligere API-versioner kan ikke opdatere en annonce, der har oversættelser. De får en 400, der angiver denne version.
Economic Intelligence slås til for en valgt varighed
For at slå Economic Intelligence til skal du sende economic_intelligence_duration_days til PATCH /accounts/{account_id}/preferences. Vælg en varighed fra economic_intelligence_offers, som viser gebyret for hver varighed. Economic Intelligence kan ikke ændres eller slås fra før economic_intelligence_ends_at, og det slås automatisk fra på det tidspunkt.economic_intelligence er skrivebeskyttet. Afsendelse af det returnerer en 400-fejl.
Handelsadgang vises i tilladelsestjek
TypeScript SDK: @whop/sdk@2.0.0.GET /permissions inkluderer crypto_wallet:trade og crypto_wallet:trade:read, når der vises eller tjekkes tilladelseshandlinger for en konto.
Beskrivelser af Economic Intelligence-operationer
Economic Intelligence-anbefalinger returnerer expected_tool_calls som et ordnet array af objekter med tool_name og description. Beskrivelser identificerer den planlagte handling og den berørte ressource. Ældre anbefalinger har en null-beskrivelse.
Partnerhenvisningslinks bruger én anmodningstype
Partnerhenvisningsanmodninger bruger request_type: "link" til links med eller uden belønninger. Brug link, når du opretter eller filtrerer links. Kun autoriserede medarbejdere kan konfigurere belønninger.
Kontobelønninger viser fremskridt for partnerbelønninger
Retrieve Account returnerer milepæle for partnerbelønninger i rewards. Hver milepæl indeholder kvalifikationsfremskridt og udbetalingsstatus for den konto. Feltet indeholder et tomt array, når der ikke er nogen matchende belønninger, eller kalderen mangler læseadgang til saldo eller statistik.Det ældre format for onboarding-belønninger er udfaset. Tidligere API-versioner udelader rewards fra kontosvar.
Setup intents bliver en native ressource
Det native Payments API leverer nu POST /setup_intents, GET /setup_intents og GET /setup_intents/{id}. Setup Intent-objektet får samme form som alle andre native ressourcer.
  • Relaterede poster er fremmednøgle-ID’er i stedet for indlejrede objekter: account_id (var company), member_id (var member), payment_method_id (var payment_method) og checkout_configuration_id (var checkout_configuration). Køberen er et user-resumé (id, username, name, profile_picture).
  • error_message flytter ind i last_setup_error, den samme { code, message }-blok, som Retrieve setup status returnerer. Den forbliver null, indtil noget fejler, og forsvinder, når opsætningen lykkes.
  • return_url, payment_method_type og updated_at er nye. created_at og updated_at er ISO 8601-tidsstempler.
  • payment_instrument, den visningsformede metode, som Payment-objektet allerede har, findes også på Setup Intent, så et gemt kort kan vises uden en ekstra anmodning. Dets card får exp_month og exp_year på begge ressourcer. card.brand kan være null: et gemt kort, hvis netværk vault’en ikke registrerede, beholder sine sidste fire cifre og udløbsdato i stedet for at miste hele card-objektet.
  • Oprettelse af et setup intent svarer 201 Created (var 200), respekterer Idempotency-Key og kræver præcis én af confirmation_token eller payment_method_id. Et bekræftelsestoken fra en anden konto giver 404.
  • client_secret returneres ved oprettelse og hentning og kun for opsætninger, der er oprettet via dette API. Det kræver en kalder, der må handle på opsætningen: kontoens payment:charge-legitimation eller køberens eget token. Listerækker har altid null.
  • Webhooks for setup_intent.requires_action, setup_intent.succeeded og setup_intent.canceled, der er fastlåst til denne version eller senere, leverer det samme Setup Intent-objekt som deres data. Webhooks, der er fastlåst tidligere, og webhooks uden fastlåsning beholder det tidligere payload.
  • GET /setup_intents viser med den almindelige { data, page_info }-indpakning og cursor-paginering. account_id er valgfri: en konto-API-nøgle viser sin egen konto, og et brugertoken viser alle konti, det kan læse. status er et nyt filter, og en ugyldig værdi giver 400. created_before og created_after virker som før.
Nye forsøg på annoncebetalinger bruger konto-endpointet
POST /ad_campaigns/{id}/retry_payment returnerer 410 Gone. Brug POST /accounts/{id}/retry_ads_payment med kontoens biz_-ID for at sætte ét nyt betalingsforsøg i kø for alle dens kampagner. Et accepteret nyt forsøg bekræfter ikke, at betalingen lykkedes. Tjek kampagnens delivery_status og issues for resultatet.
Tre forskellige 3D Secure-politikker
TypeScript SDK: @whop/sdk@1.1.5.Konti, varianter, checkout-konfigurationer og checkout-sessioner eksponerer tre 3D Secure-valg:
  • mandate_challenge anmoder om en udfordring, før en understøttet kortbetaling med køber til stede behandles.
  • 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 mindst mandate_if_required. Krav til risiko og gendannelse af godkendelse kan tilsidesætte præferencen. Eksplicitte obligatoriske udfordringer afvises, indtil de er aktiveret på platformen.Ældre API-versioner beholder deres eksisterende værdier: nye mandate_challenge-valg forbliver betingede, eksisterende obligatoriske præferencer bevares, og frictionless forbliver frictionless. Konti på ældre versioner repræsenterer frictionless som null.
Handelsoverførsler har særskilte kategorier i finansielle rapporter
Rækker i finansielle rapporter adskiller trading_account_deposit, trading_account_withdrawal og deres _offset-poster fra andre on-chain-overførsler. Beløb og saldi er uændrede.Tidligere versioner beholder de eksisterende kategorier: topup for kontoindbetalinger og onchain_withdrawal for kontohævninger. Globale rapporter bruger de tilsvarende kategorier onchain_deposit, onchain_withdrawal og _offset. Matchende rækker kombineres uden at miste overførte beløb.
Triple Whale-status omdøbt for white-label-forhandlere
Kontopræferencernes ads_triple_whale_integration.status rapporterer requires_shop_domain i stedet for requires_shopify_store. Et shop_domain kan nu angives eksplicit på integrationen, så en forbundet Shopify-butik ikke længere er den eneste måde at levere et på.
Virksomhedskategorier kommer fra én tabel
TypeScript SDK: @whop/sdk@1.1.4.Kontoens business_type, industry_group og industry_type er strenge hentet fra Whops tabel over virksomhedskategorier i stedet for faste enums. Nye kategorier dukker op uden en ny API-version. Ordlisten over virksomhedstyper og brancher viser de aktuelle værdier.
  • coaching_and_courses er nu education, physical_product er nu ecommerce, og marketplace er nu platform.
  • Branchegrupper og -typer blev omorganiseret under de otte virksomhedstyper. PATCH /accounts/{id} accepterer kun slugs fra ordlisten. Ukendte værdier returnerer 400.
Fastlåste kaldere på en tidligere version modtager stadig de tidligere navne på virksomhedstyper, og branchenværdier, der ikke fandtes før denne version, returneres som null.
Kontoejede eksperimenter
Oprettelse af et eksperiment kræver et ejende account_id med præfikset biz_. Eksperimenter accepterer også valgfrie ressourcereferencer og flagnøgler, der er lokale for kontoen. Visning returnerer eksperimenter for én konto, og læsning eller administration af dem kræver kontotilladelser. Kontoeksperimenter understøtter ikke team-tags og opretter ikke en rapporteringsudbyder.Evaluering identificerer subjektet via subject[account_id], subject[anonymous_id] og subject[user_id]. Kaldere på ældre versioner beholder deres eksisterende identitetsparametre til evaluering. Angiv målretnings-properties som en JSON-forespørgselsværdi. Eksisterende indlejrede forespørgselsnøgler for egenskaber understøttes fortsat. Eksponering accepterer valgfri legitimationsoplysninger og registrerer deres identitet på hændelsen.
Navngivne Whop-tilbageholdelser af hævninger på ventende midler
TypeScript SDK: @whop/sdk@1.1.3.Kontoens payment_controls.undated_pending_reason kan være withdrawals_disabled, når Whop har blokeret hævninger, så de ventende midler ikke kan blive tilgængelige.kyc_incomplete, pending_information_request og null for midler, der stadig er under clearing, er uændrede.
Engagementskilder for målgrupper
POST /audiences understøtter engagement med videoer, leadformularer, Instagram-profiler og Facebook-sider via en typet engagement-definition.
  • Eksplicitte source_type-værdier validerer, at de påkrævede kildefelter er til stede, og at modstridende kildefelter er fraværende.
  • Målgruppesvar indeholder engagement, og source_type kan være engagement. Engagementsmålgrupper kan også bruges som kilder til lookalikes.
  • GET /social_accounts/{id}/posts indeholder video_id og caption for at hjælpe med at vælge videoer uden manuelt at finde deres platformsidentifikatorer.
Afslutning af et eksperiment kræver resultater
POST /experiments/{id}/end kræver findings i anmodningens body – en kort forklaring af, hvad man lærte, og hvorfor eksperimentet endte, som det gjorde.Fastlåste kaldere på en tidligere version må stadig udelade det. En pladsholderværdi for resultater registreres på deres vegne i stedet for en 400.
Destinationer for indbetalinger er et konto-ID
TypeScript SDK: @whop/sdk@1.1.1, @whop/sdk@1.1.2.POST /deposits tager en destination-streng med et konto-ID – biz_… eller user_… – og intet andet.
  • Rå wallet-adresser accepteres ikke længere. Fyld en konto op, og læs dens adresser fra methods.crypto.
  • Objektformen af destination ({ account_id } / { address, network }) er fjernet. Send konto-ID’et alene.
  • Tilsidesættelsen network på øverste niveau er fjernet. Den ændrede aldrig svaret: hver indbetaling returnerer allerede en adresse for hvert understøttet netværk, så vælg den, du vil have, fra methods.crypto.
  • metadata er fjernet fra både anmodningen og svaret. Det blev sendt tilbage og aldrig gemt, så det kunne ikke bruges til at afstemme en senere indbetaling.
  • account_id i svaret er ikke længere null, fordi hver destination nu angiver en konto.
Fastlåste kaldere på en tidligere version bliver ved med at sende objektformen og de fjernede input, og deres svar har stadig metadata – som et tomt objekt i stedet for den værdi, de sendte. En wallet-adresse afvises på alle versioner: den identificerede aldrig en konto, så der er ingen ældre form at blive ved med at levere. metadata sendt med et payment_method_id bevares på alle versioner, fordi det er knyttet til kortopkrævningen.
Betalinger bliver en native ressource
TypeScript SDK: @whop/sdk@1.1.0.POST /payments, GET /payments og GET /payments/{id} leveres nu af det native Payments API, og Payment-objektet får samme form som alle andre native ressourcer.
  • Relaterede poster er fremmednøgle-ID’er i stedet for indlejrede objekter: account_id (var company), plan_id, product_id, membership_id, member_id, promo_code_id, shipment_id, payment_method_id. Køberen er et user-resumé (id, username, name, profile_picture).
  • Beløb er pengeobjekter ({ amount, currency, decimals, display_decimals }) i stedet for rene tal: total, subtotal, tax_amount, refunded_amount, tax_refunded_amount, amount_after_fees, usd_total. settlement_amount, settlement_currency og settlement_exchange_rate er lagt ind i total og currency. refunded_amount og tax_refunded_amount angives, som de blev afregnet, til den kurs, der gjaldt, da hver refusion blev udstedt, og tax_refunded_amount findes nu i listesvar såvel som ved hentning.
  • Tvister, refusioner og sager i Resolution Center er ikke længere indlejret – vis dem fra deres egne endpoints med ?payment_id=. Indlejrede finansieringstransaktioner og applikationsgebyret overføres ikke til den native form.
  • last_payment_attempt / next_payment_attempt er last_payment_attempt_at / next_payment_attempt_at. Kortoplysninger findes på payment_instrument.
  • Oprettelse af en betaling tager account_id (var company_id), svarer 201 Created, respekterer Idempotency-Key og accepterer capture: false for at foretage en autorisationsreservation.
  • Native læsninger af betalinger er kontoafgrænsede: legitimationen skal kunne læse kontoens betalinger (et teammedlems token eller kontoens API-nøgle). En købers eget brugertoken, som de fastlåste proxyversioner accepterer til at læse vedkommendes egen betaling, leveres endnu ikke native – købere fortsætter med at arbejde på deres fastlåste version.
  • GET /payments/{id}/fees-rækker er { type, origin, label, description, amount, settlement_amount, collected_at } med pengeobjekter (var name/amount/currency/type).
  • GET /refunds og GET /refunds/{id} returnerer den native Refund: payment_id og account_id i stedet for en indlejret betaling, amount som et pengeobjekt i betalingens afregningsvaluta, original_amount i behandlerens valuta. Filteret company_id er account_id, og afsendelse af company_id giver en 400.
  • POST /payments/{id}/refund, POST /payments/{id}/retry og POST /payments/{id}/void er også native og returnerer det samme Payment-objekt. Refusion tager stadig et valgfrit partial_amount.
  • GET /payments viser med den almindelige { data, page_info }-indpakning og cursor-paginering. Filtre er lighedsparametre i ental (status, billing_reason, currency, plan_id, product_id, membership_id, member_id, user_id, account_id) i stedet for proxyens arrays i flertal. Som på proxyen matcher billing_reason=subscription_cycle også fornyelser, der er registreret som subscription_update. Betalinger på nul indgår, så proxyens include_free er væk. En ugyldig status giver en 400, ligesom ethvert filter, der kun findes på proxyen (substatuses, updated_before/updated_after, checkout_configuration_ids, arrays i flertal), i stedet for en ufiltreret side. Købersøgningen query virker som før. Vinduet created_before/created_after dækker kun betalingens oprettelsestidspunkt. Proxyen filtrerede på betalingstidspunktet, hvor et sådant fandtes. På listerækker er settlement_time_at null – hent betalingen for at få det.
Ældre endpoint til annoncerapporter udfaset
Det ældre GET /ad_reports-endpoint er udfaset til fordel for de native Stats-metrikker og annonceenheds-endpoints. Det leveres ikke længere i denne version.
  • GET /ad_reports returnerer 410 Gone med en error.type på gone. Brug GET /stats/time_series/ad_delivery for spend, impressions og clicks over tid, afgrænset med en source-sti såsom whop:adcamp_xxx:*. Brug GET /stats/time_series/events for attribuerede konverteringer.
  • Performance pr. enhed for et vindue findes på enheds-endpoints. GET /ad_campaigns, GET /ad_groups og GET /ads accepterer stats_from og stats_to og returnerer spend, results og return_on_ad_spend på hver række.
  • Hvert svar fra det ældre endpoint, på alle versioner, har nu Deprecation- og Link: <…/stats/ad_delivery>; rel="successor-version"-headere. Anmodninger, der er fastlåst til tidligere versioner, og anmodninger uden en version fortsætter uændret, indtil en Sunset-header annoncerer datoen, hvor det holder op med at svare for alle versioner.
Tidsstempelintervaller for finansielle rapporter
GET /financial_reports og GET /financial_reports/breakdown bruger nu ISO 8601-tidsstemplerne from og to til rapportvinduer.
  • from_date og to_date omdøbes til from og to.
  • Rene datoer accepteres ikke længere. Medtag et klokkeslæt og en tidszoneforskydning i begge tidsstempler.
Eksplicit filtrering på app-verifikation
GET /apps bruger nu verified som et valgfrit lighedsfilter i stedet for at behandle dets fravær som verified=false for offentlige websitelister.
  • Udelad verified for at returnere offentligt synlige website-blueprints fra begge verifikationstilstande.
  • Sæt verified=true for Whop-verificerede blueprints eller verified=false for community-blueprints.
  • recommended=true filtrerer anbefalede apps uafhængigt af verifikationsstatus.
Ældre endpoints til hævninger udfaset
De ældre /withdrawals-endpoints er udfaset til fordel for det native Payouts-API og leveres ikke længere i denne version.
  • GET /withdrawals og POST /withdrawals returnerer 410 Gone med en error.type på gone. Brug i stedet GET /payouts og POST /payouts. Udbetalings-ID’er er de samme wdrl_-ID’er, så eksisterende identifikatorer kan fortsat slås op.
  • GET /withdrawals/{id} svarer stadig i denne version. Brug GET /payouts/{id} til nyt arbejde.
  • Hvert svar fra de ældre endpoints, på alle versioner, har nu Deprecation- og Link: <…/payouts>; rel="successor-version"-headere. En Sunset-header vil annoncere datoen, hvor de holder op med at svare for alle versioner. Indtil da fortsætter anmodninger, der er fastlåst til tidligere versioner, og anmodninger uden en version uændret.
Opslags-ID'er for annoncer
En annonces post_id angiver nu det opslag, som annoncenetværket leverer, uanset hvordan annoncen blev bygget.
  • post_id returnerer netværkets opslag for annoncen – det, Meta oprettede for en uploadet kreativ, eller det opslag, der promoveres. Det plejede at være null for alle annoncer bygget ud fra uploadede kreativer.
  • Det opslag, du peger en annonce på, er flyttet til existing_post_id, i både svaret og body’en ved oprettelse/opdatering. post_source og post_thumbnail_url beskriver det felt.
Native Files API
TypeScript SDK: @whop/sdk@1.0.14.POST /files og GET /files/{id} leveres native med et redesignet filobjekt, og multipart-uploads afsluttes via det nye POST /files/{id}/complete.
  • Filsvar har den almindelige indpakning: object, visibility og en ISO 8601-created_at. Felterne size og url er null, indtil uploadet er ready.
  • GET /files/{id} slår kun filer op, som du har oprettet – andre kaldere modtager en 404.
Udbetalingsstatus v2
TypeScript SDK: @whop/sdk@1.0.13.Udbetalingsobjektets livscyklusordforråd er bygget om, og dets pengefelter bliver decimalstrenge.
  • status bruger otte ord: requested, in_review, processing, completed, reversed, canceled, failed, denied. En afregnet udbetaling, som udbyderen tilbagefører, vises som reversed, med returkoden og funds_returned_at i failure.
  • Et nyt felt, status_detail, indeholder den mest detaljerede maskinfase under statusordet. Dets værdier kan udvides uden en ny version – status er den versionerede kontrakt.
  • amount, fee_amount, net_amount, markup_fee og destination_amount er decimalstrenge. exchange_rate forbliver et tal.
  • Udbetalinger oprettes under deres wdrl_-ID: det ID, POST /payouts returnerer, er det ID, GET /payouts viser, og en udbetalings konverteringsanmodning bevares som payout_request_id. Konverteringsanmodninger oprettet før denne version svarer fortsat under deres cofr_-ID.
  • Idempotensnøglen sendes kun i headeren Idempotency-Key, og body-feltet idempotency_key afvises.
Anmodninger, der er fastlåst til tidligere versioner, beholder det tidligere ordforråd, beløb som flydende tal og idempotensnøgler i body-feltet. Webhook-payloads følger abonnementets api_version_date på samme måde: abonnementer, der er fastlåst til 2026-08-21 eller senere, modtager den nye udbetalingsform, mens tidligere eller ikke-fastlåste abonnementer beholder den tidligere.
account_id i webhook-indpakningen
Webhook-indpakningens felt company_id omdøbes til account_id.
  • Webhook-leveringer, der er fastlåst til 2026-08-14 eller senere, har account_id i indpakningen.
  • Webhooks, der er fastlåst til tidligere versioner – og webhooks uden en api_version_date-fastlåsning – beholder company_id.
Opdeling af saldo under overførsel
TypeScript SDK: @whop/sdk@1.0.11.Opdelinger af konto- og personlige saldi eksponerer nu in_transit ved siden af pending.
  • Læg pending og in_transit sammen for at vise det samlede beløb, der afventer afregning.
  • Kaldere, der er fastlåst til tidligere versioner, modtager fortsat det kombinerede beløb i pending.
Input for webhook-API-version fjernet
Inputtet api_version på POST /webhooks og PATCH /webhooks/{id} er fjernet.
  • Nye webhooks bruger altid v1-hændelser og -payloads. Anmodninger, der angiver api_version, afvises med en 400.
  • Fastlås i stedet en webhooks payload-form med api_version_date.
  • Eksisterende v2- og v5-webhooks fortsætter med at levere. Du kan ikke længere oprette eller skifte webhooks til disse versioner.
Native endpoints for tvistadvarsler
Tvistadvarsler er nu en native REST-ressource og leveres fortsat parallelt med den ældre proxy.
  • GET /dispute_alerts viser en kontos advarsler med cursor-paginering og filtrerer efter account_id, payment_id, type og et oprettelsesvindue.
  • type erstatter alert_type og angiver de to slags, en udsteder sender: early_fraud_warning (Visa TC40 / Mastercard SAFE-svindelrapporter) og dispute_alert (meddelelser forud for en tvist).
  • fee_charged erstatter charge_for_alert og rapporterer, om Whop faktisk fakturerede kontoen. Tidlige svindeladvarsler faktureres aldrig.
  • actionable rapporterer, om refusion af betalingen stadig kan forhindre en chargeback.
  • Objekterne payment og dispute erstattes af tagsene payment_id og account_id. Tidsstempler er ISO 8601, med reported_at for hvornår udstederen indgav rapporten.
Valutaomregning af fiat ved swaps
Swaps mellem fiat-par (POST /swaps med to fiat-valutaer) understøtter nu fri valutaomregning, og amount følger semantikken for kryptoswaps.
  • amount er det beløb i from_token, der skal omregnes til midtkurs. Der kræves ingen negativ saldo.
  • Fastsættelse af en delvis tilbagebetaling af en negativ to_token-saldo er flyttet til det nye felt to_amount (angivet i to_token, begrænset til gælden). amount og to_amount udelukker hinanden.
  • Udeladelse af begge tilbagebetaler stadig hele den negative to_token-saldo.
  • Kaldere, der er fastlåst til tidligere versioner, beholder den tidligere adfærd: deres fiat-amount behandles som tilbagebetalingsbeløbet i to_token.
Flade verifikationskrav
En verifikations requested_information er nu en flad liste: ét krav pr. post, én skrivning pr. svar.
  • Hver post angiver, hvad der kræves, i requirement: et dokument såsom bank_statement eller en feltnøgle såsom ssn, med en label, der skal vises for brugeren.
  • Besvar file-poster med file (et direkte upload-ID). Besvar text-, date-, phone- og select-poster med value og address-poster med address. Intet fra svaret sendes tilbage.
  • En post markeret multiple tager flere filer i ét svar, i pladsrækkefølge, forsiden først for et dobbeltsidet dokument.
  • En post, der viser options, tager også en value. For select-poster er mulighederne de tilladte svar. For identitetsdokumenter er mulighederne de accepterede ID-typer.
  • Nøgler, der ikke er relevante, udelades, og afviste indsendelser har strukturerede errors med en stabil code og en reason.
  • Den indlejrede formularform requested_files/category er væk fra denne version. Kaldere, der er fastlåst til tidligere versioner, beholder den, og deres svar oversættes automatisk.
Native endpoints for rabatkoder
Rabatkoder er nu en komplet REST-ressource på øverste niveau og leveres fortsat parallelt med den ældre proxy.
  • GET /promo_codes viser en kontos rabatkoder og bruger account_id i stedet for company_id.
  • POST /promo_codes opretter rabatkoder. GET og DELETE /promo_codes/{id} henter og arkiverer dem.
  • POST /promo_codes/{id}/activate og POST /promo_codes/{id}/deactivate erstatter den ældre PATCH-statusskrivning.
  • Listesvar bruger cursor-paginering og understøtter filtre for status, produkt, variant, tidsstempel og sortering.
  • Kaldere, der er fastlåst til tidligere versioner, beholder den ældre proxykontrakt uændret.
Mere detaljerede overordnede konti
Kontosvar eksponerer nu en mere detaljeret relation til den overordnede konto for forbundne konti.
  • parent_account erstatter parent_account_id.
  • Den overordnede konto indeholder sit id, title, route og logo_url.
Understøttede udbetalingsmetoder
Understøttede udbetalingsmetoder har nu deres eget paginerede endpoint.
  • GET /payouts/supported_methods viser de udbetalingsmetoder, en konto eller bruger er berettiget til at tilføje.
  • Understøttede metoder bruger object: "supported_payout_method", og deres podst_-ID’er angives som supported_payout_method_id.
  • Gemte udbetalingsmetoder eksponerer supported_payout_method. Udbetalinger eksponerer payout_method.supported_payout_method.
  • Brug country til at vise understøttede metoder for et andet land end udbetalingskontoens land.
  • GET /payouts/methods accepterer ikke længere include_available og returnerer ikke længere available_destinations.
  • Kaldere, der er fastlåst til tidligere versioner, beholder destination_id, payout_destination og payout_token.
Native korttransaktioner, estimater for ankomst for udbetalingsmetoder
Korttransaktioner bruger nu native REST-endpoints og leveres fortsat parallelt med den ældre proxy.
  • GET /card_transactions viser en kontos korttransaktioner, og GET /card_transactions/{id} henter én ud fra dens citx_-ID. Listen tager også et transaction_ids-filter til at hente bestemte transaktioner i én anmodning.
  • Korttransaktioner er kontoafgrænsede: ejeren vælges med account_id, som standard den konto, legitimationen tilhører.
  • Filtre på transaction_ids, card_id, cardholder_id, status, created_after og created_before. Tidsstempelfiltre er ISO 8601.
  • cardholder_id er nyt i svaret: den bruger, kortet er tildelt.
Udbetalingsmetoder har nu gebyr- og leveringsvilkår, der er uafhængige af beløbet, og tilbuddet duplikerer ikke længere ankomstestimater.
  • Hver udbetalingsmetode returnerer fee_structure (procentsats, fast beløb og valuta) og estimated_arrival (tidsstempler pr. hastighed) uden at kræve et amount.
  • Tilbuddets standard- og instant-objekter indeholder ikke længere estimated_arrival. Læs det fra metodens felt estimated_arrival på øverste niveau.
Native endpoints for Resolution Center
Sager i Resolution Center bruger nu native REST-endpoints og leveres fortsat parallelt med den ældre proxy.
  • status, escalated, outcome, refund, reason og available_actions eksponerer sagens tilstand og tilladte handlinger.
  • Hændelser er tilgængelige fra det paginerede GET /resolution_center_cases/{id}/events. Resuméer er tilgængelige fra GET /resolution_center_cases/summary.
  • Skrivninger bruger message og attachments. due_date omdøbes til response_due_at. Visning kræver ikke længere account_id.
Native endpoints for forsendelser
Forsendelser bruger nu native REST-endpoints og leveres fortsat parallelt med den ældre proxy.
  • GET /shipments viser forsendelser. GET /shipments/{id} henter ud fra forsendelses-ID eller betalings-ID.
  • POST /shipments opretter en forsendelse, og PATCH /shipments/{id} opdaterer dens sporingsnummer.
  • Svar bruger account_id og tracking_number sammen med carrier, tracking_url, order_id og payment_id.
  • Kaldere, der er fastlåst før denne dato, beholder den ældre proxykontrakt uændret.
Native endpoints for tvister
Tvister bruger nu native REST-endpoints og leveres fortsat parallelt med den ældre proxy.
  • PATCH /disputes/{id} redigerer dokumentation, og POST /disputes/{id}/submit indsender den. Dokumentation er indlejret under evidence.
  • GET /disputes/summary giver totaler grupperet efter status og currency. Visning og hentning returnerer de samme felter.
  • Svar bruger account_id, product_id og plan_id plus buyer ved siden af payment. Visning kræver ikke længere account_id.
  • status og reason er normaliserede enums, og needs_response_by, rdr og editable erstattes af deres nye felter.
  • Kaldere, der er fastlåst før denne dato, beholder den ældre proxykontrakt uændret.
Medlemmer og medlemskaber
Medlemmer og medlemskaber bruger nu native ressourcer med en kontoorienteret medlemskabsmodel og redesignede livscyklushandlinger.
  • Medlemskabssvar returnerer kompatibilitetsfelterne plan_id og product_id i stedet for de indlejrede kompatibilitetsobjekter plan og product.
  • Visning af medlemskaber returnerer alt, hvad kalderen kan læse (sine egne plus sine administrerede kontis), og account_id/user_id indsnævrer listen i stedet for at skifte tilstand eller give fejl.
  • Sæt cancel_at_period_end for at planlægge en annullering. Handlingen cancel afslutter adgangen med det samme.
  • Handlingen extend erstatter add_free_days.
Konsistens i REST-svar og tidsstempler
Current API bruger nu konsistente sletningssvar, tidsstempelinput og Account-navngivning.
  • Sletnings-endpoints for produkter, varianter, checkout-konfigurationer, annoncer, annoncegrupper, annoncekampagner, sociale konti og bounty-indsendelser returnerer { id, deleted: true } i stedet for en ren boolean.
  • Tidsstempelfiltre på produkter, varianter, checkout-konfigurationer, overførsler og finansielle rapporter accepterer kun ISO 8601 i stedet for også at acceptere epoch-sekunder.
  • Produktsvar returnerer account i stedet for company.
Udbetalingsprocenter for partnervirksomheder
Partnervirksomheder eksponerer nu separate udbetalingssatser for hver indtægtskilde.
  • payout_percentage erstattes af payout_percentages.
  • Det indlejrede objekt indeholder satserne sales, ad_spend, transfer og card_interchange.
Produkter og checkout-konfigurationer
Produkter og checkout-konfigurationer bruger nu Account-modellen konsekvent.
  • Anmodningsparametre for produkter bruger account_id i stedet for company_id.
  • Anmodninger for checkout-konfigurationer bruger account_id på øverste niveau og inde i inline variantobjekter, der bæres af kompatibilitetsfeltet plan.
  • Svar for checkout-konfigurationer returnerer account_id i stedet for company_id.
Tidsstempler for checkout-konfigurationer
Tidsstempler for checkout-konfigurationer bruger nu det samme format som resten af API’et.
  • created_at og updated_at er ISO 8601-strenge i stedet for Unix epoch-heltal.
Brugersaldi
Brugersaldi giver nu et komplet, struktureret saldoresumé.
  • De flade felter total_usd og balances erstattes af et indlejret balance-objekt.
  • Resuméet adskiller kontanter, krypto, treasury-indbetalinger undervejs og saldi for konti, som brugeren ejer.
Ressourcer for indtjening på virksomhedshenvisninger
Indtjening på virksomhedshenvisninger identificerer nu den polymorfe ressource, der genererede indtjeningen.
  • receipt erstattes af resource.
  • access_pass erstattes af product.
  • Kvitteringsbaseret indtjening returnerer resource.object: "receipt" med kvitteringens betalingsoplysninger.
  • Feltet resource kan understøtte yderligere indtjeningsressourcer i fremtidige versioner uden at genbruge kvitteringsspecifikke felter.
Ressource for virksomhedshenvisninger
Volumen og indtjening for virksomhedshenvisninger rapporteres nu som afstemmende grupper.
  • processing_volume, total_earnings, pending_payout og completed_payout erstattes af de indlejrede objekter volume_usd og earnings_usd.
  • Indtjening omdøber base_amount/amount til transaction_amount_usd/commission_amount_usd og udtrykker payout_percentage som en brøk.
Variants-ressourcen (dengang kaldet Plans)
Varianter, som dengang hed Plans, bruger nu Account-modellen konsekvent.
  • Anmodningsparametre og anmodnings-bodies bruger account_id i stedet for company_id.
  • Variantsvar returnerer account i stedet for company.
Users-ressourcen
Anmodninger om brugeradgang bruger nu Account-modellen konsekvent.
  • Anmodningsparametre og anmodnings-bodies bruger account_id i stedet for company_id.
  • Svarformerne er uændrede.
Oprindelig version
Den oprindelige adfærd for Current API, før dateret versionering fandtes.Anmodninger uden Api-Version-Date bruger denne version, så eksisterende integrationer fortsætter med at virke.