Prévisualiser une facture

Vous pouvez créer un aperçu d’une facture pour votre client lorsqu’il envisage d’effectuer un achat. La création d’un aperçu permet de calculer le montant total de la facture, d’en récupérer chaque poste et d’inclure toutes les taxes ou remises pertinentes. Créer un aperçu vous permet d’indiquer le montant total du paiement à votre client sans qu’il soit nécessaire de créer une facture.

Par exemple, si vous gérez une société qui fournit des services de réparation aux entreprises, vous pouvez présenter à vos clients plusieurs articles qui ont chacun des tarifs et des calendriers de facturation différents :

• Article 1 : frais de service ponctuels (299 USD)
• Article 2 : matériel de réparation A (29 USD)
• Article 3 : matériel de réparation B (99 USD)
• Article 4 : offre de support (49 USD par mois)

Les clients pourraient vouloir savoir combien coûtent les différentes combinaisons de vos biens et services. S’ils ont l’intention d’acheter les articles 1 et 3 tout en appliquant le code promo WINTERSALE pour une réduction de 15 %, lancez l’appel à l’API suivant :

curl https://api.stripe.com/v1/invoices/create_preview \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "invoice_items[0][price]"=price_item_1 \
  -d "invoice_items[0][quantity]"=1 \
  -d "invoice_items[1][price]"=price_item_3 \
  -d "invoice_items[1][quantity]"=1 \
  -d "discounts[0][promotion_code]"=promo_WINTERSALE

Stripe renvoie un aperçu de la facture avec chacun des postes, avec la remise appliquée et le montant total :

{
  "id": "upcoming_in_1OujwkClCIKljWvsq5v2ICAN",
  "object": "invoice",
  "account_country": "US",
  "account_name": "Stripe Docs",
  "account_tax_ids": null,
  "amount_due": 39800,
  "amount_paid": 0,
  "amount_remaining": 39800,
  "amount_shipping": 0,

En outre, l’aperçu de la facture qui en résulte peut être récupéré par l’endpoint /v1/invoices/:id durant les 72 heures suivantes :

curl https://api.stripe.com/v1/invoices/upcoming_in_1OujwkClCIKljWvsq5v2ICAN \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"

Inclure Stripe Tax

Pour prévisualiser les montants des taxes dans Stripe Tax, définissez automatic_tax[enabled] = true et transmettez l’adresse du client dans customer_details[address] :

curl https://api.stripe.com/v1/invoices/create_preview \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "customer_details[address][line1]"="920 5th Ave" \
  -d "customer_details[address][city]"=Seattle \
  -d "customer_details[address][state]"=WA \
  -d "customer_details[address][postal_code]"=98104 \
  -d "customer_details[address][country]"=US \
  -d "automatic_tax[enabled]"=true \
  -d "invoice_items[0][price]"=price_item_1 \
  -d "invoice_items[0][quantity]"=1 \
  -d "invoice_items[1][price]"=price_item_3 \
  -d "invoice_items[1][quantity]"=1 \
  -d "discounts[0][promotion_code]"=promo_WINTERSALE

Aperçu des factures avec les abonnements

Pour prévisualiser la première facture avec un tarif récurrent, utilisez le paramètre subscription_details.items :

curl https://api.stripe.com/v1/invoices/create_preview \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "subscription_details[items][0][price]"=price_recurring_4 \
  -d "subscription_details[items][0][quantity]"=1 \
  -d "invoice_items[0][price]"=price_item_1 \
  -d "invoice_items[0][quantity]"=1 \
  -d "invoice_items[1][price]"=price_item_3 \
  -d "invoice_items[1][quantity]"=1 \
  -d "discounts[0][promotion_code]"=promo_WINTERSALE

Pour prévisualiser les modifications apportées à un abonnement existant, indiquez l’identifiant de l’abonnement ou de la planification d’abonnement.

Aperçu des frais récurrents uniquement

Votre client peut avoir besoin d’un abonnement récurrent accompagné d’articles ponctuels, de crédits temporaires ou de remises à utiliser lors de son achat. S’il souhaite connaître le montant des frais récurrents après les éventuels réajustements, utilisez le paramètre preview_mode pour qu’il obtienne un aperçu du total.

Par exemple, si WINTERSALE est une remise ponctuelle de 15 % et que le client souhaite acheter les articles 1, 3 et 4, vous pouvez récupérer le montant des frais récurrents avec l’appel à l’API suivant :

curl https://api.stripe.com/v1/invoices/create_preview \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d preview_mode=recurring \
  -d "subscription_details[items][0][price]"=price_recurring_4 \
  -d "subscription_details[items][0][quantity]"=1 \
  -d "invoice_items[0][price]"=price_item_1 \
  -d "invoice_items[0][quantity]"=1 \
  -d "invoice_items[1][price]"=price_item_3 \
  -d "invoice_items[1][quantity]"=1 \
  -d "discounts[0][promotion_code]"=promo_WINTERSALE

La facture qui en résulte ne contient que l’offre de support à 49 USD par mois, sans aucune remise. De même, vous pouvez combiner preview_mode avec subscription ou subscription_schedule pour afficher les frais récurrents prévus, à l’exclusion des articles ponctuels et des remises.

Pagination des postes de facture

Pour les factures comportant plus de 10 postes, vous pouvez obtenir une vue paginée des postes :

curl https://api.stripe.com/v1/invoices/upcoming_in_1OujwkClCIKljWvsq5v2ICAN/lines \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"