Unterstützte Ressourcen

Erfahren Sie mehr über die Ressourcen und Beispiele des Stripe Terraform-Anbieters.

Verwenden Sie diese Beispiele als Ausgangspunkt für Ihre Terraform-Konfiguration. Jede Ressource enthält eine kurze Beschreibung und einen Link zur API-Dokumentation.

Abrechnungszähler

Zähler legen fest, wie Zählerereignisse über einen Rechnungsstellungszeitraum aggregiert werden.

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"
  }
}

API-Dokumentation: Abrechnungszähler

Abrechnungszählerfelder

Feld	Beschreibung
`display_name`	Der Name des Zählers. Für die Kundinnen und Kunden nicht sichtbar.
`event_name`	Der Name des Zählerereignisses, für das die Nutzung aufgezeichnet werden soll. Entspricht dem Feld `event_name` bei Zählerereignissen.
`dimension_payload_keys`	Satz von Schlüsseln, die zum Gruppieren von Zählerereignissen verwendet werden. Jeder Schlüssel muss in der Ereignis-Nutzlast vorhanden sein.
`event_time_window`	Das Zeitfenster, für das Zählerereignisse vorab aggregiert wurden, falls vorhanden.
`id`	ID des Objekts.
`customer_mapping.event_payload_key`	Der Schlüssel in der Zählerereignis-Nutzlast, der zum Zuordnen des Ereignisses zu einer Kundin oder einem Kunden verwendet wird.
`customer_mapping.type`	Die Methode zum Zuordnen eines Zählerereignisses zu einer Kundin oder einem Kunden. Muss `by_id` sein.
`default_aggregation.formula`	Gibt an, wie Ereignisse aggregiert werden. Zulässige Werte sind `Anzahl` zum Zählen der Anzahl der Ereignisse, `Summe` zum Summieren der Werte der einzelnen Ereignisse und `Letzter` zum Übernehmen des Werts des letzten Ereignisses im Fenster.
`value_settings.event_payload_key`	Der Schlüssel in der Nutzlast des Ereignisses, der als Wert für diesen Zähler verwendet werden soll. Wenn die Nutzlast des Ereignisses beispielsweise die Nutzung in einem Feld `bytes_used` enthält, setzen Sie „event_payload_key“ auf „bytes_used“.

Gutscheine

Ein Gutschein enthält Informationen über einen prozentualen oder betragsmäßigen Rabatt, den Sie möglicherweise auf Kundinnen und Kunden anwenden möchten.

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

API-Dokumentation: Gutscheine

Gutscheinfelder

Feld	Beschreibung
`amount_off`	Eine positive ganze Zahl, die den Betrag angibt, der vom Rechnungsbetrag abgezogen werden soll (erforderlich, wenn `percent_off` nicht übergeben wird).
`Währung`	Dreistelliger ISO-Code für die Währungen des Parameters `amount_off` (erforderlich, wenn `amount_off` übergeben wird).
`Dauer`	Gibt an, wie lange der Rabatt gilt, wenn er für ein Abo verwendet wird. Standardmäßig wird `einmal` verwendet.
`duration_in_months`	Nur erforderlich, wenn die `Dauer` `wiederholt` lautet. In diesem Fall muss es sich um eine positive Ganzzahl handeln, die die Anzahl der Monate angibt, in denen der Rabatt gilt.
`id`	ID des Objekts.
`max_redemptions`	Eine positive ganze Zahl, die angibt, wie oft eine Kundin bzw. ein Kunde einen Gutschein einlösen kann, bevor dieser ungültig wird.
`Metadaten`	Eine Reihe von Schlüsselwertpaaren, die Sie an ein Objekt anhängen können. Dies ist nützlich, um zusätzliche Informationen über das Objekt in einem strukturierten Format zu speichern.
`Name`	Der Name des Gutscheins, der den Kundinnen und Kunden auf Rechnungen oder Zahlungsbelegen angezeigt wird. Standardmäßig wird die `ID` angezeigt, wenn kein `Name` festgelegt ist.
`percent_off`	Ein positiver Float-Wert größer als 0 und kleiner oder gleich 100, der den Rabatt des Gutscheins angibt (erforderlich, wenn `amount_off` nicht übergeben wird).
`redeem_by`	Unix-Zeitstempel, der den letzten Zeitpunkt angibt, zu dem eine Kundin oder ein Kunde den Gutschein einlösen kann.
`applies_to.products`	Ein Array von Produkt-IDs, für die dieser Gutschein Rabatte gewährt.
`currency_options.amount_off`	Eine positive Ganzzahl, die den Betrag angibt, der vom Rechnungsbetrag abgezogen werden soll.
`currency_options.key`	Währungsoptionsschlüssel.
`script.configuration`	Die Konfigurationswerte des Scripts. Die Schlüssel und Werte sind spezifisch für die Script-Implementierung.
`script.id`	Die Script-Implementierungs-ID für diesen Gutschein.

