> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Refundering

> En refundering repræsenterer en hel eller delvis tilbageførsel af en betaling, inklusive beløb, status og betalingsudbyder.

```json Example theme={null}
{
	"amount": 6.9,
	"created_at": "2023-12-01T05:00:00.401Z",
	"currency": "usd",
	"id": "rf_xxxxxxxxxxxxxxx",
	"metadata": {},
	"payment": {
		"billing_reason": "subscription_create",
		"card_brand": "mastercard",
		"card_last4": "4242",
		"created_at": "2023-12-01T05:00:00.401Z",
		"currency": "usd",
		"dispute_alerted_at": "2023-12-01T05:00:00.401Z",
		"id": "pay_xxxxxxxxxxxxxx",
		"member": {
			"id": "<string>",
			"phone": "<string>"
		},
		"membership": {
			"id": "mem_xxxxxxxxxxxxxx",
			"status": "trialing"
		},
		"metadata": {},
		"paid_at": "2023-12-01T05:00:00.401Z",
		"payment_method_type": "acss_debit",
		"plan": {
			"id": "plan_xxxxxxxxxxxxx",
			"metadata": {}
		},
		"product": {
			"id": "prod_xxxxxxxxxxxxx",
			"metadata": {}
		},
		"subtotal": 6.9,
		"tax_amount": 6.9,
		"tax_behavior": "exclusive",
		"tax_refunded_amount": 6.9,
		"total": 6.9,
		"usd_total": 6.9,
		"user": {
			"email": "john.doe@example.com",
			"id": "user_xxxxxxxxxxxxx",
			"name": "John Doe",
			"username": "johndoe42"
		}
	},
	"provider": "stripe",
	"provider_created_at": "2023-12-01T05:00:00.401Z",
	"reference_status": "available",
	"reference_type": "acquirer_reference_number",
	"reference_value": "74850120752",
	"status": "pending"
}
```

**amount** `number` *required*

Det refunderede beløb som en decimal i den angivne valuta, såsom 10.43 for \$10.43 USD.

Eksempel: `6.9`

**created\_at** `string\<date-time\>` *required*

Tidspunktet, hvor refunderingen blev oprettet.

Eksempel: `2023-12-01T05:00:00.401Z`

**currency** `Currencies` *required*

Den trebogstavs ISO-valutakode for det refunderede beløb.

Tilgængelige muligheder: `usd`, `sgd`, `inr`, `aud`, `brl`, `cad`, `dkk`, `eur`, `nok`, `gbp`, `sek`, `chf`, `hkd`, `huf`, `jpy`, `mxn`, `myr`, `pln`, `czk`, `nzd`, `aed`, `eth`, `ape`, `cop`, `ron`, `thb`, `bgn`, `idr`, `dop`, `php`, `try`, `krw`, `twd`, `vnd`, `pkr`, `clp`, `uyu`, `ars`, `zar`, `dzd`, `tnd`, `mad`, `kes`, `kwd`, `jod`, `all`, `xcd`, `amd`, `bsd`, `bhd`, `bob`, `bam`, `khr`, `crc`, `xof`, `egp`, `etb`, `gmd`, `ghs`, `gtq`, `gyd`, `ils`, `jmd`, `mop`, `mga`, `mur`, `mdl`, `mnt`, `nad`, `ngn`, `mkd`, `omr`, `pyg`, `pen`, `qar`, `rwf`, `sar`, `rsd`, `lkr`, `tzs`, `ttd`, `uzs`, `rub`, `btc`, `cny`, `usdt`, `kzt`, `awg`, `whop_usd`, `xau`, `hnl`

**id** `string` *required*

Den unikke identifikator for refunderingen.

Eksempel: `rf_xxxxxxxxxxxxxxx`

**metadata** `object | null` *required*

De tilpassede metadata, der blev tilknyttet, da denne refundering blev anmodet om.

**payment** `object | null` *required*

Den oprindelige betaling, som denne refundering blev udstedt mod. Null, hvis betalingen ikke længere er tilgængelig.

**underordnede attributter**

