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

# Facture (ancienne version)

> Une facture représente une facture détaillée envoyée par une entreprise à un client pour un produit et un plan spécifiques, suivant le montant dû, la date d'échéance et le statut du paiement.

> [!NOTE]
>
> Cette ressource a un successeur dans l'[API Whop](https://docs.whop.com/fr/api-reference/legacy/invoices/list-invoices.md) : les requêtes vers `/invoices` avec `Api-Version-Date: 2026-10-24` ou une date ultérieure atteignent les factures natives, décrites dans le [guide des factures](https://docs.whop.com/fr/developer/guides/invoices.md). Cette page reste entièrement prise en charge.

```json Example theme={null}
{
	"automatically_finalizes_at": "2023-12-01T05:00:00.401Z",
	"charge_buyer_fee": true,
	"collection_method": "send_invoice",
	"company": {
		"id": "biz_xxxxxxxxxxxxxx",
		"logo": {
			"url": "https://media.whop.com/abc123/optimized.jpg"
		},
		"title": "Pickaxe"
	},
	"created_at": "2023-12-01T05:00:00.401Z",
	"current_plan": {
		"billing_period": 42,
		"currency": "usd",
		"description": "Monthly access to all premium analytics dashboards and data exports.",
		"formatted_price": "$10.00",
		"id": "plan_xxxxxxxxxxxxx",
		"initial_price": 6.9,
		"plan_type": "renewal",
		"renewal_price": 6.9,
		"trial_period_days": 42
	},
	"customer_name": "Jane Doe",
	"due_date": "2023-12-01T05:00:00.401Z",
	"email_address": "customer@example.com",
	"fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
	"id": "inv_xxxxxxxxxxxxxx",
	"line_items": [
		{
			"label": "Platform subscription",
			"position": 42,
			"quantity": 6.9,
			"total": 6.9,
			"unit_price": 6.9
		}
	],
	"mailing_address": {
		"city": "<string>",
		"country": "<string>",
		"line1": "<string>",
		"line2": "<string>",
		"name": "<string>",
		"phone": "<string>",
		"postal_code": "<string>",
		"state": "<string>"
	},
	"member": {
		"id": "<string>"
	},
	"number": "#0001",
	"pay_online_url": "<string>",
	"payment": {
		"id": "pay_xxxxxxxxxxxxxx"
	},
	"payment_processing": true,
	"product": {
		"id": "prod_xxxxxxxxxxxxx",
		"title": "Pickaxe Analytics"
	},
	"status": "draft",
	"subscription_billing_anchor_at": "2023-12-01T05:00:00.401Z",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"user": {
		"email": "john.doe@example.com",
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"username": "johndoe42"
	}
}
```

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

La date et l'heure auxquelles la facture sera automatiquement finalisée. Pour charge\_automatically, déclenche un prélèvement automatique. Pour send\_invoice, envoie l'e-mail de facture à l'heure indiquée.

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

**charge\_buyer\_fee** `boolean` *required*

Indique si la facture inclut des frais de traitement acheteur en plus du prix du plan.

**collection\_method** `InvoiceCollectionMethods` *required*

La méthode utilisée pour encaisser le paiement de cette facture, par exemple un prélèvement automatique ou un paiement manuel.

Options disponibles : `send_invoice`, `charge_automatically`

**company** `object` *required*

L'entreprise qui a émis cette facture.

**attributs enfants**

**id** `string` *required*

L'identifiant unique de l'entreprise.

Exemple : `biz_xxxxxxxxxxxxxx`

**logo** `object | null` *required*

Le logo de l'entreprise.

**attributs enfants**

**url** `string | null` *required*

Une URL pré-optimisée pour afficher cette pièce jointe côté client. Elle doit être utilisée pour afficher les pièces jointes dans les applications.

Exemple : `https://media.whop.com/abc123/optimized.jpg`

**title** `string` *required*

Le nom d'affichage de l'entreprise présenté aux clients.

Exemple : `Pickaxe`

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

La date et l'heure de création de la facture.

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

**current\_plan** `object` *required*

Le plan facturé par cette facture.

**attributs enfants**

**billing\_period** `integer | null` *required*

Nombre de jours entre les prélèvements récurrents, par exemple 30 pour un plan mensuel ou 365 pour un plan annuel. `null` pour les plans à paiement unique.

Exemple : `42`

**currency** `Currencies` *required*

La devise utilisée pour tous les prix de ce plan (par exemple 'usd', 'eur'). Tous les montants du plan sont libellés dans cette devise.

Options disponibles : `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`

**description** `string | null` *required*

Une description textuelle du plan visible par les clients. 1000 caractères maximum. Null si aucune description n'est définie.

Exemple : `Monthly access to all premium analytics dashboards and da…`

**formatted\_price** `string` *required*

Le prix formaté (devise comprise) du plan.

Exemple : `$10.00`

**id** `string` *required*

L'identifiant unique du plan.

Exemple : `plan_xxxxxxxxxxxxx`

**initial\_price** `number` *required*

Le prix d'achat initial dans la base\_currency du plan (par exemple 49.99 pour 49,99 \$). Pour les plans à paiement unique, il s'agit du prix total. Pour les plans à renouvellement, il est facturé en plus du premier renewal\_price.

Exemple : `6.9`

**plan\_type** `PlanTypes` *required*

Le modèle de facturation de ce plan : 'renewal' pour les abonnements récurrents ou 'one\_time' pour les paiements uniques.

Options disponibles : `renewal`, `one_time`

**renewal\_price** `number` *required*