Kundinnen und Kunden

Dieses Objekt stellt eine Kundin/einen Kunden Ihres Unternehmens dar.

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

API-Dokumentation: Kundinnen und Kunden

Kundenfelder

Feld	Beschreibung
`Guthaben`	Ein ganzzahliger Betrag in Cent (oder dem lokalen Äquivalent), der das aktuelle Guthaben der Kundinnen und Kunden darstellt.
`business_name`	Firmenname
`Beschreibung`	Eine beliebige Zeichenfolge, die Sie an ein Kundenobjekt anhängen können. Sie wird neben dem Kunden im Dashboard angezeigt.
`E-Mail`	E-Mail-Adresse der Kundin bzw. des Kunden. Sie wird neben der Kundin bzw. dem Kunden in Ihrem Dashboard angezeigt und ist für die Suche und Nachverfolgung nützlich.
`id`	ID des Objekts.
`individual_name`	Name der Einzelperson.
`invoice_prefix`	Das Präfix für die Kundinnen und Kunden, das zur Generierung eindeutiger Rechnungsnummern verwendet wird. Muss aus 3 bis 12 Großbuchstaben oder Zahlen bestehen.
`Metadaten`	Eine Reihe von Schlüssel-Wert-Paaren, die Sie an ein Objekt anhängen können. Dies kann nützlich sein, um zusätzliche Informationen über das Objekt in einem strukturierten Format zu speichern.
`Name`	Der vollständige Name oder Firmenname der Kundinnen und Kunden.
`next_invoice_sequence`	Die Sequenz, die auf der nächsten Rechnung der Kundinnen und Kunden verwendet werden soll. Der Standardwert ist 1.
`Telefon`	Die Telefonnummer der Kundinnen und Kunden.
`preferred_locales`	Die bevorzugten Sprachen der Kundinnen und Kunden, sortiert nach Präferenz.
`tax_exempt`	Die Steuerbefreiung der Kundinnen und Kunden. Eine der Optionen `keine`, `befreit` oder `Umkehrung`.
`test_clock`	ID der Test-Uhr, die den Kundinnen und Kunden zugeordnet werden soll.
`address.city`	Stadt, Bezirk, Vorort, Stadt oder Dorf.
`address.country`	Land als Freitext oder zweistelliger Ländercode.
`address.line1`	Adresszeile 1, z. B. Straße, Postfach oder Firmenname.
`address.line2`	Adresszeile 2, z. B. Wohnung, Suite, Einheit oder Gebäude.
`address.postal_code`	Postleitzahl.
`address.state`	Bundesstaat, Landkreis, Provinz oder Region.
`cash_balance.settings.reconciliation_mode`	Steuert, wie von Kundinnen und Kunden überwiesene Gelder auf Zahlungsabsichten und Rechnungen angewendet werden. Gültige Optionen sind `automatisch`, `manuell` oder `merchant_default`.
`invoice_settings.custom_fields`	Benutzerdefinierte Felder für Rechnungen.
`invoice_settings.default_payment_method`	ID einer Zahlungsmethode, die mit den Kundinnen und Kunden verknüpft ist und als Standardzahlungsmethode der Kundinnen und Kunden für Abo- und Rechnungszahlungen verwendet wird.
`invoice_settings.footer`	Standard-Fußzeile, die auf Rechnungen für diese Kundinnen und Kunden angezeigt werden soll.
`invoice_settings.rendering_options.amount_tax_display`	Wie Einzelpreise und -beträge in Bezug auf Steuern in Rechnungs-PDFs angezeigt werden. Entweder `exclude_tax` oder `include_inclusive_tax`.
`invoice_settings.rendering_options.template`	ID der Rechnungsvorlage, die für zukünftige Rechnungen verwendet werden soll.
`shipping.name`	Kundenname
`shipping.phone`	Kundentelefonnummer (einschließlich Durchwahl).
`shipping.address.city`	Stadt, Bezirk, Vorort, Stadt oder Dorf.
`shipping.address.country`	Land als Freitext oder zweistelliger Ländercode.
`shipping.address.line1`	Adresszeile 1, z. B. Straße, Postfach oder Firmenname.
`shipping.address.line2`	Adresszeile 2, z. B. Wohnung, Suite, Einheit oder Gebäude.
`shipping.address.postal_code`	Postleitzahl.
`shipping.address.state`	Bundesstaat, Landkreis, Provinz oder Region.
`tax.ip_address`	Die IP-Adresse der Kundinnen und Kunden wird für steuerliche Zwecke verwendet.
`tax.validate_location`	Eine Kennzeichnung, die angibt, wann Stripe den Steuerstandort der Kundinnen und Kunden überprüfen soll. Standardmäßig ist `aufgeschoben` eingestellt.

