Ressources prises en charge

Découvrez les ressources et les exemples du fournisseur Stripe Terraform.

Utilisez ces exemples comme points de départ pour votre configuration Terraform. Chaque ressource inclut une brève description et un lien vers la documentation de l’API.

Compteurs de facturation

Les compteurs indiquent comment regrouper les événements des compteurs au cours d’une période de facturation.

resource "stripe_billing_meter" "api_calls" {
  display_name = "API Calls"
  event_name   = "api_call"

  default_aggregation {
    formula = "sum"
  }

  value_settings {
    event_payload_key = "value"
  }

  customer_mapping {
    type              = "by_id"
    event_payload_key = "stripe_customer_id"
  }
}

Documentation de l’API : Compteurs Billing

Champs du compteur de facturation

Champ	Description
`display_name`	Le nom du compteur. Non visible par le client.
`event_name`	Le nom de l’événement de mesure pour lequel l’utilisation doit être enregistrée. Correspond au champ `event_name` des événements de mesure.
`dimension_payload_keys`	Ensemble de clés utilisées pour regrouper les événements de mesure. Chaque clé doit être présente dans la charge utile de l’événement.
`event_time_window`	La période pour laquelle les événements de mesure ont été précompilés, le cas échéant.
`id`	ID de l’objet.
`customer_mapping.event_payload_key`	La clé de la charge utile de l’événement de mesure à utiliser pour mapper l’événement à un client.
`customer_mapping.type`	La méthode pour mapper un événement de mesure à un client. Doit être `by_id`.
`default_aggregation.formula`	Spécifie la manière dont les événements sont compilés. Les valeurs autorisées sont `count` pour compter le nombre d’événements, `sum` pour additionner la valeur de chaque événement et `last` pour prendre la valeur du dernier événement dans la fenêtre.
`value_settings.event_payload_key`	La clé de la charge utile de l’événement d’utilisation qui sert de valeur pour ce compteur. Par exemple, si la charge utile de l’événement contient une utilisation sur un champ `bytes_used`, définissez alors l’événement_payload_key sur « bytes_used ».

Bons de réduction

Un bon de réduction contient des informations sur le pourcentage ou le montant d’une réduction que vous souhaitez peut-être appliquer à un client.

resource "stripe_coupon" "launch_discount" {
  name        = "Launch discount"
  percent_off = 15
  duration    = "once"
}

Documentation de l’API : Bons de réduction

Champs bons de réduction

Champ	Description
`amount_off`	Entier positif représentant le montant à soustraire du total d’une facture (obligatoire si `percent_off` n’est pas transmis).
`currency`	Code ISO à trois lettres pour la devise du paramètre `amount_off` (obligatoire si `amount_off` est transmis).
`duration`	Indique la durée de la réduction en vigueur si elle est utilisée dans le cadre d’un abonnement. Sa valeur par défaut est `once`.
`duration_in_months`	Obligatoire uniquement si la `duration` est `repeating`, auquel cas il doit s’agir d’un nombre entier positif qui précise le nombre de mois pendant lesquels la réduction est en vigueur.
`id`	ID de l’objet.
`max_redemptions`	Nombre entier positif spécifiant le nombre de fois qu’un client peut utiliser un bon de réduction avant qu’il ne soit plus valide.
`metadata`	Ensemble de paires clé-valeur que vous pouvez associer à un objet. Cela est utile pour stocker des informations supplémentaires sur l’objet dans un format structuré.
`name`	Nom du bon de réduction affiché aux clients sur les factures ou reçus. Par défaut, l’`id` s’affiche si `name` n’est pas défini.
`percent_off`	Un flottant positif supérieur à 0 et inférieur ou égal à 100, qui représente la réduction appliquée par le bon de réduction (obligatoire si `amount_off` n’est pas transmis).
`redeem_by`	Horodatage Unix précisant la dernière heure à laquelle un client peut utiliser le bon de réduction.
`applies_to.products`	Un tableau d’ID de produit auxquels ce bon de réduction applique des réductions.
`currency_options.amount_off`	Entier positif représentant le montant à soustraire du total d’une facture.
`currency_options.key`	Clé d’option devise.
`script.configuration`	Les valeurs de configuration du script. Les clés et les valeurs sont spécifiques à l’implémentation du script.
`script.id`	L’ID d’implémentation du script pour ce bon de réduction.

Clients

Cet objet représente un client de votre entreprise.

resource "stripe_customer" "acme" {
  name  = "Acme Corp"
  email = "billing@acme.example"
}

Documentation de l’API : Clients

Champs client