Le prix récurrent facturé à chaque billing\_period dans la base\_currency du plan (par exemple 9.99 pour 9,99 \$/période). Zéro pour les plans à paiement unique.

Exemple : `6.9`

**trial\_period\_days** `integer | null` *required*

Jours d'essai gratuit avant le premier prélèvement de renouvellement. `null` si aucun essai n'est configuré ou si l'utilisateur a déjà bénéficié d'un essai pour ce plan.

Exemple : `42`

**customer\_name** `string | null` *required*

Le nom complet du client auquel cette facture est adressée. Null si aucun nom n'est enregistré.

Exemple : `Jane Doe`

**due\_date** `string\<date-time\> | null` *required*

La date limite à laquelle le paiement est attendu. Null si la facture est encaissée automatiquement.

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

**email\_address** `string | null` *required*

L'adresse e-mail du client auquel cette facture est adressée. Null si aucune adresse e-mail n'est enregistrée.

Exemple : `customer@example.com`

**fetch\_invoice\_token** `string` *required*

Un jeton signé qui permet de récupérer publiquement les données de la facture sans authentification.

Exemple : `eyJhbGciOiJIUzI1NiJ9...`

**id** `string` *required*

L'identifiant unique de la facture.

Exemple : `inv_xxxxxxxxxxxxxx`

**line\_items** `array\<object\>` *required*

Lignes facultatives qui ventilent le total de la facture en frais individuels.

**attributs enfants**

**label** `string` *required*

Le libellé ou la description de cette ligne.

Exemple : `Platform subscription`

**position** `integer` *required*

L'ordre d'affichage de cette ligne dans la facture.

Exemple : `42`

**quantity** `number` *required*

La quantité de cette ligne.

Exemple : `6.9`

**total** `number` *required*

Le total calculé de cette ligne (quantity \* unit\_price).

Exemple : `6.9`

**unit\_price** `number` *required*

Le prix unitaire de cette ligne. Négatif pour un crédit ou une déduction.

Exemple : `6.9`

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

L'adresse de facturation/postale associée à cette facture, si elle a été fournie lors de la création.

**attributs enfants**

**city** `string | null` *required*

La ville de l'adresse.

**country** `string | null` *required*

Le pays de l'adresse.

**line1** `string | null` *required*

La ligne 1 de l'adresse.

**line2** `string | null` *required*

La ligne 2 de l'adresse.

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

Le nom du client.

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

Le numéro de téléphone du client.

**postal\_code** `string | null` *required*

Le code postal de l'adresse.

**state** `string | null` *required*

L'État ou la région de l'adresse.

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

Le membre pour lequel la facture a été créée. Null lorsque la facture est adressée à une adresse e-mail sans enregistrement de membre associé.

**attributs enfants**

**id** `string` *required*

L'identifiant unique du membre de l'entreprise.

**number** `string` *required*

Le numéro de facture séquentiel utilisé à des fins d'affichage.

Exemple : `#0001`

**pay\_online\_url** `string | null` *required*

L'URL de checkout où le client peut payer cette facture en ligne, avec son adresse e-mail pré-remplie et verrouillée.

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

Le paiement qui a réglé cette facture. Null tant que la facture est impayée, lorsque la facture a été marquée comme payée manuellement, et pour une facture de renouvellement d'abonnement dont le paiement de règlement ne peut pas encore être identifié.

**attributs enfants**

**id** `string` *required*

L'identifiant unique du paiement.

Exemple : `pay_xxxxxxxxxxxxxx`

**payment\_processing** `boolean` *required*

Indique si un paiement sur cette facture est encore en cours de compensation. Vrai pendant le règlement d'un moyen de paiement différé tel que ACH ou SEPA, période durant laquelle la facture reste ouverte et n'est pas marquée comme en retard.

**product** `object` *required*

Le produit pour lequel cette facture a été générée.

**attributs enfants**

**id** `string` *required*

L'identifiant unique du produit.

Exemple : `prod_xxxxxxxxxxxxx`

**title** `string` *required*

Le nom d'affichage du produit présenté aux clients sur la page produit et dans les résultats de recherche.

Exemple : `Pickaxe Analytics`

**status** `InvoiceStatuses` *required*

Le statut de paiement actuel de la facture, par exemple draft, open, paid ou void.

Options disponibles : `draft`, `open`, `paid`, `past_due`, `uncollectible`, `void`

**subscription\_billing\_anchor\_at** `string\<date-time\> | null` *required*

La date qui définit le début du cycle de facturation de l'abonnement. Lorsqu'elle est définie sur une facture de plan à renouvellement, toutes les périodes de facturation futures s'alignent sur cette date.

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

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

La date et l'heure de la dernière mise à jour de la facture.

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

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

L'utilisateur auquel cette facture est adressée. Null si le compte utilisateur a été supprimé.

**attributs enfants**

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

L'adresse e-mail de l'utilisateur. Nécessite la permission member:email:read pour y accéder. Null si non autorisé.

Exemple : `john.doe@example.com`

**id** `string` *required*

L'identifiant unique de l'utilisateur.

Exemple : `user_xxxxxxxxxxxxx`

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

Le nom d'affichage de l'utilisateur visible sur son profil public.

Exemple : `John Doe`

**username** `string` *required*

Le nom d'utilisateur unique de l'utilisateur visible sur son profil public.

Exemple : `johndoe42`


## Related topics

- [Sessions Element (ancienne version)](https://docs.whop.com/fr/sdk/elements/overview.md)
- [ChatElement (ancienne version)](https://docs.whop.com/fr/sdk/elements/chat-element.md)
- [SearchElement (ancienne version)](https://docs.whop.com/fr/sdk/elements/search-element.md)