Berechtigungsfunktionen

Eine Berechtigungsfunktion stellt eine monetarisierbare Fähigkeit oder Funktionalität in Ihrem System dar.

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

API-Dokumentation: Berechtigungsfunktionen

Felder für Berechtigungsfunktionen

Feld	Beschreibung
`id`	ID des Objekts.
`lookup_key`	Ein eindeutiger Schlüssel, den Sie als Ihre eigene Systemkennung angeben. Dieser kann bis zu 80 Zeichen lang sein.
`Metadaten`	Eine Reihe von Schlüsselwertpaaren, die Sie an ein Objekt anhängen können. Dies ist nützlich, um zusätzliche Informationen über das Objekt in einem strukturierten Format zu speichern.
`Name`	Der Name der Funktion für Ihre eigenen Zwecke, der nicht für die Kundinnen und Kunden sichtbar sein soll.

Produkte

Produkte beschreiben die spezifischen Waren oder Dienstleistungen, die Sie Ihren Kundinnen und Kunden anbieten.

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

API-Dokumentation: Produkte

Produktfelder

Feld	Beschreibung
`aktiv`	Gibt an, ob das Produkt zum Kauf verfügbar ist. Standardmäßig auf `wahr` gesetzt.
`Beschreibung`	Die Produktbeschreibung, die den Kundinnen und Kunden angezeigt werden soll.
`id`	ID des Objekts.
`Abbildungen`	Eine Liste mit bis zu 8 URLs von Bildern für dieses Produkt, die den Kundinnen und Kunden angezeigt werden sollen.
`Metadaten`	Eine Reihe von Schlüsselwertpaaren, die Sie an ein Objekt anhängen können. Dies ist nützlich, um zusätzliche Informationen über das Objekt in einem strukturierten Format zu speichern.
`Name`	Der Produktname, der Kundinnen und Kunden angezeigt werden kann.
`lieferbar`	Angabe, ob dieses Produkt versandt wird (physische Waren).
`statement_descriptor`	Eine beliebige Zeichenfolge, die auf der Kreditkarten- oder Bankabrechnung Ihrer Kundinnen und Kunden angezeigt wird. Die Abrechnungsbeschreibung darf keine `<`, `>`, `\`, `\"`, `'` Zeichen enthalten und wird auf der Abrechnung Ihrer Kundinnen und Kunden in Großbuchstaben angezeigt. Nicht-ASCII-Zeichen werden automatisch entfernt. Sie muss mindestens einen Buchstaben enthalten. Wird nur für Abonnements verwendet.
`tax_code`	Eine Steuercode-ID.
`Typ`	Der Produkttyp. Standardmäßig `Dienstleistung`, sofern nicht ausdrücklich anders angegeben.
`unit_label`	Eine Bezeichnung, die die Einheiten dieses Produkts repräsentiert.
`URL`	Eine öffentlich zugängliche URL für dieses Produkt.
`marketing_features.name`	Der Name der Marketing-Funktion. Maximal 80 Zeichen lang.
`package_dimensions.height`	Höhe in Zoll. Maximale Genauigkeit beträgt 2 Dezimalstellen.
`package_dimensions.length`	Länge in Zoll. Maximale Genauigkeit beträgt 2 Dezimalstellen.
`package_dimensions.weight`	Gewicht in Unzen. Die maximale Genauigkeit beträgt 2 Dezimalstellen.
`package_dimensions.width`	Breite in Zoll. Die maximale Genauigkeit beträgt 2 Dezimalstellen.

Preise

Preise definieren die Stückkosten, die Währung und (optional) den Abrechnungszyklus für wiederkehrende und einmalige Produktkäufe.

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"
  }
}

API-Dokumentation: Preise

Preisfelder

