> ## 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.

# Payment Quotes API

> Een Payment Quote prijst een aankoop precies zoals een betaling ervoor in rekening wordt gebracht: dezelfde regelprijzen, promotiecode en belasting, voor een koper die wordt gelokaliseerd via het adres, land of IP-adres dat je meestuurt.

Een quote wordt eenmalig geprijsd, kan door één betaling worden gebruikt en verloopt.

Gebruik de Payment Quotes API om een koper het totaal, de belasting en de valuta te tonen voordat die betaalt, en geef daarna de `id` van de quote mee als `quote_id` wanneer je de betaling aanmaakt, zodat precies die quote in rekening wordt gebracht. Vraag opnieuw een quote aan wanneer de winkelwagen, promotiecode of het adres verandert.

## Endpoints

| Endpoint | Verzoek |
| - | - |
| [Payment quote ophalen](https://docs.whop.com/nl/api-reference/payment-quotes/retrieve-payment-quote.md) | GET `/payment_quotes/{id}` |
| [Payment quote aanmaken](https://docs.whop.com/nl/api-reference/payment-quotes/create-payment-quote.md) | POST `/payment_quotes` |

## Attributen

**id** `string` *required*

Payment quote-ID, met prefix `pq_`.

**account\_id** `string` *required*

Het account waarvoor de aankoop wordt geprijsd, met prefix `biz_`.

**address** `object | null` *required*

Het factuuradres waarmee de aankoop is geprijsd, of null. Waar de belasting is berekend wanneer er geen verzendadres is opgegeven, en het adres waartoe de registratie behoort.

> [accordion] Eigenschappen
>
> **city** `string | null` *required*
>
> De plaats.
>
> **country** `string | null` *required*
>
> De ISO 3166-1 alpha-2-landcode.
>
> **line1** `string | null` *required*
>
> De eerste adresregel.
>
> **line2** `string | null` *required*
>
> De tweede adresregel.
>
> **name** `string | null` *required*
>
> De naam op het adres.
>
> **postal\_code** `string | null` *required*
>
> De postcode.
>
> **state** `string | null` *required*
>
> De staat, provincie of regio.

**base\_currency** `string` *required*

ISO 4217-code van drie letters van de eigen valuta van de varianten, in kleine letters. Gelijk aan `currency` wanneer er niets is omgerekend.

**base\_total** `object` *required*

`total` in `base_currency` tegen `exchange_rate`: de eigen prijzen van de varianten na de promotiecode, plus `tax_amount` omgerekend tegen `exchange_rate` wanneer belasting erbovenop komt. Gelijk aan `total` wanneer er niets is omgerekend. De betaling brengt `total` in rekening, in `currency`.

> [accordion] Eigenschappen
>
> **amount** `string` *required*
>
> Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
>
> **currency** `string` *required*
>
> Valutacode volgens ISO 4217 van drie letters, in kleine letters.
>
> **decimals** `integer` *required*
>
> Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
>
> **display\_decimals** `integer` *required*
>
> 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.

**created\_at** `string` *required*

Wanneer de quote is geprijsd, als ISO 8601-tijdstempel.

**currency** `string` *required*

ISO 4217-valutacode van drie letters waarin de aankoop wordt geprijsd en afgerekend, in kleine letters: de eigen valuta van de varianten, of de `presentment_currency` waarnaar is omgerekend.

**discount** `object` *required*

Wat de promotiecode eraf haalt. Nul zonder code.

> [accordion] Eigenschappen
>
> **amount** `string` *required*
>
> Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
>
> **currency** `string` *required*
>
> Valutacode volgens ISO 4217 van drie letters, in kleine letters.
>
> **decimals** `integer` *required*
>
> Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
>
> **display\_decimals** `integer` *required*
>
> 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.

**exchange\_rate** `string | null` *required*

Hoeveel eenheden `currency` één eenheid `base_currency` oplevert, als decimale string zoals `"5.4321"`: de koers waartegen de prijzen van de varianten zijn omgerekend, vast tot `expires_at`, en de koers waartegen een betaling die de quote gebruikt wordt afgerekend. Een string, net als geldbedragen, zodat geen float het onderweg afrondt. Null wanneer er niets is omgerekend.

**expires\_at** `string` *required*

Wanneer de quote niet meer in rekening kan worden gebracht, als ISO 8601-tijdstempel. Vraag daarna opnieuw een quote aan.

**line\_items** `object[]` *required*

Eén item per variant, in de opgegeven volgorde, elk met een eigen belasting.

> [accordion] Eigenschappen
>
> **discount** `object` *required*
>
> Het aandeel van de promotiecode op deze regel. Nul zonder code.
>
> > [accordion] Eigenschappen
> >
> > **amount** `string` *required*
> >
> > Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
> >
> > **currency** `string` *required*
> >
> > Valutacode volgens ISO 4217 van drie letters, in kleine letters.
> >
> > **decimals** `integer` *required*
> >
> > Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
> >
> > **display\_decimals** `integer` *required*
> >
> > 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.
>
> **quantity** `integer` *required*
>
> Hoeveel eenheden van de variant de regel omvat.
>
> **subtotal** `object` *required*
>
> De prijs van de regel vóór het aandeel van de promotiecode en belasting; `subtotal` min `discount` is wat de regel na de korting bedraagt. De subtotalen van de regels tellen op tot het `subtotal` van de quote.
>
> > [accordion] Eigenschappen
> >
> > **amount** `string` *required*
> >
> > Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
> >
> > **currency** `string` *required*
> >
> > Valutacode volgens ISO 4217 van drie letters, in kleine letters.
> >
> > **decimals** `integer` *required*
> >
> > Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
> >
> > **display\_decimals** `integer` *required*
> >
> > 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.
>
> **tax\_amount** `object` *required*
>
> De belasting op deze regel. Nul wanneer `tax_status` niet `calculated` is.
>
> > [accordion] Eigenschappen
> >
> > **amount** `string` *required*
> >
> > Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
> >
> > **currency** `string` *required*
> >
> > Valutacode volgens ISO 4217 van drie letters, in kleine letters.
> >
> > **decimals** `integer` *required*
> >
> > Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
> >
> > **display\_decimals** `integer` *required*
> >
> > 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.
>
> **total** `object` *required*
>
> `subtotal` min `discount`, plus `tax_amount` wanneer belasting erbovenop komt, of zonder wanneer de prijs deze al bevat.
>
> > [accordion] Eigenschappen
> >
> > **amount** `string` *required*
> >
> > Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
> >
> > **currency** `string` *required*
> >
> > Valutacode volgens ISO 4217 van drie letters, in kleine letters.
> >
> > **decimals** `integer` *required*
> >
> > Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
> >
> > **display\_decimals** `integer` *required*
> >
> > 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.
>
> **variant\_id** `string | null` *required*
>
> De variant die deze regel prijst, met prefix `plan_`. Null wanneer de aankoop de variant beschrijft via `variant` en er nog geen variant met die kenmerken bestaat: de betaling die de quote gebruikt, maakt deze aan, en vanaf dan noemt de regel hem.

**located\_by** `string | null` *required*

Voor welke locatie de belasting is berekend: `shipping_address` wanneer dat een land bevat, anders het factuur-`address` wanneer dat er een bevat, anders het meegestuurde `presentment_country`, anders het `ip_address` van de koper. Een quote die via `presentment_country` of `ip_address` is gelokaliseerd, is een preview die de belasting schat: een betaling kan deze niet gebruiken, dus vraag opnieuw een quote aan met het adres van de koper om te betalen. Null wanneer niets in het verzoek de koper lokaliseerde, wat alleen kan bij een verkoper die op deze aankoop geen belasting int; `tax_status` is dan `not_applicable`.

Beschikbare opties: `shipping_address`, `address`, `presentment_country`, `ip_address`

**payment\_id** `string | null` *required*

De betaling die deze quote vasthoudt, met prefix `pay_`, of null zolang de quote niet is gebruikt. Een geweigerde betaling behoudt haar quote en kan opnieuw worden geprobeerd; controleer de `status` van die betaling.

**promo\_code\_id** `string | null` *required*

De promotiecode die de quote heeft toegepast, met prefix `promo_`, of null.

**recommended\_currencies** `string[]` *required*

ISO 4217-codes in kleine letters om de koper in een valutakiezer aan te bieden, meest relevante eerst: de valuta van het meegestuurde `presentment_country`, anders van het land waarin het `ip_address` van de koper zich bevindt, wanneer deze aankoop ernaar kan worden omgerekend en een betaalmethode die valuta kan innen, daarna `base_currency`. Vraag opnieuw een quote aan met een van deze als `presentment_currency` om erin te prijzen. Alleen `base_currency` wanneer de quote is geprijsd zonder `presentment_currency` of `presentment_country`.

**shipping\_address** `object | null` *required*

Het verzendadres waarmee de aankoop is geprijsd, of null. Indien aanwezig is dit de plek waar de belasting is berekend.

> [accordion] Eigenschappen
>
> **city** `string | null` *required*
>
> De plaats.
>
> **country** `string | null` *required*
>
> De ISO 3166-1 alpha-2-landcode.
>
> **line1** `string | null` *required*
>
> De eerste adresregel.
>
> **line2** `string | null` *required*
>
> De tweede adresregel.
>
> **name** `string | null` *required*
>
> De naam op het adres.
>
> **postal\_code** `string | null` *required*
>
> De postcode.
>
> **state** `string | null` *required*
>
> De staat, provincie of regio.

**subtotal** `object` *required*

De prijs van alle regels vóór promotiecode, belasting en kosten.

> [accordion] Eigenschappen
>
> **amount** `string` *required*
>
> Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
>
> **currency** `string` *required*
>
> Valutacode volgens ISO 4217 van drie letters, in kleine letters.
>
> **decimals** `integer` *required*
>
> Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
>
> **display\_decimals** `integer` *required*
>
> 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.

**tax\_amount** `object` *required*

De belasting die een betaling die deze quote gebruikt in rekening brengt. Nul tenzij `tax_status` `calculated` is.

> [accordion] Eigenschappen
>
> **amount** `string` *required*
>
> Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
>
> **currency** `string` *required*
>
> Valutacode volgens ISO 4217 van drie letters, in kleine letters.
>
> **decimals** `integer` *required*
>
> Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
>
> **display\_decimals** `integer` *required*
>
> 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.

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

Of belasting bovenop de prijs komt (`exclusive`) of er al in zit (`inclusive`). Null wanneer er geen belasting is berekend.

Beschikbare opties: `inclusive`, `exclusive`

**tax\_ids** `object[]` *required*

De belastingregistratie van de koper waarmee de quote als zakelijke aankoop is geprijsd. Leeg voor een consumentenaankoop.

> [accordion] Eigenschappen
>
> **type** `string` *required*
>
> Het type registratie, zoals `eu_vat`.
>
> 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`
>
> **value** `string` *required*
>
> Het registratienummer zoals de koper het heeft ingevoerd, zonder witruimte (bij `eu_vat`-waarden worden ook punten en streepjes verwijderd).

**tax\_status** `string` *required*

`calculated`: elke regel is geprijsd en een betaling mag de quote gebruiken. `not_applicable`: deze verkoper int geen belasting op deze aankoop, dus de quote is niets verschuldigd en mag nog steeds worden gebruikt. `unavailable`: de belasting kon niet worden geprijsd — de provider antwoordde niet, of de belastinginstellingen van deze verkoper kunnen hier geen aankoop prijzen — dus een betaling weigert de quote; vraag opnieuw een quote aan, of reken af zonder `quote_id` zodat de belasting op het moment van afrekenen wordt berekend.

Beschikbare opties: `calculated`, `not_applicable`, `unavailable`

**total** `object` *required*

Wat de koper betaalt: het subtotaal min de korting, plus `tax_amount` wanneer belasting erbovenop komt.

> [accordion] Eigenschappen
>
> **amount** `string` *required*
>
> Het bedrag in hoofdeenheden, als exacte decimale string. `"10.00"` is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
>
> **currency** `string` *required*
>
> Valutacode volgens ISO 4217 van drie letters, in kleine letters.
>
> **decimals** `integer` *required*
>
> Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
>
> **display\_decimals** `integer` *required*
>
> 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.

```json PaymentQuote theme={null}
{
	"id": "pq_xxxxxxxxxxxxxx",
	"account_id": "biz_xxxxxxxxxxxxxx",
	"currency": "usd",
	"base_currency": "usd",
	"exchange_rate": null,
	"recommended_currencies": ["usd"],
	"tax_status": "calculated",
	"tax_behavior": "exclusive",
	"subtotal": {
		"currency": "usd",
		"amount": "27.00",
		"decimals": 2,
		"display_decimals": 2
	},
	"discount": {
		"currency": "usd",
		"amount": "0.00",
		"decimals": 2,
		"display_decimals": 2
	},
	"tax_amount": {
		"currency": "usd",
		"amount": "2.23",
		"decimals": 2,
		"display_decimals": 2
	},
	"total": {
		"currency": "usd",
		"amount": "29.23",
		"decimals": 2,
		"display_decimals": 2
	},
	"base_total": {
		"currency": "usd",
		"amount": "29.23",
		"decimals": 2,
		"display_decimals": 2
	},
	"line_items": [
		{
			"variant_id": "plan_xxxxxxxxxxxxxx",
			"quantity": 1,
			"subtotal": {
				"currency": "usd",
				"amount": "27.00",
				"decimals": 2,
				"display_decimals": 2
			},
			"discount": {
				"currency": "usd",
				"amount": "0.00",
				"decimals": 2,
				"display_decimals": 2
			},
			"tax_amount": {
				"currency": "usd",
				"amount": "2.23",
				"decimals": 2,
				"display_decimals": 2
			},
			"total": {
				"currency": "usd",
				"amount": "29.23",
				"decimals": 2,
				"display_decimals": 2
			}
		}
	],
	"promo_code_id": null,
	"located_by": "address",
	"address": {
		"name": null,
		"line1": "123 Congress Ave",
		"line2": null,
		"city": "Austin",
		"state": "TX",
		"postal_code": "78701",
		"country": "US"
	},
	"shipping_address": null,
	"tax_ids": [
		{
			"type": "us_ein",
			"value": "12-3456789"
		}
	],
	"payment_id": null,
	"expires_at": "2026-10-11T19:32:20.388Z",
	"created_at": "2026-10-11T19:02:20.389Z"
}
```


## Related topics

- [Retrieve Payment Quote](https://docs.whop.com/nl/api-reference/payment-quotes/retrieve-payment-quote.md)
- [Create Payment Quote](https://docs.whop.com/nl/api-reference/payment-quotes/create-payment-quote.md)
- [Payments API](https://docs.whop.com/nl/api-reference/payments/payment.md)
