Skip to main content
Son ID pay_ est également l’ID du paiement une fois encaissée. Utilisez l’API Factures pour créer et modifier des brouillons, puis les émettre ou les envoyer. Vous pouvez prélever une facture ouverte sur un moyen de paiement enregistré, ou annuler une facture que l’acheteur ne paiera pas. La création d’un brouillon ne crée pas d’accès et ne prélève pas l’acheteur. Les coordonnées du destinataire sont stockées sur le membre du compte. Les champs financiers et les métadonnées de l’appelant ne peuvent être modifiés qu’à l’état de brouillon.

Endpoints

Attributs

string
requis
string
requis
object
requis

Propriétés

string
requis
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.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais volontairement pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre dans votre propre locale.
object | null
requis

Propriétés

string | null
requis
La ville.
string | null
requis
Le code pays ISO 3166-1 alpha-2.
string | null
requis
La première ligne de l’adresse postale.
string | null
requis
La deuxième ligne de l’adresse postale.
string | null
requis
Le nom figurant sur l’adresse.
string | null
requis
Le code postal.
string | null
requis
L’État, la province ou la région.
object
requis

Propriétés

string
requis
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.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais volontairement pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre dans votre propre locale.
number
requis
Un lien signé qui ouvre cette facture dans une session de paiement afin que l’acheteur puisse la régler. Transmettez-le comme link à POST /checkout_sessions. Présent tant que la facture est ouverte. null dans tout autre statut, pour une facture adressée à un acheteur professionnel, et pour une facture dont l’abonnement a été annulé. Également null sauf si vous disposez de payment:charge, ou de invoice:create ou invoice:update sur une facture sans payment_method_id.
string
requis
string | null
requis
boolean
requis
True lorsque DELETE /invoices/\{id} peut supprimer cette facture. Un brouillon est éligible sauf s’il est programmé ou s’il facture un abonnement. Une facture annulée est éligible sauf si elle a encaissé de l’argent ou attend encore un virement bancaire.
string | null
requis
string | null
requis
string | null
requis
object[]
requis

Propriétés

string | null
requis
ID de la ligne, préfixé par li_. Null lorsque le paiement est antérieur aux instantanés d’articles et que l’article est lu depuis la variante du paiement.
string | null
requis
Texte affiché sous l’article sur la facture, son e-mail et son PDF, lu depuis la description de la variante. Un prélèvement personnalisé le définit avec la description de l’article. Une variante de produit conserve la sienne. Null lorsque la variante n’en a pas ou a été supprimée depuis.
object | null
requis
La remise promotionnelle appliquée à cet article, dans la currency du paiement. Null lorsqu’aucune remise n’a été enregistrée.

Propriétés

string
requis
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.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais volontairement pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre dans votre propre locale.
object | null
requis
La partie de unit_amount correspondant aux frais initiaux uniques d’une variante récurrente, le initial_price de la variante, prélevés sur cette facture uniquement. Le reste de unit_amount correspond à la première période de facturation. Un essai n’entraîne aucun prélèvement pour la première période. Null pour les articles ponctuels, les factures de renouvellement, les articles sans frais initiaux et les articles dont les prix de variante ont changé après la tarification de la facture.

Propriétés

string
requis
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.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais volontairement pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre dans votre propre locale.
string | null
requis
Le nom de l’article tel qu’affiché lors du paiement (le titre du produit, sinon le titre de la variante).
string | null
requis
Le produit auquel appartient la variante, préfixé par prod_. Null pour une variante sans produit.
number
requis
Le nombre d’unités achetées.
object | null
requis
unit_amount multiplié par quantity, avant remises et taxes, dans la currency du paiement.

Propriétés

string
requis
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.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais volontairement pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre dans votre propre locale.
object | null
requis
La taxe perçue sur cet article, dans la currency du paiement. Null lorsqu’aucune taxe n’a été enregistrée.

Propriétés

string
requis
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.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais volontairement pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre dans votre propre locale.
integer | null
requis
Jours d’essai gratuit avant le premier prélèvement de renouvellement de cet article récurrent, issus du trial_period_days de la variante. La facture ne facture alors que le initial_price de la variante pour l’article. null pour les articles ponctuels et les factures de renouvellement, et lorsque le client avait déjà un abonnement à la variante.
object | null
requis
Le prix enregistré d’une unité avant remises, dans la currency du paiement. La création ou le remplacement d’articles récurrents inclut les frais initiaux, plus la première période de facturation sauf si l’article commence par un essai. Les factures de renouvellement excluent les frais initiaux. Les autres modifications conservent les prix enregistrés. Null lorsque le paiement n’a enregistré aucun prix.