Feld	Beschreibung
`aktiv`	Gibt an, ob der Preis für neue Käufe verwendet werden kann. Der Standardwert ist `wahr`.
`billing_scheme`	Beschreibt, wie der Preis pro Zeitraum berechnet wird. Entweder `per_unit` oder `gestaffelt`.
`Währung`	Dreistelliger ISO-Währungscode in Kleinbuchstaben. Es muss sich um eine unterstützte Währung handeln.
`id`	ID des Objekts.
`lookup_key`	Ein Suchschlüssel, der verwendet wird, um Preise dynamisch aus einer statischen Zeichenfolge abzurufen. Dies kann bis zu 200 Zeichen lang sein.
`Metadaten`	Eine Reihe von Schlüssel-Wert-Paaren, die Sie an ein Objekt anhängen können. Dies kann nützlich sein, um zusätzliche Informationen über das Objekt in einem strukturierten Format zu speichern.
`Kurzname`	Eine kurze Beschreibung des Preises, verborgen für Kundinnen und Kunden.
`Produkt`	Die ID des Produkts, zu dem dieser Preis gehört.
`tax_behavior`	Gibt an, ob der Preis inklusive Steuern oder exklusive Steuern gilt. `Inklusive`, `exklusive` oder `nicht angegebene`.
`tiers_mode`	Legt fest, ob der Staffelpreis `gestaffelt` oder `volumenbasiert` sein soll.
`unit_amount`	Eine positive ganze Zahl in Cent (oder dem lokalen Äquivalent) (oder 0 für einen kostenlosen Preis), die den zu berechnenden Betrag angibt.
`currency_options.key`	Währungsoptionsschlüssel.
`currency_options.tax_behavior`	Gibt an, ob der Preis inklusive Steuern oder exklusive Steuern gilt. `Inklusive`, `exklusive` oder `nicht angegebene`.
`currency_options.tiers`	Jedes Element steht für eine Preisstufe. Für diesen Parameter muss `billing_scheme` auf `gestaffelt` gesetzt sein.
`currency_options.unit_amount`	Eine positive ganze Zahl in Cent (oder dem lokalen Äquivalent) (oder 0 für einen kostenlosen Preis), die den zu berechnenden Betrag angibt.
`currency_options.custom_unit_amount.enabled`	Übergeben Sie `wahr`, um `custom_unit_amount` zu aktivieren, andernfalls lassen Sie `custom_unit_amount` weg.
`currency_options.custom_unit_amount.maximum`	Der maximale Einheitsbetrag, den die Kundin bzw. der Kunde für diesen Posten angeben kann.
`currency_options.custom_unit_amount.minimum`	Der Mindestbetrag pro Einheit, den die Kundin bzw. der Kunde für diesen Posten angeben kann. Muss mindestens dem Mindestbetrag entsprechen.
`currency_options.custom_unit_amount.preset`	Der Startbetrag pro Einheit, der von den Kundinnen und Kunden aktualisiert werden kann.
`custom_unit_amount.maximum`	Der maximale Einheitsbetrag, den die Kundin bzw. der Kunde für diesen Posten angeben kann.
`custom_unit_amount.minimum`	Der Mindestbetrag pro Einheit, den die Kundin bzw. der Kunde für diesen Posten angeben kann. Muss mindestens dem Mindestbetrag entsprechen.
`custom_unit_amount.preset`	Der Startbetrag pro Einheit, der von den Kundinnen und Kunden aktualisiert werden kann.
`recurring.interval`	Gibt die Abrechnungshäufigkeit an. Entweder `Tag`, `Woche`, `Monat` oder `Jahr`.
`recurring.interval_count`	Die Anzahl der Intervalle zwischen den Abo-Abrechnungen.
`recurring.meter`	Der Zähler, der die Nutzung eines gemessenen Preises erfasst.
`recurring.trial_period_days`	Standardanzahl der Testzeiträume, wenn eine Kundin bzw. ein Kunde diesen Preis mit `trial_from_plan=true` abonniert.
`recurring.usage_type`	Konfiguriert, wie die Menge pro Zeitraum bestimmt werden soll. Kann entweder `gemessen` oder `lizenziert` sein.
`tiers.flat_amount`	Der pauschale Rechnungsbetrag für eine gesamte Stufe, unabhängig von der Anzahl der Einheiten in dieser Stufe.
`tiers.flat_amount_decimal`	Entspricht `flat_amount`, akzeptiert jedoch einen Dezimalwert, der eine ganze Zahl in den kleineren Einheiten der Währung darstellt.
`tiers.unit_amount`	Der Rechnungsbetrag pro Einheit für jede einzelne Einheit, für die diese Stufe gilt.
`tiers.up_to`	Die maximale Menge, die in dieser Stufe enthalten ist.

Versandkosten

Versandkosten beschreiben den Preis für den Versand, der Ihren Kundinnen und Kunden angezeigt und auf einen Kauf angewendet wird.

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

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