**billing\_reason** `BillingReasons | null` *required*

Den maskinlæsbare årsag til, at denne opkrævning blev oprettet, såsom første abonnementskøb, fornyelsescyklus eller engangsbetaling.

Tilgængelige muligheder: `subscription_create`, `subscription_cycle`, `subscription_update`, `one_time`, `manual`, `subscription`

**card\_brand** `CardBrands | null` *required*

Kortnetværk rapporteret af processoren (f.eks. 'visa', 'mastercard', 'amex'). Kun til stede, når betalingsmetodetypen er 'card'.

Tilgængelige muligheder: `mastercard`, `visa`, `amex`, `discover`, `unionpay`, `jcb`, `diners`, `link`, `troy`, `visadankort`, `visabancontact`, `china_union_pay`, `rupay`, `jcbrupay`, `elo`, `maestro`, `tarjeta_naranja`, `cirrus`, `nspk_mir`, `verve`, `ebt`, `private_label`, `local_brand`, `uatp`, `wexcard`, `uzcard`, `meeza`, `hrg_store_card`, `girocard`, `fuel_card`, `dankort`, `carnet`, `atm_card`, `china_union_payuzcard`, `codensa`, `cabal`, `hipercard`, `jcblankapay`, `cmi`, `aura`, `accel`, `culiance`, `nyce`, `pulse`, `star`, `eftpos`, `alelo`, `edenred`, `sodexo`, `unknown`

**card\_last4** `string | null` *required*

De sidste fire cifre på det kort, der blev brugt til denne betaling. Null, hvis betalingen ikke blev foretaget med et kort.

Eksempel: `4242`

**created\_at** `string\<date-time\>` *required*

Tidspunktet, hvor betalingen blev oprettet.

Eksempel: `2023-12-01T05:00:00.401Z`

**currency** `Currencies` *required*

Den trebogstavs ISO-valutakode for denne betaling (f.eks. 'usd', 'eur').

Tilgængelige muligheder: `usd`, `sgd`, `inr`, `aud`, `brl`, `cad`, `dkk`, `eur`, `nok`, `gbp`, `sek`, `chf`, `hkd`, `huf`, `jpy`, `mxn`, `myr`, `pln`, `czk`, `nzd`, `aed`, `eth`, `ape`, `cop`, `ron`, `thb`, `bgn`, `idr`, `dop`, `php`, `try`, `krw`, `twd`, `vnd`, `pkr`, `clp`, `uyu`, `ars`, `zar`, `dzd`, `tnd`, `mad`, `kes`, `kwd`, `jod`, `all`, `xcd`, `amd`, `bsd`, `bhd`, `bob`, `bam`, `khr`, `crc`, `xof`, `egp`, `etb`, `gmd`, `ghs`, `gtq`, `gyd`, `ils`, `jmd`, `mop`, `mga`, `mur`, `mdl`, `mnt`, `nad`, `ngn`, `mkd`, `omr`, `pyg`, `pen`, `qar`, `rwf`, `sar`, `rsd`, `lkr`, `tzs`, `ttd`, `uzs`, `rub`, `btc`, `cny`, `usdt`, `kzt`, `awg`, `whop_usd`, `xau`, `hnl`

**dispute\_alerted\_at** `string\<date-time\> | null` *required*

Hvornår der kom en advarsel om, at denne transaktion vil blive bestridt

Eksempel: `2023-12-01T05:00:00.401Z`

**id** `string` *required*

Den unikke identifikator for betalingen.

Eksempel: `pay_xxxxxxxxxxxxxx`

**member** `object | null` *required*

Medlemmet knyttet til denne betaling.

**underordnede attributter**

**id** `string` *required*

Den unikke identifikator for virksomhedsmedlemmet.

**phone** `string | null` *required*

Medlemmets telefonnummer, hvis tilgængeligt.

**membership** `object | null` *required*

Medlemskabet knyttet til denne betaling.

**underordnede attributter**

**id** `string` *required*

Den unikke identifikator for medlemskabet.

Eksempel: `mem_xxxxxxxxxxxxxx`