Champ	Description
`balance`	Montant entier exprimé en centimes (ou équivalent local) qui représente le solde actuel du client.
`business_name`	Nom de l’entreprise.
`description`	Chaîne arbitraire que vous pouvez associer à un objet Customer. Elle s’affiche dans le Dashboard aux côtés du client.
`email`	Adresse e-mail du client. Elle s’affiche aux côtés de Customer dans votre Dashboard et est utile pour la recherche et le suivi.
`id`	ID de l’objet.
`individual_name`	Nom de la personne.
`invoice_prefix`	Le préfixe du client utilisé pour générer des numéros de facture uniques. Doit comporter 3 à 12 lettres majuscules ou chiffres.
`metadata`	Ensemble de paires clé-valeur que vous pouvez associer à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré.
`name`	Nom complet ou nom de l’entreprise du client.
`next_invoice_sequence`	La séquence à utiliser sur la prochaine facture du client. Sa valeur par défaut est 1.
`phone`	Le numéro de téléphone du client.
`preferred_locales`	Langues préférées du client, classées par ordre de préférence.
`tax_exempt`	L’exemption fiscale du client. Peut prendre pour valeur `none`, `exempt` ou `reverse`.
`test_clock`	ID de l’horloge de simulation à joindre au client.
`address.city`	Ville, district, banlieue, commune ou village.
`address.country`	Pays sous forme de texte libre ou de code pays à deux lettres.
`address.line1`	Ligne d’adresse 1 (par exemple, rue, boîte postale ou nom de l’entreprise).
`address.line2`	Ligne d’adresse 2 (par exemple, appartement, suite, unité ou immeuble).
`address.postal_code`	ZIP ou code postal.
`address.state`	État, comté, province ou région.
`cash_balance.settings.reconciliation_mode`	Contrôle la manière dont les fonds transférés par le client sont appliqués aux PaymentIntents et aux factures. Les options valides sont `automatic`, `manual` ou `merchant_default`.
`invoice_settings.custom_fields`	Champs personnalisé pour les factures.
`invoice_settings.default_payment_method`	ID d’un moyen de paiement associé au client, à utiliser comme moyen de paiement par défaut du client pour les abonnements et factures.
`invoice_settings.footer`	Pied de page par défaut à afficher sur les factures de ce client.
`invoice_settings.rendering_options.amount_tax_display`	Affichage des prix et des montants des postes en fonction des taxes sur les factures au format PDF. `exclude_tax` ou `include_inclusive_tax`.
`invoice_settings.rendering_options.template`	ID du modèle de rendu de facture à utiliser pour les prochaines factures.
`shipping.name`	Nom du client.
`shipping.phone`	Téléphone du client (extension comprise).
`shipping.address.city`	Ville, district, banlieue, commune ou village.
`shipping.address.country`	Pays sous forme de texte libre ou de code pays à deux lettres.
`shipping.address.line1`	Ligne d’adresse 1 (par exemple, rue, boîte postale ou nom de l’entreprise).
`shipping.address.line2`	Ligne d’adresse 2 (par exemple, appartement, suite, unité ou immeuble).
`shipping.address.postal_code`	ZIP ou code postal.
`shipping.address.state`	État, comté, province ou région.
`tax.ip_address`	Adresse IP client utilisée pour les taxes.
`tax.validate_location`	Un indicateur pour signifier que Stripe doit valider l’emplacement fiscal du client. Sa valeur par défaut est `deferred`.

Fonctionnalités des droits

Une fonctionnalité des droits représente une capacité ou fonctionnalité monétisable dans votre système.

resource "stripe_entitlements_feature" "premium_access" {
  lookup_key = "premium-access"
  name       = "Premium access"
}

Documentation de l’API : Fonctionnalités des droits

Champs des fonctionnalités des droits

Champ	Description
`id`	ID de l’objet.
`lookup_key`	Une clé unique que vous fournissez comme identifiant système. Elle peut comporter jusqu’à 80 caractères.
`metadata`	Ensemble de paires clé-valeur que vous pouvez associer à un objet. Cela est utile pour stocker des informations supplémentaires sur l’objet dans un format structuré.
`name`	Le nom de la fonctionnalité, pour votre propre usage, n’est pas destiné à être visible par le client.

Produits

Les produits décrivent les biens ou services que vous proposez à vos clients.

resource "stripe_product" "gold" {
  name = "Gold plan"
}

Documentation de l’API : Produits

Champs produit