API-Dokumentation: Versandgebühren

Felder für Versandkosten

Feld	Beschreibung
`display_name`	Der Name der Versandkosten, der für die Kundinnen und Kunden sichtbar sein soll.
`id`	ID des Objekts.
`Metadaten`	Eine Reihe von Schlüssel-Wert-Paaren, die Sie an ein Objekt anhängen können. Dies kann nützlich sein, um zusätzliche Informationen über das Objekt in einem strukturierten Format zu speichern.
`tax_behavior`	Gibt an, ob die Kosten inklusive oder exklusive Steuern sind. Eine der Optionen ist `inklusive`, `exklusive` oder `nicht angegeben`.
`tax_code`	Eine Steuercode-ID.
`Typ`	Die Art der Berechnung, die für die Versandgebühren verwendet werden soll.
`delivery_estimate.maximum.unit`	Eine Zeiteinheit.
`delivery_estimate.maximum.value`	Muss größer als 0 USD sein.
`delivery_estimate.minimum.unit`	Eine Zeiteinheit.
`delivery_estimate.minimum.value`	Muss größer als 0 USD sein.
`fixed_amount.amount`	Eine nicht negative Ganzzahl in Cent, die den zu berechnenden Betrag angibt.
`fixed_amount.currency`	Dreistelliger ISO-Währungscode in Kleinbuchstaben. Es muss sich um eine unterstützte Währung handeln.
`fixed_amount.currency_options.amount`	Eine nicht negative Ganzzahl in Cent, die den zu berechnenden Betrag angibt.
`fixed_amount.currency_options.key`	Währungsoptionsschlüssel.
`fixed_amount.currency_options.tax_behavior`	Gibt an, ob die Kosten inklusive oder exklusive Steuern sind. Eine der Optionen ist `inklusive`, `exklusive` oder `nicht angegeben`.

Steuersätze

Steuersätze können auf Rechnungen, Abos und Checkout-Sitzungen angewendet werden, um Steuern zu erheben.

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

API-Dokumentation: Steuersätze

Felder für Steuersätze

Feld	Beschreibung
`aktiv`	Eine Kennzeichnung, die angibt, ob der Steuersatz aktiv oder inaktiv (archiviert) ist.
`Land`	Zweistelliger Ländercode.
`Beschreibung`	Eine beliebige Zeichenfolge, die dem Steuersatz für Ihre interne Verwendung hinzugefügt wird. Sie ist für Ihre Kundinnen und Kunden nicht sichtbar.
`display_name`	Der Anzeigename des Steuersatzes, der den Kundinnen und Kunden angezeigt wird.
`id`	ID des Objekts.
`Inklusive`	Hier wird angegeben, ob der Steuersatz inklusive oder exklusive ist.
`Zuständigkeitsbereich`	Der Zuständigkeitsbereich für den Steuersatz. Dieses Kennzeichnungsfeld kann für Steuererklärungszwecke verwendet werden. Es erscheint auch auf der Rechnung Ihrer Kundinnen und Kunden.
`Metadaten`	Eine Reihe von Schlüssel-Wert-Paaren, die Sie an ein Objekt anhängen können. Dies kann nützlich sein, um zusätzliche Informationen über das Objekt in einem strukturierten Format zu speichern.
`Prozentsatz`	Dies entspricht dem Steuersatz von 100.
`Bundesstaat`	ISO 3166-2-Unterteilungscode ohne Ländervorwahl.
`tax_type`	Die übergeordnete Steuerart, wie beispielsweise `Umsatzsteuer` oder `sales_tax`.

Webhook-Endpoints

Sie können Webhook-Endpoints über die API konfigurieren, um über Ereignisse in Ihrem Stripe-Konto oder verbundenen Konten benachrichtigt zu werden.

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

API-Dokumentation: Webhook-Endpoints

Felder für Webhook-Endpoints

Feld	Beschreibung
`api_version`	An diesen Endpoint gesendete Ereignisse werden mit dieser Stripe-Version anstelle der Standard-Stripe-Version Ihres Konto generiert.
`Beschreibung`	Beschreibung des Webhook-Endpoints.
`enabled_events`	Die Liste der Ereignisse, die für diesen Endpoint aktiviert werden sollen.
`id`	ID des Objekts.
`Metadaten`	Eine Reihe von Schlüsselwertpaaren, die Sie an ein Objekt anhängen können. Dies ist nützlich, um zusätzliche Informationen über das Objekt in einem strukturierten Format zu speichern.
`URL`	Die URL des Webhook-Endpoints.