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

# API Payment Quotes

> Une Payment Quote calcule le prix d'un achat exactement comme le paiement correspondant sera facturé : la même tarification par ligne, le même code promo et la même taxe, pour un acheteur localisé par l'adresse, le pays ou l'adresse IP que vous envoyez.

Un devis est calculé une seule fois, peut être utilisé par un seul paiement, et expire.

Utilisez l'API Payment Quotes pour montrer à un acheteur le total, la taxe et la devise avant qu'il ne paie, puis transmettez l'`id` du devis en tant que `quote_id` lors de la création du paiement pour facturer exactement ce devis. Établissez un nouveau devis chaque fois que le panier, le code promo ou l'adresse change.

## Endpoints

| Endpoint | Requête |
| - | - |
| [Récupérer un devis de paiement](https://docs.whop.com/fr/api-reference/payment-quotes/retrieve-payment-quote.md) | GET `/payment_quotes/{id}` |
| [Créer un devis de paiement](https://docs.whop.com/fr/api-reference/payment-quotes/create-payment-quote.md) | POST `/payment_quotes` |

## Attributs

**id** `string` *required*

ID du devis de paiement, préfixé par `pq_`.

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

Le compte pour lequel le prix de l'achat est calculé, préfixé par `biz_`.

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

L'adresse de facturation avec laquelle le prix de l'achat a été calculé, ou null. C'est là que la taxe a été calculée lorsqu'aucune adresse de livraison n'a été fournie, et l'adresse à laquelle appartient l'immatriculation.

> [accordion] Propriétés
>
> **city** `string | null` *required*
>
> La ville.
>
> **country** `string | null` *required*
>
> Le code pays ISO 3166-1 alpha-2.
>
> **line1** `string | null` *required*
>
> La première ligne de l'adresse postale.
>
> **line2** `string | null` *required*
>
> La deuxième ligne de l'adresse postale.
>
> **name** `string | null` *required*
>
> Le nom figurant sur l'adresse.
>
> **postal\_code** `string | null` *required*
>
> Le code postal.
>
> **state** `string | null` *required*
>
> L'État, la province ou la région.

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

Code ISO 4217 à trois lettres de la devise propre aux variantes, en minuscules. Égal à
`currency` lorsque rien n'a été converti.

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

`total` en `base_currency` au taux `exchange_rate` : les prix propres aux variantes après le code promo, plus `tax_amount` converti au taux `exchange_rate` lorsque la taxe s'ajoute au prix. Égal à `total` lorsque rien n'a été converti. Le paiement facture `total`, en `currency`.

> [accordion] Propriétés
>
> **amount** `string` *required*
>
> Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, `"10.00"`
> correspond à dix dollars. Il s'agit d'une chaîne afin qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
>
> **currency** `string` *required*
>
> Code de devise ISO 4217 à trois lettres, en minuscules.
>
> **decimals** `integer` *required*
>
> Nombre de décimales que comporte le montant. Il s'agit de la précision avec laquelle
> le paiement lui-même est effectué.
>
> **display\_decimals** `integer` *required*
>
> Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.

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

Date de calcul du devis, sous forme d'horodatage ISO 8601.

**currency** `string` *required*

Code de devise ISO 4217 à trois lettres dans laquelle l'achat est calculé et facturé,
en minuscules : la devise propre aux variantes, ou la `presentment_currency` dans laquelle elle a été
convertie.

**discount** `object` *required*

Ce que retire le code promo. Zéro sans code.

> [accordion] Propriétés
>
> **amount** `string` *required*
>
> Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, `"10.00"`
> correspond à dix dollars. Il s'agit d'une chaîne afin qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
>
> **currency** `string` *required*
>
> Code de devise ISO 4217 à trois lettres, en minuscules.
>
> **decimals** `integer` *required*
>
> Nombre de décimales que comporte le montant. Il s'agit de la précision avec laquelle
> le paiement lui-même est effectué.
>
> **display\_decimals** `integer` *required*
>
> Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.

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

Combien d'unités de `currency` une unité de `base_currency` permet d'acheter, sous forme de chaîne
décimale comme `"5.4321"` : le taux auquel les prix des variantes ont été convertis,
fixe jusqu'à `expires_at`, et le taux auquel est facturé un paiement utilisant le
devis. Une chaîne, comme les montants monétaires, afin qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
Null lorsque rien n'a été converti.

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

Date à laquelle le devis ne peut plus être facturé, sous forme d'horodatage ISO 8601. Établissez un nouveau devis
au-delà.

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

Une entrée par variante, dans l'ordre fourni, chacune portant sa propre taxe.

> [accordion] Propriétés
>
> **discount** `object` *required*
>
> La part du code promo sur cette ligne. Zéro sans code.
>
> > [accordion] Propriétés
> >
> > **amount** `string` *required*
> >
> > Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, `"10.00"`
> > correspond à dix dollars. Il s'agit d'une chaîne afin qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
> >
> > **currency** `string` *required*
> >
> > Code de devise ISO 4217 à trois lettres, en minuscules.
> >
> > **decimals** `integer` *required*
> >
> > Nombre de décimales que comporte le montant. Il s'agit de la précision avec laquelle
> > le paiement lui-même est effectué.
> >
> > **display\_decimals** `integer` *required*
> >
> > Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
>
> **quantity** `integer` *required*
>
> Nombre d'unités de la variante couvertes par la ligne.
>
> **subtotal** `object` *required*
>
> Le prix de la ligne avant la part du code promo et la taxe ; `subtotal` moins `discount` correspond au montant de la ligne après remise. La somme des sous-totaux des lignes est égale au `subtotal` du devis.
>
> > [accordion] Propriétés
> >
> > **amount** `string` *required*
> >
> > Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, `"10.00"`
> > correspond à dix dollars. Il s'agit d'une chaîne afin qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
> >
> > **currency** `string` *required*
> >
> > Code de devise ISO 4217 à trois lettres, en minuscules.
> >
> > **decimals** `integer` *required*
> >
> > Nombre de décimales que comporte le montant. Il s'agit de la précision avec laquelle
> > le paiement lui-même est effectué.
> >
> > **display\_decimals** `integer` *required*
> >
> > Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
>
> **tax\_amount** `object` *required*
>
> La taxe sur cette ligne. Zéro lorsque `tax_status` ne vaut pas `calculated`.
>
> > [accordion] Propriétés
> >
> > **amount** `string` *required*
> >
> > Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, `"10.00"`
> > correspond à dix dollars. Il s'agit d'une chaîne afin qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
> >
> > **currency** `string` *required*
> >
> > Code de devise ISO 4217 à trois lettres, en minuscules.
> >
> > **decimals** `integer` *required*
> >
> > Nombre de décimales que comporte le montant. Il s'agit de la précision avec laquelle
> > le paiement lui-même est effectué.
> >
> > **display\_decimals** `integer` *required*
> >
> > Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
>
> **total** `object` *required*
>
> `subtotal` moins `discount`, plus `tax_amount` lorsque la taxe s'ajoute au prix, ou sans celle-ci lorsque le prix l'inclut déjà.
>
> > [accordion] Propriétés
> >
> > **amount** `string` *required*
> >
> > Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, `"10.00"`
> > correspond à dix dollars. Il s'agit d'une chaîne afin qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
> >
> > **currency** `string` *required*
> >
> > Code de devise ISO 4217 à trois lettres, en minuscules.
> >
> > **decimals** `integer` *required*
> >
> > Nombre de décimales que comporte le montant. Il s'agit de la précision avec laquelle
> > le paiement lui-même est effectué.
> >
> > **display\_decimals** `integer` *required*
> >
> > Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
>
> **variant\_id** `string | null` *required*
>
> La variante dont cette ligne calcule le prix, préfixée par `plan_`. Null lorsque l'achat décrit la variante via `variant` et qu'aucune variante avec ces attributs n'existe encore : le paiement qui utilise le devis la crée, et la ligne la mentionne à partir de ce moment.

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

L'emplacement pour lequel la taxe a été calculée : `shipping_address` lorsqu'elle comporte un pays, sinon l'`address` de facturation si c'est le cas, sinon le `presentment_country` envoyé, sinon l'`ip_address` de l'acheteur. Un devis localisé par `presentment_country` ou `ip_address` est un aperçu qui estime la taxe : un paiement ne peut pas l'utiliser, établissez donc un nouveau devis avec l'adresse de l'acheteur pour payer. Null lorsque rien dans la requête n'a permis de localiser l'acheteur, ce qui n'est possible que pour un vendeur qui ne collecte aucune taxe sur cet achat ; `tax_status` vaut alors `not_applicable`.

Options disponibles : `shipping_address`, `address`, `presentment_country`, `ip_address`

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

Le paiement qui détient ce devis, préfixé par `pay_`, ou null tant qu'il n'est pas utilisé.
Un paiement refusé conserve son devis et peut être retenté ; vérifiez le `status`
de ce paiement.

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

Le code promo appliqué par le devis, préfixé par `promo_`, ou null.

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

Codes ISO 4217 en minuscules à proposer à l'acheteur dans un sélecteur de devise, du plus
pertinent au moins pertinent : la devise du `presentment_country` envoyé, sinon celle du
pays où se trouve l'`ip_address` de l'acheteur, lorsque cet achat peut être converti
dans cette devise et qu'un moyen de paiement peut l'encaisser, puis `base_currency`. Établissez un nouveau devis
avec l'un d'eux comme `presentment_currency` pour calculer le prix dans cette devise. Uniquement `base_currency` lorsque
le devis a été calculé sans `presentment_currency` ni `presentment_country`.

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

L'adresse de livraison avec laquelle le prix de l'achat a été calculé, ou null. Lorsqu'elle est présente, c'est là que la taxe a été calculée.

> [accordion] Propriétés
>
> **city** `string | null` *required*
>
> La ville.
>
> **country** `string | null` *required*
>
> Le code pays ISO 3166-1 alpha-2.
>
> **line1** `string | null` *required*
>
> La première ligne de l'adresse postale.
>
> **line2** `string | null` *required*
>
> La deuxième ligne de l'adresse postale.
>
> **name** `string | null` *required*
>
> Le nom figurant sur l'adresse.
>
> **postal\_code** `string | null` *required*
>
> Le code postal.
>
> **state** `string | null` *required*
>
> L'État, la province ou la région.

**subtotal** `object` *required*

Le prix de toutes les lignes avant le code promo, la taxe et les frais.

> [accordion] Propriétés
>
> **amount** `string` *required*
>
> Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, `"10.00"`
> correspond à dix dollars. Il s'agit d'une chaîne afin qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
>
> **currency** `string` *required*
>
> Code de devise ISO 4217 à trois lettres, en minuscules.
>
> **decimals** `integer` *required*
>
> Nombre de décimales que comporte le montant. Il s'agit de la précision avec laquelle
> le paiement lui-même est effectué.
>
> **display\_decimals** `integer` *required*
>
> Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.

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

La taxe que facture un paiement utilisant ce devis. Zéro sauf si `tax_status` vaut `calculated`.

> [accordion] Propriétés
>
> **amount** `string` *required*
>
> Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, `"10.00"`
> correspond à dix dollars. Il s'agit d'une chaîne afin qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
>
> **currency** `string` *required*
>
> Code de devise ISO 4217 à trois lettres, en minuscules.
>
> **decimals** `integer` *required*
>
> Nombre de décimales que comporte le montant. Il s'agit de la précision avec laquelle
> le paiement lui-même est effectué.
>
> **display\_decimals** `integer` *required*
>
> Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.

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

Indique si la taxe s'ajoute au prix (`exclusive`) ou y est déjà incluse (`inclusive`). Null lorsqu'aucune taxe n'a été calculée.

Options disponibles : `inclusive`, `exclusive`

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

L'immatriculation fiscale de l'acheteur avec laquelle le devis a été calculé comme un achat professionnel. Vide pour un achat de particulier.

> [accordion] Propriétés
>
> **type** `string` *required*
>
> Le type de l'immatriculation, comme `eu_vat`.
>
> Options disponibles : `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*
>
> Le numéro d'immatriculation tel que l'acheteur l'a saisi, espaces supprimés (les valeurs `eu_vat` perdent également les points et les tirets).

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

`calculated` : le prix de chaque ligne a été calculé et un paiement peut utiliser le devis. `not_applicable` : ce vendeur ne collecte aucune taxe sur cet achat, le devis n'en doit donc aucune et peut tout de même être utilisé. `unavailable` : la taxe n'a pas pu être calculée — le prestataire n'a pas répondu, ou la configuration fiscale de ce vendeur ne permet pas de calculer le prix d'un achat à cet endroit — un paiement refuse donc le devis ; établissez un nouveau devis, ou facturez sans `quote_id` pour que la taxe soit calculée au moment de la facturation.

Options disponibles : `calculated`, `not_applicable`, `unavailable`

**total** `object` *required*

Ce que paie l'acheteur : le sous-total moins la remise, plus `tax_amount` lorsque la taxe s'ajoute au prix.

> [accordion] Propriétés
>
> **amount** `string` *required*
>
> Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, `"10.00"`
> correspond à dix dollars. Il s'agit d'une chaîne afin qu'aucun nombre à virgule flottante ne l'arrondisse en transit.
>
> **currency** `string` *required*
>
> Code de devise ISO 4217 à trois lettres, en minuscules.
>
> **decimals** `integer` *required*
>
> Nombre de décimales que comporte le montant. Il s'agit de la précision avec laquelle
> le paiement lui-même est effectué.
>
> **display\_decimals** `integer` *required*
>
> Nombre de décimales à AFFICHER. Généralement égal à `decimals`, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont `2` et `0`. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.

```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/fr/api-reference/payment-quotes/retrieve-payment-quote.md)
- [Create Payment Quote](https://docs.whop.com/fr/api-reference/payment-quotes/create-payment-quote.md)
- [API Payments](https://docs.whop.com/fr/api-reference/payments/payment.md)