Champ	Description
`active`	Si le produit est disponible à l’achat. Sa valeur par défaut est `true`.
`description`	Description du produit, destinée à être visible par le client.
`id`	ID de l’objet.
`images`	Une liste de 8 URL d’images maximum pour ce produit, destinée à être visible par le client.
`metadata`	Ensemble de paires clé-valeur que vous pouvez associer à un objet. Cela est utile pour stocker des informations supplémentaires sur l’objet dans un format structuré.
`name`	Le nom du produit, destiné à être visible par le client.
`shippable`	Si ce produit est expédié (biens matériels).
`statement_descriptor`	Chaîne arbitraire à afficher sur la carte bancaire ou les relevés bancaires de votre client. La description du relevé ne peut pas comporter les caractères `<`, `>`, `\`, `\"`, `'` ou apparaître sur le relevé de votre client en lettres majuscules. Les caractères non ASCII sont automatiquement retirés. La chaîne doit contenir au moins une lettre. Uniquement utilisé pour le paiement d’abonnements.
`tax_code`	Un numéro de code fiscal.
`type`	Le type du produit. Par défaut défini sur `service` s’il n’est pas spécifié explicitement.
`unit_label`	Libellé représentant les unités de ce produit.
`url`	URL d’une page Web accessible au public pour ce produit.
`marketing_features.name`	Nom de la fonctionnalité marketing. Jusqu’à 80 caractères.
`package_dimensions.height`	Hauteur, en pouces. La précision maximale est de 2 décimales.
`package_dimensions.length`	Longueur, en pouces. La précision maximale est de 2 décimales.
`package_dimensions.weight`	Poids, en onces. La précision maximale est de 2 décimales.
`package_dimensions.width`	Largeur, en pouces. La précision maximale est de 2 décimales.

Tarifs

Les tarifs déterminent le prix unitaire, la devise et (facultatif) le cycle de facturation des achats ponctuels et récurrents de produits.

resource "stripe_product" "gold" {
  name = "Gold plan"
}

resource "stripe_price" "gold_monthly" {
  product   = stripe_product.gold.id
  currency  = "usd"
  unit_amount = 2000
  recurring {
    interval = "month"
  }
}

Documentation de l’API : Tarifs

Champs tarifaires

Champ	Description
`active`	Détermine si le tarif peut être utilisé pour de nouveaux achats. Sa valeur par défaut est `true`.
`billing_scheme`	Décrit comment calculer le tarif par période. `per_unit` ou `tiered`.
`currency`	Code de devise ISO à trois lettres, en minuscules. Doit correspondre à une devise prise en charge.
`id`	ID de l’objet.
`lookup_key`	Clé de recherche permettant de récupérer les prix de manière dynamique à partir d’une chaîne statique. Peut comporter jusqu’à 200 caractères.
`metadata`	Ensemble de paires clé-valeur que vous pouvez associer à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré.
`nickname`	Une brève description du prix, cachée aux clients.
`product`	L’ID du Produit auquel appartient ce Prix.
`tax_behavior`	Indique si le prix est considéré TTC ou hors taxes. Peut prendre les valeurs `inclusive`, `exclusive` ou `unspecified`.
`tiers_mode`	Indique si le tarif progressif doit être `graduated` ou basé sur le `volume`.
`unit_amount`	Entier positif exprimé en centimes (ou équivalent local) (ou 0 pour un tarif gratuit) représentant le montant à débiter.
`currency_options.key`	Clé d’option devise.
`currency_options.tax_behavior`	Indique si le prix est considéré TTC ou hors taxes. Peut prendre les valeurs `inclusive`, `exclusive` ou `unspecified`.
`currency_options.tiers`	Chaque élément représente un niveau tarifaire. Ce paramètre nécessite que `billing_scheme` soit défini sur `tiered`.
`currency_options.unit_amount`	Entier positif exprimé en centimes (ou équivalent local) (ou 0 pour un tarif gratuit) représentant le montant à débiter.
`currency_options.custom_unit_amount.enabled`	Transmettez `true` pour activer `custom_unit_amount`, sinon omettez `custom_unit_amount`.
`currency_options.custom_unit_amount.maximum`	Le montant unitaire maximal que le client peut spécifier pour cet élément.
`currency_options.custom_unit_amount.minimum`	Le montant unitaire minimum que le client peut spécifier pour cet élément. Doit être au moins le montant du paiement minimum.
`currency_options.custom_unit_amount.preset`	Montant unitaire de départ que le client peut modifier.
`custom_unit_amount.maximum`	Le montant unitaire maximal que le client peut spécifier pour cet élément.
`custom_unit_amount.minimum`	Le montant unitaire minimum que le client peut spécifier pour cet élément. Doit être au moins le montant du paiement minimum.
`custom_unit_amount.preset`	Montant unitaire de départ que le client peut modifier.
`recurring.interval`	Spécifie la fréquence de facturation : `day`, `week`, `month` ou `year`.
`recurring.interval_count`	Le nombre d’intervalles entre les facturations d’abonnement.
`recurring.meter`	Le compteur qui suit l’utilisation d’un tarif à la consommation.
`recurring.trial_period_days`	Nombre de jours d’essai par défaut lors de l’abonnement d’un client à ce tarif en utilisant `trial_from_plan=true`.
`recurring.usage_type`	Définit la façon dont la quantité par période doit être déterminée. Peut être `metered` ou `licenced`.
`tiers.flat_amount`	Le montant facturé fixe pour un tout un niveau, quel que soit le nombre d’unités du niveau.
`tiers.flat_amount_decimal`	Identique à `flat_amount`, mais accepte une valeur décimale représentant un nombre entier dans les unités mineures de la devise.
`tiers.unit_amount`	Le montant facturé unitaire pour chaque unité à laquelle ce niveau s’applique.
`tiers.up_to`	La quantité maximale contenue dans ce niveau.