**status** `MembershipStatus` *required*

Medlemskabets tilstand.

Tilgængelige muligheder: `trialing`, `active`, `past_due`, `completed`, `canceled`, `expired`, `unresolved`, `drafted`, `canceling`

**metadata** `object | null` *required*

De tilpassede metadata gemt på denne betaling. Disse kopieres over til den checkout-konfiguration, som denne betaling blev foretaget for

**paid\_at** `string\<date-time\> | null` *required*

Tidspunktet, hvor denne betaling blev opkrævet med succes. Null, hvis betalingen endnu ikke er gennemført. Som et Unix-tidsstempel.

Eksempel: `2023-12-01T05:00:00.401Z`

**payment\_method\_type** `PaymentMethodTypes | null` *required*

Typen af betalingsinstrument brugt til denne betaling (f.eks. kort, Cash App, iDEAL, Klarna, krypto). Null, når processoren ikke angiver en type.

Tilgængelige muligheder: `acss_debit`, `addi`, `affirm`, `afterpay_clearpay`, `alipay`, `alipayhk`, `alma`, `amazon_pay`, `apple`, `apple_pay`, `au_bank_transfer`, `au_becs_debit`, `bacs_debit`, `bancolombia`, `bancontact`, `bank_wire`, `billie`, `blik`, `boleto`, `bre_b`, `ca_bank_transfer`, `capchase_pay`, `card`, `card_present`, `card_installments_three`, `card_installments_six`, `card_installments_twelve`, `cashapp`, `claritypay`, `coinbase`, `crypto`, `crypto_subscription`, `custom`, `customer_balance`, `demo_pay`, `duitnow_qr`, `efecty`, `eps`, `eu_bank_transfer`, `fpx`, `flex_pay`, `gb_bank_transfer`, `gcash`, `giropay`, `google_pay`, `gopay`, `grabpay`, `id_bank_transfer`, `ideal`, `interac`, `international_bank_wire`, `kakao_pay`, `klarna`, `klarna_pay_now`, `konbini`, `kr_card`, `kr_market`, `kriya`, `kueski`, `link`, `mb_way`, `m_pesa`, `mercado_pago`, `mercado_pago_ar`, `mercado_pago_mx`, `mobilepay`, `modo`, `mondu`, `multibanco`, `naver_pay`, `nequi`, `netbanking`, `ng_bank`, `ng_bank_transfer`, `ng_card`, `ng_market`, `ng_ussd`, `ng_wallet`, `nupay`, `nz_bank_account`, `oney`, `oney_3x`, `oney_4x`, `opay`, `oxxo`, `p24`, `pago_efectivo`, `pse`, `pay_by_bank`, `payco`, `paynow`, `paypal`, `paypal_express`, `paypay`, `payto`, `payto_email`, `payto_phone`, `payto_bank_account`, `pix`, `pix_automatico`, `platform_balance`, `promptpay`, `qris`, `rapipago`, `rechnung`, `revolut_pay`, `samsung_pay`, `satispay`, `scalapay`, `sencillito`, `sepa_debit`, `sequra`, `servipag`, `sezzle`, `shop_pay`, `shopeepay`, `sofort`, `south_korea_market`, `spei`, `splitit`, `sunbit`, `swish`, `tabby`, `tamara`, `touch_n_go`, `twint`, `upi`, `us_bank_account`, `us_bank_transfer`, `venmo`, `verve`, `vipps`, `webpay`, `wechat_pay`, `whop_pay`, `yape`, `zip`, `coinflow`, `unknown`

**plan** `object | null` *required*

Planen knyttet til denne betaling.

**underordnede attributter**

**id** `string` *required*

Den unikke identifikator for planen.