Propriétés

string
requis
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.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais volontairement pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre dans votre propre locale.
string | null
requis
La variante achetée, préfixée par plan_. Null lorsque la variante a été supprimée depuis.
string | null
requis
string | null
requis
string | null
requis
L’abonnement facturé par cette facture, préfixé par mem_. Pour une facture de renouvellement, il s’agit de l’abonnement qui est renouvelé. Pour une facture comportant un article récurrent, il s’agit de l’abonnement créé lors de l’émission de la facture. Null pour les factures ponctuelles, pour un brouillon pas encore émis, et sans l’autorisation member:basic:read.
string | null
requis
Une note destinée au client, affichée dans l’e-mail de la facture, le PDF et la page de paiement en conservant ses sauts de ligne. null lorsqu’aucune n’est définie.
object
requis
string
requis
string
requis
boolean
requis
string | null
requis
object | null
requis
Les moyens de paiement parmi lesquels le client peut choisir lorsqu’il paie via le lien de paiement de la facture. Ce paramètre prime sur les variantes de la facture et sur le compte. null lorsque la facture utilise les moyens de paiement de ses variantes.

Propriétés

string[]
requis
Moyens de paiement que ce checkout exclut, même lorsque les valeurs par défaut les proposeraient.
string[]
requis
Moyens de paiement que ce checkout propose en plus de ceux fournis par défaut.
boolean
requis
Indique si l’ensemble par défaut de Whop sert de point de départ. Lorsque false, seul enabled est proposé.
string | null
requis
string[]
requis
Destinataires des e-mails de la facture, indépendamment du client facturé.
string | null
requis
Date à laquelle le moyen de paiement enregistré de la facture sera prélevé, sous forme d’horodatage ISO 8601. Il s’agit du charge_at avec lequel la facture a été envoyée ou émise. À défaut, il s’agit de due_at lorsqu’une facture avec un payment_method_id est envoyée ou émise avant son échéance. Sur un brouillon, il s’agit du charge_at de son envoi programmé. null sinon, dès que le prélèvement commence, et une fois la facture payée, annulée ou irrécouvrable.
string | null
requis
Le collection_method qu’applique l’envoi programmé d’un brouillon lorsqu’il se déclenche. null lorsque le brouillon n’a pas d’envoi programmé ou qu’il a été programmé sans, et une fois la facture émise.Options disponibles : charge_automatically, send_invoice
string | null
requis
boolean
requis
Indique si ce brouillon est émis automatiquement à l’arrivée de son due_at. Son émission prélève son payment_method_id, ou envoie par e-mail son lien de paiement à ses recipient_emails. false pour une facture qui n’est pas un brouillon et pour un brouillon avec un envoi programmé. false tant que l’envoi du brouillon échouerait faute de destinataires ou de lien de paiement disponible. false pour un brouillon qui n’avait pas de due_at futur lors de son dernier enregistrement. false pour un brouillon créé avant 2026-11-12T22:00:00Z.
string
requis
Options disponibles : draft, open, authorized, paid, pending, uncollectible, unresolved, void
string | null
requis
Date de début de la première période de facturation des articles récurrents de la facture, sous forme d’horodatage ISO 8601. Les renouvellements sont calculés à partir de ce moment. Avec null, la période commence au paiement de la facture, de même qu’avec une date déjà passée à ce moment-là. Une facture avec une date de début ignore l’essai gratuit de ses variantes.
object
requis

Propriétés

string
requis
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.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais volontairement pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre dans votre propre locale.
object | null
requis

Propriétés

string
requis
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.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais volontairement pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre dans votre propre locale.
string
requis
Le fuseau horaire IANA des dates figurant dans l’e-mail et le PDF de la facture, comme America/New_York. UTC sauf si un fuseau a été défini.
object
requis

Propriétés

string
requis
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.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le prélèvement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais volontairement pas toujours : le COP est prélevé en centavos mais écrit en pesos entiers, il vaut donc 2 et 0. Utilisez cette valeur pour formater le nombre dans votre propre locale.
string
requis
Options disponibles : estimated, final
string
requis
Invoice