Frais de livraison

Les frais de livraison désignent le tarif de livraison proposé à vos clients et sont appliqués à l’achat.

resource "stripe_shipping_rate" "standard" {
  display_name = "Standard shipping"
  type         = "fixed_amount"

  fixed_amount {
    amount   = 500
    currency = "usd"
  }
}

Documentation de l’API : Frais de livraison

Champs des frais de livraison

Champ	Description
`display_name`	Nom du frais de livraison. destiné à être visible par le client.
`id`	ID de l’objet.
`metadata`	Ensemble de paires clé-valeur que vous pouvez associer à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré.
`tax_behavior`	Indique si le prix est considéré TTC ou hors taxes. Peut prendre les valeurs `inclusive`, `exclusive` ou `unspecified`.
`tax_code`	Un numéro de code fiscal.
`type`	Le type de calcul à utiliser pour les frais de livraison.
`delivery_estimate.maximum.unit`	Une unité de temps.
`delivery_estimate.maximum.value`	Doit être supérieur à 0.
`delivery_estimate.minimum.unit`	Une unité de temps.
`delivery_estimate.minimum.value`	Doit être supérieur à 0.
`fixed_amount.amount`	Entier non négatif exprimé en centimes représentant le montant à payer.
`fixed_amount.currency`	Code de devise ISO à trois lettres, en minuscules. Doit correspondre à une devise prise en charge.
`fixed_amount.currency_options.amount`	Entier non négatif exprimé en centimes représentant le montant à payer.
`fixed_amount.currency_options.key`	Clé d’option devise.
`fixed_amount.currency_options.tax_behavior`	Indique si le prix est considéré TTC ou hors taxes. Peut prendre les valeurs `inclusive`, `exclusive` ou `unspecified`.

Taux de taxe

Les taux de taxe peuvent être appliqués à des factures, des abonnements et des sessions Checkout pour encaisser des taxes.

resource "stripe_tax_rate" "state_sales_tax" {
  display_name = "CA Sales Tax"
  percentage   = 7.25
  inclusive    = false
}

Documentation de l’API : Taux de taxe

Champs taux de taxe

Champ	Description
`active`	Indicateur déterminant si le taux de taxe est actif ou inactif (archivé).
`country`	Code pays à deux lettres.
`description`	Chaîne arbitraire associée au taux de taxe pour votre usage interne uniquement. Vos clients ne la voient pas.
`display_name`	Le nom affiché du taux de taxe, qui est présenté aux clients.
`id`	ID de l’objet.
`inclusive`	Celle-ci précise si le taux de taxe est TTC ou hors taxes.
`jurisdiction`	La juridiction pour le taux de taxe. Vous pouvez utiliser ce champ de libellé facultatif à des fins fiscales. Il apparaît également sur la facture de votre client.
`metadata`	Ensemble de paires clé-valeur que vous pouvez associer à un objet. Cela peut être utile pour stocker des informations supplémentaires sur l’objet dans un format structuré.
`percentage`	Cela représente le taux de taxe en pourcentage.
`state`	Code de sous-section ISO 3166-2, sans préfixe de pays.
`tax_type`	Le type de taxe de haut niveau, comme `vat` ou `sales_tax`.

Endpoints de webhook

Vous pouvez configurer les endpoints de webhook à l’aide de l’API pour recevoir une notification des événements qui se produisent sur votre compte Stripe ou vos comptes connectés.

resource "stripe_webhook_endpoint" "primary" {
  url            = "https://example.com/stripe/webhooks"
  enabled_events = ["payment_intent.succeeded"]
}

Documentation de l’API : Endpoints webhook

Champs endpoint de webhook

Champ	Description
`api_version`	Les événements envoyés à cet endpoint sont générés avec cette version de Stripe au lieu de la version de Stripe par défaut de votre compte.
`description`	Description de l’endpoint de webhook.
`enabled_events`	La liste des événements à activer pour cet endpoint.
`id`	ID de l’objet.
`metadata`	Ensemble de paires clé-valeur que vous pouvez associer à un objet. Cela est utile pour stocker des informations supplémentaires sur l’objet dans un format structuré.
`url`	L’URL de l’endpoint de webhook.