Eksempel: `plan_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

Tilpassede nøgle-værdi-par gemt på planen. Inkluderet i webhook-payloads for betalings- og medlemskabshændelser. Maks. 50 nøgler, 100 tegn pr. nøgle, 500 tegn pr. strengværdi. De reserverede nøgler `custom_cta` og `custom_cta_url` tilsidesætter, når de er angivet, produktets checkout-opfordring til handling for denne plan.

**product** `object | null` *required*

Produktet, som denne betaling blev foretaget for

**underordnede attributter**

**id** `string` *required*

Den unikke identifikator for produktet.

Eksempel: `prod_xxxxxxxxxxxxx`

**metadata** `object | null` *required*

Tilpassede nøgle-værdi-par gemt på produktet og inkluderet i webhook-payloads for betalinger og medlemskaber. Maks. 50 nøgler, 100 tegn pr. nøgle, 500 tegn pr. strengværdi.

**subtotal** `number | null` *required*

Subtotalen, der vises for skaberen (eksklusive købergebyrer).

Eksempel: `6.9`

**tax\_amount** `number | null` *required*

Det beregnede beløb for moms/salgsafgift (hvis relevant).

Eksempel: `6.9`

**tax\_behavior** `ReceiptTaxBehaviors | null` *required*

Typen af momsinklusion anvendt på betalingen, til at afgøre, om afgiften er inkluderet i den endelige pris eller betales oveni.

Tilgængelige muligheder: `exclusive`, `inclusive`, `unspecified`, `unable_to_collect`

**tax\_refunded\_amount** `number | null` *required*

Afgiftsbeløbet, der er blevet refunderet (hvis relevant).

Eksempel: `6.9`

**total** `number | null` *required*

Totalen, der vises for skaberen (eksklusive købergebyrer).

Eksempel: `6.9`

**usd\_total** `number | null` *required*

Totalen i USD, der vises for skaberen (eksklusive købergebyrer).

Eksempel: `6.9`

**user** `object | null` *required*

Brugeren, der foretog denne betaling.

**underordnede attributter**

**email** `string | null` *required*

Brugerens e-mailadresse. Kræver tilladelsen member:email:read for at få adgang. Null, hvis ikke autoriseret.

Eksempel: `john.doe@example.com`

**id** `string` *required*

Den unikke identifikator for brugeren.

Eksempel: `user_xxxxxxxxxxxxx`

**name** `string | null` *required*

Brugerens visningsnavn, der vises på deres offentlige profil.

Eksempel: `John Doe`

**username** `string` *required*

Brugerens unikke brugernavn, der vises på deres offentlige profil.

Eksempel: `johndoe42`

**provider** `PaymentProviders` *required*

Betalingsudbyderen, der behandlede refunderingen.

Tilgængelige muligheder: `stripe`, `coinbase`, `paypal`, `apple`, `sezzle`, `splitit`, `platform_balance`, `multi_psp`, `adyen`, `claritypay`, `flex_pay`, `checkout_dot_com`, `airwallex`, `coinflow`, `sequra`, `dlocal`, `masspay`, `braintree`

**provider\_created\_at** `string\<date-time\> | null` *required*

Tidsstemplet for, hvornår refunderingen blev oprettet i betalingsudbyderens system. Null, hvis det ikke er tilgængeligt fra udbyderen.

Eksempel: `2023-12-01T05:00:00.401Z`

**reference\_status** `RefundReferenceStatuses | null` *required*

Tilgængelighedsstatus for refunderingens sporingsreference fra betalingsprocessoren. Null, hvis der ikke blev angivet en reference.

Tilgængelige muligheder: `available`, `pending`, `unavailable`

**reference\_type** `RefundReferenceTypes | null` *required*

Typen af sporingsreference angivet af betalingsprocessoren, såsom et acquirer-referencenummer. Null, hvis der ikke blev angivet en reference.

Tilgængelige muligheder: `acquirer_reference_number`, `retrieval_reference_number`, `system_trace_audit_number`

**reference\_value** `string | null` *required*

Sporingsreferencens værdi fra betalingsprocessoren, der bruges til at spore refunderingen gennem banknetværk. Null, hvis der ikke blev angivet en reference.

Eksempel: `74850120752`

**status** `RefundStatuses` *required*

Refunderingens aktuelle behandlingsstatus, såsom pending, succeeded eller failed.

Tilgængelige muligheder: `pending`, `requires_action`, `succeeded`, `failed`, `canceled`
