Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Stripe Provider
  4. API Docs
  5. Invoice
Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

stripe.Invoice

Viewing docs for Stripe 0.3.0
published on Friday, Aug 14, 2026 by Pulumi
Schema (JSON)
stripe/terraform-provider-stripe

    Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.

    They contain invoice items, and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary).

    If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, when automatic, does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice.

    If your invoice is configured to be billed by sending an email, then based on your email settings, Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice.

    Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe’s minimum allowed charge per currency, the invoice is automatically marked paid, and we add the amount due to the customer’s credit balance which is applied to the next invoice.

    More details on the customer’s credit balance are here.

    Related guide: Send invoices to customers

    Create Invoice Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Invoice(name: string, args?: InvoiceArgs, opts?: CustomResourceOptions);
    @overload
def Invoice(resource_name: str,
            args: Optional[InvoiceArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Invoice(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            account_tax_ids: Optional[Sequence[str]] = None,
            application_fee_amount: Optional[float] = None,
            auto_advance: Optional[bool] = None,
            automatic_tax: Optional[InvoiceAutomaticTaxArgs] = None,
            automatically_finalizes_at: Optional[float] = None,
            collection_method: Optional[str] = None,
            currency: Optional[str] = None,
            custom_fields: Optional[Sequence[InvoiceCustomFieldArgs]] = None,
            customer: Optional[str] = None,
            customer_account: Optional[str] = None,
            days_until_due: Optional[float] = None,
            default_payment_method: Optional[str] = None,
            default_source: Optional[str] = None,
            default_tax_rates: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            discounts: Optional[Sequence[InvoiceDiscountArgs]] = None,
            due_date: Optional[float] = None,
            effective_at: Optional[float] = None,
            footer: Optional[str] = None,
            from_invoice: Optional[InvoiceFromInvoiceArgs] = None,
            issuer: Optional[InvoiceIssuerArgs] = None,
            metadata: Optional[Mapping[str, str]] = None,
            number: Optional[str] = None,
            on_behalf_of: Optional[str] = None,
            payment_settings: Optional[InvoicePaymentSettingsArgs] = None,
            pending_invoice_items_behavior: Optional[str] = None,
            rendering: Optional[InvoiceRenderingArgs] = None,
            shipping_cost: Optional[InvoiceShippingCostArgs] = None,
            shipping_details: Optional[InvoiceShippingDetailsArgs] = None,
            statement_descriptor: Optional[str] = None,
            subscription: Optional[str] = None,
            transfer_data: Optional[InvoiceTransferDataArgs] = None)
    func NewInvoice(ctx *Context, name string, args *InvoiceArgs, opts ...ResourceOption) (*Invoice, error)
    public Invoice(string name, InvoiceArgs? args = null, CustomResourceOptions? opts = null)
    public Invoice(String name, InvoiceArgs args)
public Invoice(String name, InvoiceArgs args, CustomResourceOptions options)

    type: stripe:Invoice
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "stripe_invoice" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args InvoiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InvoiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InvoiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InvoiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InvoiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var invoiceResource = new Stripe.Invoice("invoiceResource", new()
{
    AccountTaxIds = new[]
    {
        "string",
    },
    ApplicationFeeAmount = 0.0,
    AutoAdvance = false,
    AutomaticTax = new Stripe.Inputs.InvoiceAutomaticTaxArgs
    {
        Enabled = false,
        DisabledReason = "string",
        Liability = new Stripe.Inputs.InvoiceAutomaticTaxLiabilityArgs
        {
            Type = "string",
            Account = "string",
        },
        Provider = "string",
        Status = "string",
    },
    AutomaticallyFinalizesAt = 0.0,
    CollectionMethod = "string",
    Currency = "string",
    CustomFields = new[]
    {
        new Stripe.Inputs.InvoiceCustomFieldArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    Customer = "string",
    CustomerAccount = "string",
    DaysUntilDue = 0.0,
    DefaultPaymentMethod = "string",
    DefaultSource = "string",
    DefaultTaxRates = new[]
    {
        "string",
    },
    Description = "string",
    Discounts = new[]
    {
        new Stripe.Inputs.InvoiceDiscountArgs
        {
            Coupon = "string",
            Discount = "string",
            PromotionCode = "string",
        },
    },
    DueDate = 0.0,
    EffectiveAt = 0.0,
    Footer = "string",
    FromInvoice = new Stripe.Inputs.InvoiceFromInvoiceArgs
    {
        Action = "string",
        Invoice = "string",
    },
    Issuer = new Stripe.Inputs.InvoiceIssuerArgs
    {
        Type = "string",
        Account = "string",
    },
    Metadata = 
    {
        { "string", "string" },
    },
    Number = "string",
    OnBehalfOf = "string",
    PaymentSettings = new Stripe.Inputs.InvoicePaymentSettingsArgs
    {
        DefaultMandate = "string",
        PaymentMethodOptions = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsArgs
        {
            AcssDebit = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsAcssDebitArgs
            {
                MandateOptions = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsArgs
                {
                    TransactionType = "string",
                },
                VerificationMethod = "string",
            },
            Bancontact = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsBancontactArgs
            {
                PreferredLanguage = "string",
            },
            Card = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsCardArgs
            {
                Installments = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsArgs
                {
                    Enabled = false,
                    Plan = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlanArgs
                    {
                        Type = "string",
                        Count = 0.0,
                        Interval = "string",
                    },
                },
                RequestThreeDSecure = "string",
            },
            CustomerBalance = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceArgs
            {
                BankTransfer = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferArgs
                {
                    EuBankTransfer = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferArgs
                    {
                        Country = "string",
                    },
                    Type = "string",
                },
                FundingType = "string",
            },
            Payto = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsPaytoArgs
            {
                MandateOptions = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsPaytoMandateOptionsArgs
                {
                    Amount = 0.0,
                    AmountType = "string",
                    Purpose = "string",
                },
            },
            Pix = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsPixArgs
            {
                AmountIncludesIof = "string",
                ExpiresAfterSeconds = 0.0,
            },
            Upi = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsUpiArgs
            {
                MandateOptions = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsUpiMandateOptionsArgs
                {
                    Amount = 0.0,
                    AmountType = "string",
                    Description = "string",
                    EndDate = 0.0,
                },
            },
            UsBankAccount = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountArgs
            {
                FinancialConnections = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs
                {
                    Filters = new Stripe.Inputs.InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs
                    {
                        AccountSubcategories = new[]
                        {
                            "string",
                        },
                    },
                    Permissions = new[]
                    {
                        "string",
                    },
                    Prefetches = new[]
                    {
                        "string",
                    },
                },
                VerificationMethod = "string",
            },
        },
        PaymentMethodTypes = new[]
        {
            "string",
        },
    },
    PendingInvoiceItemsBehavior = "string",
    Rendering = new Stripe.Inputs.InvoiceRenderingArgs
    {
        AmountTaxDisplay = "string",
        Pdf = new Stripe.Inputs.InvoiceRenderingPdfArgs
        {
            PageSize = "string",
        },
        Template = "string",
        TemplateVersion = 0.0,
    },
    ShippingCost = new Stripe.Inputs.InvoiceShippingCostArgs
    {
        AmountSubtotal = 0.0,
        AmountTax = 0.0,
        AmountTotal = 0.0,
        ShippingRate = "string",
        ShippingRateData = new Stripe.Inputs.InvoiceShippingCostShippingRateDataArgs
        {
            DisplayName = "string",
            DeliveryEstimate = new Stripe.Inputs.InvoiceShippingCostShippingRateDataDeliveryEstimateArgs
            {
                Maximum = new Stripe.Inputs.InvoiceShippingCostShippingRateDataDeliveryEstimateMaximumArgs
                {
                    Unit = "string",
                    Value = 0.0,
                },
                Minimum = new Stripe.Inputs.InvoiceShippingCostShippingRateDataDeliveryEstimateMinimumArgs
                {
                    Unit = "string",
                    Value = 0.0,
                },
            },
            FixedAmount = new Stripe.Inputs.InvoiceShippingCostShippingRateDataFixedAmountArgs
            {
                Amount = 0.0,
                Currency = "string",
                CurrencyOptions = 
                {
                    { "string", new Stripe.Inputs.InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptionsArgs
                    {
                        Amount = 0.0,
                        TaxBehavior = "string",
                    } },
                },
            },
            Metadata = 
            {
                { "string", "string" },
            },
            TaxBehavior = "string",
            TaxCode = "string",
            Type = "string",
        },
        Taxes = new[]
        {
            new Stripe.Inputs.InvoiceShippingCostTaxArgs
            {
                Amount = 0.0,
                Rate = "string",
                TaxabilityReason = "string",
                TaxableAmount = 0.0,
            },
        },
    },
    ShippingDetails = new Stripe.Inputs.InvoiceShippingDetailsArgs
    {
        Address = new Stripe.Inputs.InvoiceShippingDetailsAddressArgs
        {
            City = "string",
            Country = "string",
            Line1 = "string",
            Line2 = "string",
            PostalCode = "string",
            State = "string",
        },
        Name = "string",
        Carrier = "string",
        Phone = "string",
        TrackingNumber = "string",
    },
    StatementDescriptor = "string",
    Subscription = "string",
    TransferData = new Stripe.Inputs.InvoiceTransferDataArgs
    {
        Destination = "string",
        Amount = 0.0,
    },
});

    example, err := stripe.NewInvoice(ctx, "invoiceResource", &stripe.InvoiceArgs{
	AccountTaxIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApplicationFeeAmount: pulumi.Float64(0),
	AutoAdvance:          pulumi.Bool(false),
	AutomaticTax: &stripe.InvoiceAutomaticTaxArgs{
		Enabled:        pulumi.Bool(false),
		DisabledReason: pulumi.String("string"),
		Liability: &stripe.InvoiceAutomaticTaxLiabilityArgs{
			Type:    pulumi.String("string"),
			Account: pulumi.String("string"),
		},
		Provider: pulumi.String("string"),
		Status:   pulumi.String("string"),
	},
	AutomaticallyFinalizesAt: pulumi.Float64(0),
	CollectionMethod:         pulumi.String("string"),
	Currency:                 pulumi.String("string"),
	CustomFields: stripe.InvoiceCustomFieldArray{
		&stripe.InvoiceCustomFieldArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Customer:             pulumi.String("string"),
	CustomerAccount:      pulumi.String("string"),
	DaysUntilDue:         pulumi.Float64(0),
	DefaultPaymentMethod: pulumi.String("string"),
	DefaultSource:        pulumi.String("string"),
	DefaultTaxRates: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Discounts: stripe.InvoiceDiscountArray{
		&stripe.InvoiceDiscountArgs{
			Coupon:        pulumi.String("string"),
			Discount:      pulumi.String("string"),
			PromotionCode: pulumi.String("string"),
		},
	},
	DueDate:     pulumi.Float64(0),
	EffectiveAt: pulumi.Float64(0),
	Footer:      pulumi.String("string"),
	FromInvoice: &stripe.InvoiceFromInvoiceArgs{
		Action:  pulumi.String("string"),
		Invoice: pulumi.String("string"),
	},
	Issuer: &stripe.InvoiceIssuerArgs{
		Type:    pulumi.String("string"),
		Account: pulumi.String("string"),
	},
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Number:     pulumi.String("string"),
	OnBehalfOf: pulumi.String("string"),
	PaymentSettings: &stripe.InvoicePaymentSettingsArgs{
		DefaultMandate: pulumi.String("string"),
		PaymentMethodOptions: &stripe.InvoicePaymentSettingsPaymentMethodOptionsArgs{
			AcssDebit: &stripe.InvoicePaymentSettingsPaymentMethodOptionsAcssDebitArgs{
				MandateOptions: &stripe.InvoicePaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsArgs{
					TransactionType: pulumi.String("string"),
				},
				VerificationMethod: pulumi.String("string"),
			},
			Bancontact: &stripe.InvoicePaymentSettingsPaymentMethodOptionsBancontactArgs{
				PreferredLanguage: pulumi.String("string"),
			},
			Card: &stripe.InvoicePaymentSettingsPaymentMethodOptionsCardArgs{
				Installments: &stripe.InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsArgs{
					Enabled: pulumi.Bool(false),
					Plan: &stripe.InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlanArgs{
						Type:     pulumi.String("string"),
						Count:    pulumi.Float64(0),
						Interval: pulumi.String("string"),
					},
				},
				RequestThreeDSecure: pulumi.String("string"),
			},
			CustomerBalance: &stripe.InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceArgs{
				BankTransfer: &stripe.InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferArgs{
					EuBankTransfer: &stripe.InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferArgs{
						Country: pulumi.String("string"),
					},
					Type: pulumi.String("string"),
				},
				FundingType: pulumi.String("string"),
			},
			Payto: &stripe.InvoicePaymentSettingsPaymentMethodOptionsPaytoArgs{
				MandateOptions: &stripe.InvoicePaymentSettingsPaymentMethodOptionsPaytoMandateOptionsArgs{
					Amount:     pulumi.Float64(0),
					AmountType: pulumi.String("string"),
					Purpose:    pulumi.String("string"),
				},
			},
			Pix: &stripe.InvoicePaymentSettingsPaymentMethodOptionsPixArgs{
				AmountIncludesIof:   pulumi.String("string"),
				ExpiresAfterSeconds: pulumi.Float64(0),
			},
			Upi: &stripe.InvoicePaymentSettingsPaymentMethodOptionsUpiArgs{
				MandateOptions: &stripe.InvoicePaymentSettingsPaymentMethodOptionsUpiMandateOptionsArgs{
					Amount:      pulumi.Float64(0),
					AmountType:  pulumi.String("string"),
					Description: pulumi.String("string"),
					EndDate:     pulumi.Float64(0),
				},
			},
			UsBankAccount: &stripe.InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountArgs{
				FinancialConnections: &stripe.InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs{
					Filters: &stripe.InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs{
						AccountSubcategories: pulumi.StringArray{
							pulumi.String("string"),
						},
					},
					Permissions: pulumi.StringArray{
						pulumi.String("string"),
					},
					Prefetches: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
				VerificationMethod: pulumi.String("string"),
			},
		},
		PaymentMethodTypes: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	PendingInvoiceItemsBehavior: pulumi.String("string"),
	Rendering: &stripe.InvoiceRenderingArgs{
		AmountTaxDisplay: pulumi.String("string"),
		Pdf: &stripe.InvoiceRenderingPdfArgs{
			PageSize: pulumi.String("string"),
		},
		Template:        pulumi.String("string"),
		TemplateVersion: pulumi.Float64(0),
	},
	ShippingCost: &stripe.InvoiceShippingCostArgs{
		AmountSubtotal: pulumi.Float64(0),
		AmountTax:      pulumi.Float64(0),
		AmountTotal:    pulumi.Float64(0),
		ShippingRate:   pulumi.String("string"),
		ShippingRateData: &stripe.InvoiceShippingCostShippingRateDataArgs{
			DisplayName: pulumi.String("string"),
			DeliveryEstimate: &stripe.InvoiceShippingCostShippingRateDataDeliveryEstimateArgs{
				Maximum: &stripe.InvoiceShippingCostShippingRateDataDeliveryEstimateMaximumArgs{
					Unit:  pulumi.String("string"),
					Value: pulumi.Float64(0),
				},
				Minimum: &stripe.InvoiceShippingCostShippingRateDataDeliveryEstimateMinimumArgs{
					Unit:  pulumi.String("string"),
					Value: pulumi.Float64(0),
				},
			},
			FixedAmount: &stripe.InvoiceShippingCostShippingRateDataFixedAmountArgs{
				Amount:   pulumi.Float64(0),
				Currency: pulumi.String("string"),
				CurrencyOptions: stripe.InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptionsMap{
					"string": &stripe.InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptionsArgs{
						Amount:      pulumi.Float64(0),
						TaxBehavior: pulumi.String("string"),
					},
				},
			},
			Metadata: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			TaxBehavior: pulumi.String("string"),
			TaxCode:     pulumi.String("string"),
			Type:        pulumi.String("string"),
		},
		Taxes: stripe.InvoiceShippingCostTaxArray{
			&stripe.InvoiceShippingCostTaxArgs{
				Amount:           pulumi.Float64(0),
				Rate:             pulumi.String("string"),
				TaxabilityReason: pulumi.String("string"),
				TaxableAmount:    pulumi.Float64(0),
			},
		},
	},
	ShippingDetails: &stripe.InvoiceShippingDetailsArgs{
		Address: &stripe.InvoiceShippingDetailsAddressArgs{
			City:       pulumi.String("string"),
			Country:    pulumi.String("string"),
			Line1:      pulumi.String("string"),
			Line2:      pulumi.String("string"),
			PostalCode: pulumi.String("string"),
			State:      pulumi.String("string"),
		},
		Name:           pulumi.String("string"),
		Carrier:        pulumi.String("string"),
		Phone:          pulumi.String("string"),
		TrackingNumber: pulumi.String("string"),
	},
	StatementDescriptor: pulumi.String("string"),
	Subscription:        pulumi.String("string"),
	TransferData: &stripe.InvoiceTransferDataArgs{
		Destination: pulumi.String("string"),
		Amount:      pulumi.Float64(0),
	},
})

    resource "stripe_invoice" "invoiceResource" {
  lifecycle {
    create_before_destroy = true
  }
  account_tax_ids        = ["string"]
  application_fee_amount = 0
  auto_advance           = false
  automatic_tax = {
    enabled         = false
    disabled_reason = "string"
    liability = {
      type    = "string"
      account = "string"
    }
    provider = "string"
    status   = "string"
  }
  automatically_finalizes_at = 0
  collection_method          = "string"
  currency                   = "string"
  custom_fields {
    name  = "string"
    value = "string"
  }
  customer               = "string"
  customer_account       = "string"
  days_until_due         = 0
  default_payment_method = "string"
  default_source         = "string"
  default_tax_rates      = ["string"]
  description            = "string"
  discounts {
    coupon         = "string"
    discount       = "string"
    promotion_code = "string"
  }
  due_date     = 0
  effective_at = 0
  footer       = "string"
  from_invoice = {
    action  = "string"
    invoice = "string"
  }
  issuer = {
    type    = "string"
    account = "string"
  }
  metadata = {
    "string" = "string"
  }
  number       = "string"
  on_behalf_of = "string"
  payment_settings = {
    default_mandate = "string"
    payment_method_options = {
      acss_debit = {
        mandate_options = {
          transaction_type = "string"
        }
        verification_method = "string"
      }
      bancontact = {
        preferred_language = "string"
      }
      card = {
        installments = {
          enabled = false
          plan = {
            type     = "string"
            count    = 0
            interval = "string"
          }
        }
        request_three_d_secure = "string"
      }
      customer_balance = {
        bank_transfer = {
          eu_bank_transfer = {
            country = "string"
          }
          type = "string"
        }
        funding_type = "string"
      }
      payto = {
        mandate_options = {
          amount      = 0
          amount_type = "string"
          purpose     = "string"
        }
      }
      pix = {
        amount_includes_iof   = "string"
        expires_after_seconds = 0
      }
      upi = {
        mandate_options = {
          amount      = 0
          amount_type = "string"
          description = "string"
          end_date    = 0
        }
      }
      us_bank_account = {
        financial_connections = {
          filters = {
            account_subcategories = ["string"]
          }
          permissions = ["string"]
          prefetches  = ["string"]
        }
        verification_method = "string"
      }
    }
    payment_method_types = ["string"]
  }
  pending_invoice_items_behavior = "string"
  rendering = {
    amount_tax_display = "string"
    pdf = {
      page_size = "string"
    }
    template         = "string"
    template_version = 0
  }
  shipping_cost = {
    amount_subtotal = 0
    amount_tax      = 0
    amount_total    = 0
    shipping_rate   = "string"
    shipping_rate_data = {
      display_name = "string"
      delivery_estimate = {
        maximum = {
          unit  = "string"
          value = 0
        }
        minimum = {
          unit  = "string"
          value = 0
        }
      }
      fixed_amount = {
        amount   = 0
        currency = "string"
        currency_options = {
          "string" = {
            amount       = 0
            tax_behavior = "string"
          }
        }
      }
      metadata = {
        "string" = "string"
      }
      tax_behavior = "string"
      tax_code     = "string"
      type         = "string"
    }
    taxes = [{
      amount            = 0
      rate              = "string"
      taxability_reason = "string"
      taxable_amount    = 0
    }]
  }
  shipping_details = {
    address = {
      city        = "string"
      country     = "string"
      line1       = "string"
      line2       = "string"
      postal_code = "string"
      state       = "string"
    }
    name            = "string"
    carrier         = "string"
    phone           = "string"
    tracking_number = "string"
  }
  statement_descriptor = "string"
  subscription         = "string"
  transfer_data = {
    destination = "string"
    amount      = 0
  }
}

    var invoiceResource = new Invoice("invoiceResource", InvoiceArgs.builder()
    .accountTaxIds("string")
    .applicationFeeAmount(0.0)
    .autoAdvance(false)
    .automaticTax(InvoiceAutomaticTaxArgs.builder()
        .enabled(false)
        .disabledReason("string")
        .liability(InvoiceAutomaticTaxLiabilityArgs.builder()
            .type("string")
            .account("string")
            .build())
        .provider("string")
        .status("string")
        .build())
    .automaticallyFinalizesAt(0.0)
    .collectionMethod("string")
    .currency("string")
    .customFields(InvoiceCustomFieldArgs.builder()
        .name("string")
        .value("string")
        .build())
    .customer("string")
    .customerAccount("string")
    .daysUntilDue(0.0)
    .defaultPaymentMethod("string")
    .defaultSource("string")
    .defaultTaxRates("string")
    .description("string")
    .discounts(InvoiceDiscountArgs.builder()
        .coupon("string")
        .discount("string")
        .promotionCode("string")
        .build())
    .dueDate(0.0)
    .effectiveAt(0.0)
    .footer("string")
    .fromInvoice(InvoiceFromInvoiceArgs.builder()
        .action("string")
        .invoice("string")
        .build())
    .issuer(InvoiceIssuerArgs.builder()
        .type("string")
        .account("string")
        .build())
    .metadata(Map.of("string", "string"))
    .number("string")
    .onBehalfOf("string")
    .paymentSettings(InvoicePaymentSettingsArgs.builder()
        .defaultMandate("string")
        .paymentMethodOptions(InvoicePaymentSettingsPaymentMethodOptionsArgs.builder()
            .acssDebit(InvoicePaymentSettingsPaymentMethodOptionsAcssDebitArgs.builder()
                .mandateOptions(InvoicePaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsArgs.builder()
                    .transactionType("string")
                    .build())
                .verificationMethod("string")
                .build())
            .bancontact(InvoicePaymentSettingsPaymentMethodOptionsBancontactArgs.builder()
                .preferredLanguage("string")
                .build())
            .card(InvoicePaymentSettingsPaymentMethodOptionsCardArgs.builder()
                .installments(InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsArgs.builder()
                    .enabled(false)
                    .plan(InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlanArgs.builder()
                        .type("string")
                        .count(0.0)
                        .interval("string")
                        .build())
                    .build())
                .requestThreeDSecure("string")
                .build())
            .customerBalance(InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceArgs.builder()
                .bankTransfer(InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferArgs.builder()
                    .euBankTransfer(InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferArgs.builder()
                        .country("string")
                        .build())
                    .type("string")
                    .build())
                .fundingType("string")
                .build())
            .payto(InvoicePaymentSettingsPaymentMethodOptionsPaytoArgs.builder()
                .mandateOptions(InvoicePaymentSettingsPaymentMethodOptionsPaytoMandateOptionsArgs.builder()
                    .amount(0.0)
                    .amountType("string")
                    .purpose("string")
                    .build())
                .build())
            .pix(InvoicePaymentSettingsPaymentMethodOptionsPixArgs.builder()
                .amountIncludesIof("string")
                .expiresAfterSeconds(0.0)
                .build())
            .upi(InvoicePaymentSettingsPaymentMethodOptionsUpiArgs.builder()
                .mandateOptions(InvoicePaymentSettingsPaymentMethodOptionsUpiMandateOptionsArgs.builder()
                    .amount(0.0)
                    .amountType("string")
                    .description("string")
                    .endDate(0.0)
                    .build())
                .build())
            .usBankAccount(InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountArgs.builder()
                .financialConnections(InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs.builder()
                    .filters(InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs.builder()
                        .accountSubcategories("string")
                        .build())
                    .permissions("string")
                    .prefetches("string")
                    .build())
                .verificationMethod("string")
                .build())
            .build())
        .paymentMethodTypes("string")
        .build())
    .pendingInvoiceItemsBehavior("string")
    .rendering(InvoiceRenderingArgs.builder()
        .amountTaxDisplay("string")
        .pdf(InvoiceRenderingPdfArgs.builder()
            .pageSize("string")
            .build())
        .template("string")
        .templateVersion(0.0)
        .build())
    .shippingCost(InvoiceShippingCostArgs.builder()
        .amountSubtotal(0.0)
        .amountTax(0.0)
        .amountTotal(0.0)
        .shippingRate("string")
        .shippingRateData(InvoiceShippingCostShippingRateDataArgs.builder()
            .displayName("string")
            .deliveryEstimate(InvoiceShippingCostShippingRateDataDeliveryEstimateArgs.builder()
                .maximum(InvoiceShippingCostShippingRateDataDeliveryEstimateMaximumArgs.builder()
                    .unit("string")
                    .value(0.0)
                    .build())
                .minimum(InvoiceShippingCostShippingRateDataDeliveryEstimateMinimumArgs.builder()
                    .unit("string")
                    .value(0.0)
                    .build())
                .build())
            .fixedAmount(InvoiceShippingCostShippingRateDataFixedAmountArgs.builder()
                .amount(0.0)
                .currency("string")
                .currencyOptions(Map.of("string", InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptionsArgs.builder()
                    .amount(0.0)
                    .taxBehavior("string")
                    .build()))
                .build())
            .metadata(Map.of("string", "string"))
            .taxBehavior("string")
            .taxCode("string")
            .type("string")
            .build())
        .taxes(InvoiceShippingCostTaxArgs.builder()
            .amount(0.0)
            .rate("string")
            .taxabilityReason("string")
            .taxableAmount(0.0)
            .build())
        .build())
    .shippingDetails(InvoiceShippingDetailsArgs.builder()
        .address(InvoiceShippingDetailsAddressArgs.builder()
            .city("string")
            .country("string")
            .line1("string")
            .line2("string")
            .postalCode("string")
            .state("string")
            .build())
        .name("string")
        .carrier("string")
        .phone("string")
        .trackingNumber("string")
        .build())
    .statementDescriptor("string")
    .subscription("string")
    .transferData(InvoiceTransferDataArgs.builder()
        .destination("string")
        .amount(0.0)
        .build())
    .build());

    invoice_resource = stripe.Invoice("invoiceResource",
    account_tax_ids=["string"],
    application_fee_amount=float(0),
    auto_advance=False,
    automatic_tax={
        "enabled": False,
        "disabled_reason": "string",
        "liability": {
            "type": "string",
            "account": "string",
        },
        "provider": "string",
        "status": "string",
    },
    automatically_finalizes_at=float(0),
    collection_method="string",
    currency="string",
    custom_fields=[{
        "name": "string",
        "value": "string",
    }],
    customer="string",
    customer_account="string",
    days_until_due=float(0),
    default_payment_method="string",
    default_source="string",
    default_tax_rates=["string"],
    description="string",
    discounts=[{
        "coupon": "string",
        "discount": "string",
        "promotion_code": "string",
    }],
    due_date=float(0),
    effective_at=float(0),
    footer="string",
    from_invoice={
        "action": "string",
        "invoice": "string",
    },
    issuer={
        "type": "string",
        "account": "string",
    },
    metadata={
        "string": "string",
    },
    number="string",
    on_behalf_of="string",
    payment_settings={
        "default_mandate": "string",
        "payment_method_options": {
            "acss_debit": {
                "mandate_options": {
                    "transaction_type": "string",
                },
                "verification_method": "string",
            },
            "bancontact": {
                "preferred_language": "string",
            },
            "card": {
                "installments": {
                    "enabled": False,
                    "plan": {
                        "type": "string",
                        "count": float(0),
                        "interval": "string",
                    },
                },
                "request_three_d_secure": "string",
            },
            "customer_balance": {
                "bank_transfer": {
                    "eu_bank_transfer": {
                        "country": "string",
                    },
                    "type": "string",
                },
                "funding_type": "string",
            },
            "payto": {
                "mandate_options": {
                    "amount": float(0),
                    "amount_type": "string",
                    "purpose": "string",
                },
            },
            "pix": {
                "amount_includes_iof": "string",
                "expires_after_seconds": float(0),
            },
            "upi": {
                "mandate_options": {
                    "amount": float(0),
                    "amount_type": "string",
                    "description": "string",
                    "end_date": float(0),
                },
            },
            "us_bank_account": {
                "financial_connections": {
                    "filters": {
                        "account_subcategories": ["string"],
                    },
                    "permissions": ["string"],
                    "prefetches": ["string"],
                },
                "verification_method": "string",
            },
        },
        "payment_method_types": ["string"],
    },
    pending_invoice_items_behavior="string",
    rendering={
        "amount_tax_display": "string",
        "pdf": {
            "page_size": "string",
        },
        "template": "string",
        "template_version": float(0),
    },
    shipping_cost={
        "amount_subtotal": float(0),
        "amount_tax": float(0),
        "amount_total": float(0),
        "shipping_rate": "string",
        "shipping_rate_data": {
            "display_name": "string",
            "delivery_estimate": {
                "maximum": {
                    "unit": "string",
                    "value": float(0),
                },
                "minimum": {
                    "unit": "string",
                    "value": float(0),
                },
            },
            "fixed_amount": {
                "amount": float(0),
                "currency": "string",
                "currency_options": {
                    "string": {
                        "amount": float(0),
                        "tax_behavior": "string",
                    },
                },
            },
            "metadata": {
                "string": "string",
            },
            "tax_behavior": "string",
            "tax_code": "string",
            "type": "string",
        },
        "taxes": [{
            "amount": float(0),
            "rate": "string",
            "taxability_reason": "string",
            "taxable_amount": float(0),
        }],
    },
    shipping_details={
        "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string",
        },
        "name": "string",
        "carrier": "string",
        "phone": "string",
        "tracking_number": "string",
    },
    statement_descriptor="string",
    subscription="string",
    transfer_data={
        "destination": "string",
        "amount": float(0),
    })

    const invoiceResource = new stripe.Invoice("invoiceResource", {
    accountTaxIds: ["string"],
    applicationFeeAmount: 0,
    autoAdvance: false,
    automaticTax: {
        enabled: false,
        disabledReason: "string",
        liability: {
            type: "string",
            account: "string",
        },
        provider: "string",
        status: "string",
    },
    automaticallyFinalizesAt: 0,
    collectionMethod: "string",
    currency: "string",
    customFields: [{
        name: "string",
        value: "string",
    }],
    customer: "string",
    customerAccount: "string",
    daysUntilDue: 0,
    defaultPaymentMethod: "string",
    defaultSource: "string",
    defaultTaxRates: ["string"],
    description: "string",
    discounts: [{
        coupon: "string",
        discount: "string",
        promotionCode: "string",
    }],
    dueDate: 0,
    effectiveAt: 0,
    footer: "string",
    fromInvoice: {
        action: "string",
        invoice: "string",
    },
    issuer: {
        type: "string",
        account: "string",
    },
    metadata: {
        string: "string",
    },
    number: "string",
    onBehalfOf: "string",
    paymentSettings: {
        defaultMandate: "string",
        paymentMethodOptions: {
            acssDebit: {
                mandateOptions: {
                    transactionType: "string",
                },
                verificationMethod: "string",
            },
            bancontact: {
                preferredLanguage: "string",
            },
            card: {
                installments: {
                    enabled: false,
                    plan: {
                        type: "string",
                        count: 0,
                        interval: "string",
                    },
                },
                requestThreeDSecure: "string",
            },
            customerBalance: {
                bankTransfer: {
                    euBankTransfer: {
                        country: "string",
                    },
                    type: "string",
                },
                fundingType: "string",
            },
            payto: {
                mandateOptions: {
                    amount: 0,
                    amountType: "string",
                    purpose: "string",
                },
            },
            pix: {
                amountIncludesIof: "string",
                expiresAfterSeconds: 0,
            },
            upi: {
                mandateOptions: {
                    amount: 0,
                    amountType: "string",
                    description: "string",
                    endDate: 0,
                },
            },
            usBankAccount: {
                financialConnections: {
                    filters: {
                        accountSubcategories: ["string"],
                    },
                    permissions: ["string"],
                    prefetches: ["string"],
                },
                verificationMethod: "string",
            },
        },
        paymentMethodTypes: ["string"],
    },
    pendingInvoiceItemsBehavior: "string",
    rendering: {
        amountTaxDisplay: "string",
        pdf: {
            pageSize: "string",
        },
        template: "string",
        templateVersion: 0,
    },
    shippingCost: {
        amountSubtotal: 0,
        amountTax: 0,
        amountTotal: 0,
        shippingRate: "string",
        shippingRateData: {
            displayName: "string",
            deliveryEstimate: {
                maximum: {
                    unit: "string",
                    value: 0,
                },
                minimum: {
                    unit: "string",
                    value: 0,
                },
            },
            fixedAmount: {
                amount: 0,
                currency: "string",
                currencyOptions: {
                    string: {
                        amount: 0,
                        taxBehavior: "string",
                    },
                },
            },
            metadata: {
                string: "string",
            },
            taxBehavior: "string",
            taxCode: "string",
            type: "string",
        },
        taxes: [{
            amount: 0,
            rate: "string",
            taxabilityReason: "string",
            taxableAmount: 0,
        }],
    },
    shippingDetails: {
        address: {
            city: "string",
            country: "string",
            line1: "string",
            line2: "string",
            postalCode: "string",
            state: "string",
        },
        name: "string",
        carrier: "string",
        phone: "string",
        trackingNumber: "string",
    },
    statementDescriptor: "string",
    subscription: "string",
    transferData: {
        destination: "string",
        amount: 0,
    },
});

    type: stripe:Invoice
properties:
    accountTaxIds:
        - string
    applicationFeeAmount: 0
    autoAdvance: false
    automaticTax:
        disabledReason: string
        enabled: false
        liability:
            account: string
            type: string
        provider: string
        status: string
    automaticallyFinalizesAt: 0
    collectionMethod: string
    currency: string
    customFields:
        - name: string
          value: string
    customer: string
    customerAccount: string
    daysUntilDue: 0
    defaultPaymentMethod: string
    defaultSource: string
    defaultTaxRates:
        - string
    description: string
    discounts:
        - coupon: string
          discount: string
          promotionCode: string
    dueDate: 0
    effectiveAt: 0
    footer: string
    fromInvoice:
        action: string
        invoice: string
    issuer:
        account: string
        type: string
    metadata:
        string: string
    number: string
    onBehalfOf: string
    paymentSettings:
        defaultMandate: string
        paymentMethodOptions:
            acssDebit:
                mandateOptions:
                    transactionType: string
                verificationMethod: string
            bancontact:
                preferredLanguage: string
            card:
                installments:
                    enabled: false
                    plan:
                        count: 0
                        interval: string
                        type: string
                requestThreeDSecure: string
            customerBalance:
                bankTransfer:
                    euBankTransfer:
                        country: string
                    type: string
                fundingType: string
            payto:
                mandateOptions:
                    amount: 0
                    amountType: string
                    purpose: string
            pix:
                amountIncludesIof: string
                expiresAfterSeconds: 0
            upi:
                mandateOptions:
                    amount: 0
                    amountType: string
                    description: string
                    endDate: 0
            usBankAccount:
                financialConnections:
                    filters:
                        accountSubcategories:
                            - string
                    permissions:
                        - string
                    prefetches:
                        - string
                verificationMethod: string
        paymentMethodTypes:
            - string
    pendingInvoiceItemsBehavior: string
    rendering:
        amountTaxDisplay: string
        pdf:
            pageSize: string
        template: string
        templateVersion: 0
    shippingCost:
        amountSubtotal: 0
        amountTax: 0
        amountTotal: 0
        shippingRate: string
        shippingRateData:
            deliveryEstimate:
                maximum:
                    unit: string
                    value: 0
                minimum:
                    unit: string
                    value: 0
            displayName: string
            fixedAmount:
                amount: 0
                currency: string
                currencyOptions:
                    string:
                        amount: 0
                        taxBehavior: string
            metadata:
                string: string
            taxBehavior: string
            taxCode: string
            type: string
        taxes:
            - amount: 0
              rate: string
              taxabilityReason: string
              taxableAmount: 0
    shippingDetails:
        address:
            city: string
            country: string
            line1: string
            line2: string
            postalCode: string
            state: string
        carrier: string
        name: string
        phone: string
        trackingNumber: string
    statementDescriptor: string
    subscription: string
    transferData:
        amount: 0
        destination: string

    Invoice Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Invoice resource accepts the following input properties:

    AccountTaxIds List<string>
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    ApplicationFeeAmount double
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    AutoAdvance bool
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    AutomaticTax InvoiceAutomaticTax
    AutomaticallyFinalizesAt double
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CustomFields List<InvoiceCustomField>
    Custom fields displayed on the invoice.
    Customer string
    The ID of the customer to bill.
    CustomerAccount string
    The ID of the account representing the customer to bill.
    DaysUntilDue double
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    DefaultPaymentMethod string
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    DefaultSource string
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    DefaultTaxRates List<string>
    The tax rates applied to this invoice, if any.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    Discounts List<InvoiceDiscount>
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    DueDate double
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    EffectiveAt double
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    Footer string
    Footer displayed on the invoice.
    FromInvoice InvoiceFromInvoice
    Details of the invoice that was cloned. See the revision documentation for more details.
    Issuer InvoiceIssuer
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Number string
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    OnBehalfOf string
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    PaymentSettings InvoicePaymentSettings
    PendingInvoiceItemsBehavior string
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    Rendering InvoiceRendering
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    ShippingCost InvoiceShippingCost
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    ShippingDetails InvoiceShippingDetails
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    StatementDescriptor string
    Extra information about an invoice for the customer's credit card statement.
    Subscription string
    TransferData InvoiceTransferData
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    AccountTaxIds []string
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    ApplicationFeeAmount float64
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    AutoAdvance bool
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    AutomaticTax InvoiceAutomaticTaxArgs
    AutomaticallyFinalizesAt float64
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CustomFields []InvoiceCustomFieldArgs
    Custom fields displayed on the invoice.
    Customer string
    The ID of the customer to bill.
    CustomerAccount string
    The ID of the account representing the customer to bill.
    DaysUntilDue float64
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    DefaultPaymentMethod string
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    DefaultSource string
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    DefaultTaxRates []string
    The tax rates applied to this invoice, if any.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    Discounts []InvoiceDiscountArgs
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    DueDate float64
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    EffectiveAt float64
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    Footer string
    Footer displayed on the invoice.
    FromInvoice InvoiceFromInvoiceArgs
    Details of the invoice that was cloned. See the revision documentation for more details.
    Issuer InvoiceIssuerArgs
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    Number string
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    OnBehalfOf string
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    PaymentSettings InvoicePaymentSettingsArgs
    PendingInvoiceItemsBehavior string
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    Rendering InvoiceRenderingArgs
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    ShippingCost InvoiceShippingCostArgs
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    ShippingDetails InvoiceShippingDetailsArgs
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    StatementDescriptor string
    Extra information about an invoice for the customer's credit card statement.
    Subscription string
    TransferData InvoiceTransferDataArgs
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    account_tax_ids list(string)
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    application_fee_amount number
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    auto_advance bool
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    automatic_tax object
    automatically_finalizes_at number
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    collection_method string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    custom_fields list(object)
    Custom fields displayed on the invoice.
    customer string
    The ID of the customer to bill.
    customer_account string
    The ID of the account representing the customer to bill.
    days_until_due number
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    default_payment_method string
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    default_source string
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    default_tax_rates list(string)
    The tax rates applied to this invoice, if any.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    discounts list(object)
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    due_date number
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    effective_at number
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    footer string
    Footer displayed on the invoice.
    from_invoice object
    Details of the invoice that was cloned. See the revision documentation for more details.
    issuer object
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    number string
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    on_behalf_of string
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    payment_settings object
    pending_invoice_items_behavior string
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    rendering object
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    shipping_cost object
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    shipping_details object
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    statement_descriptor string
    Extra information about an invoice for the customer's credit card statement.
    subscription string
    transfer_data object
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    accountTaxIds List<String>
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    applicationFeeAmount Double
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    autoAdvance Boolean
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    automaticTax InvoiceAutomaticTax
    automaticallyFinalizesAt Double
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields List<InvoiceCustomField>
    Custom fields displayed on the invoice.
    customer String
    The ID of the customer to bill.
    customerAccount String
    The ID of the account representing the customer to bill.
    daysUntilDue Double
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    defaultPaymentMethod String
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    defaultSource String
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    defaultTaxRates List<String>
    The tax rates applied to this invoice, if any.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    discounts List<InvoiceDiscount>
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    dueDate Double
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    effectiveAt Double
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    footer String
    Footer displayed on the invoice.
    fromInvoice InvoiceFromInvoice
    Details of the invoice that was cloned. See the revision documentation for more details.
    issuer InvoiceIssuer
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    number String
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    onBehalfOf String
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    paymentSettings InvoicePaymentSettings
    pendingInvoiceItemsBehavior String
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    rendering InvoiceRendering
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    shippingCost InvoiceShippingCost
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    shippingDetails InvoiceShippingDetails
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    statementDescriptor String
    Extra information about an invoice for the customer's credit card statement.
    subscription String
    transferData InvoiceTransferData
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    accountTaxIds string[]
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    applicationFeeAmount number
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    autoAdvance boolean
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    automaticTax InvoiceAutomaticTax
    automaticallyFinalizesAt number
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    collectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields InvoiceCustomField[]
    Custom fields displayed on the invoice.
    customer string
    The ID of the customer to bill.
    customerAccount string
    The ID of the account representing the customer to bill.
    daysUntilDue number
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    defaultPaymentMethod string
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    defaultSource string
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    defaultTaxRates string[]
    The tax rates applied to this invoice, if any.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    discounts InvoiceDiscount[]
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    dueDate number
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    effectiveAt number
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    footer string
    Footer displayed on the invoice.
    fromInvoice InvoiceFromInvoice
    Details of the invoice that was cloned. See the revision documentation for more details.
    issuer InvoiceIssuer
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    number string
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    onBehalfOf string
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    paymentSettings InvoicePaymentSettings
    pendingInvoiceItemsBehavior string
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    rendering InvoiceRendering
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    shippingCost InvoiceShippingCost
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    shippingDetails InvoiceShippingDetails
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    statementDescriptor string
    Extra information about an invoice for the customer's credit card statement.
    subscription string
    transferData InvoiceTransferData
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    account_tax_ids Sequence[str]
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    application_fee_amount float
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    auto_advance bool
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    automatic_tax InvoiceAutomaticTaxArgs
    automatically_finalizes_at float
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    collection_method str
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    custom_fields Sequence[InvoiceCustomFieldArgs]
    Custom fields displayed on the invoice.
    customer str
    The ID of the customer to bill.
    customer_account str
    The ID of the account representing the customer to bill.
    days_until_due float
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    default_payment_method str
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    default_source str
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    default_tax_rates Sequence[str]
    The tax rates applied to this invoice, if any.
    description str
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    discounts Sequence[InvoiceDiscountArgs]
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    due_date float
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    effective_at float
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    footer str
    Footer displayed on the invoice.
    from_invoice InvoiceFromInvoiceArgs
    Details of the invoice that was cloned. See the revision documentation for more details.
    issuer InvoiceIssuerArgs
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    number str
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    on_behalf_of str
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    payment_settings InvoicePaymentSettingsArgs
    pending_invoice_items_behavior str
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    rendering InvoiceRenderingArgs
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    shipping_cost InvoiceShippingCostArgs
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    shipping_details InvoiceShippingDetailsArgs
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    statement_descriptor str
    Extra information about an invoice for the customer's credit card statement.
    subscription str
    transfer_data InvoiceTransferDataArgs
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    accountTaxIds List<String>
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    applicationFeeAmount Number
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    autoAdvance Boolean
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    automaticTax Property Map
    automaticallyFinalizesAt Number
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields List<Property Map>
    Custom fields displayed on the invoice.
    customer String
    The ID of the customer to bill.
    customerAccount String
    The ID of the account representing the customer to bill.
    daysUntilDue Number
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    defaultPaymentMethod String
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    defaultSource String
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    defaultTaxRates List<String>
    The tax rates applied to this invoice, if any.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    discounts List<Property Map>
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    dueDate Number
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    effectiveAt Number
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    footer String
    Footer displayed on the invoice.
    fromInvoice Property Map
    Details of the invoice that was cloned. See the revision documentation for more details.
    issuer Property Map
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    number String
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    onBehalfOf String
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    paymentSettings Property Map
    pendingInvoiceItemsBehavior String
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    rendering Property Map
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    shippingCost Property Map
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    shippingDetails Property Map
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    statementDescriptor String
    Extra information about an invoice for the customer's credit card statement.
    subscription String
    transferData Property Map
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Invoice resource produces the following output properties:

    AccountCountry string
    The country of the business associated with this invoice, most often the business creating the invoice.
    AccountName string
    The public name of the business associated with this invoice, most often the business creating the invoice.
    AmountDue double
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    AmountOverpaid double
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    AmountPaid double
    The amount, in cents (or local equivalent), that was paid.
    AmountPaidOffStripe double
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    AmountRemaining double
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    AmountShipping double
    This is the sum of all the shipping amounts.
    Application string
    ID of the Connect Application that created the invoice.
    AttemptCount double
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    Attempted bool
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    BillingReason string
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    ConfirmationSecret InvoiceConfirmationSecret
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CustomerAddress InvoiceCustomerAddress
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    CustomerEmail string
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    CustomerName string
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    CustomerPhone string
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    CustomerShipping InvoiceCustomerShipping
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    CustomerTaxIds List<InvoiceCustomerTaxId>
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    EndingBalance double
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    HostedInvoiceUrl string
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    Id string
    The provider-assigned unique ID for this managed resource.
    InvoicePdf string
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    LastFinalizationError InvoiceLastFinalizationError
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    LatestRevision string
    The ID of the most recent non-draft revision of this invoice
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    NextPaymentAttempt double
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Parent InvoiceParent
    The parent that generated this invoice
    PeriodEnd double
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    PeriodStart double
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    PostPaymentCreditNotesAmount double
    Total amount of all post-payment credit notes issued for this invoice.
    PrePaymentCreditNotesAmount double
    Total amount of all pre-payment credit notes issued for this invoice.
    ReceiptNumber string
    This is the transaction number that appears on email receipts sent for this invoice.
    StartingBalance double
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    Status string
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    StatusTransitions InvoiceStatusTransitions
    Subtotal double
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    SubtotalExcludingTax double
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    TestClock string
    ID of the test clock this invoice belongs to.
    ThresholdReason InvoiceThresholdReason
    Total double
    Total after discounts and taxes.
    TotalDiscountAmounts List<InvoiceTotalDiscountAmount>
    The aggregate amounts calculated per discount across all line items.
    TotalExcludingTax double
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    TotalPretaxCreditAmounts List<InvoiceTotalPretaxCreditAmount>
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    TotalTaxes List<InvoiceTotalTax>
    The aggregate tax information of all line items.
    WebhooksDeliveredAt double
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    AccountCountry string
    The country of the business associated with this invoice, most often the business creating the invoice.
    AccountName string
    The public name of the business associated with this invoice, most often the business creating the invoice.
    AmountDue float64
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    AmountOverpaid float64
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    AmountPaid float64
    The amount, in cents (or local equivalent), that was paid.
    AmountPaidOffStripe float64
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    AmountRemaining float64
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    AmountShipping float64
    This is the sum of all the shipping amounts.
    Application string
    ID of the Connect Application that created the invoice.
    AttemptCount float64
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    Attempted bool
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    BillingReason string
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    ConfirmationSecret InvoiceConfirmationSecret
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    CustomerAddress InvoiceCustomerAddress
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    CustomerEmail string
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    CustomerName string
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    CustomerPhone string
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    CustomerShipping InvoiceCustomerShipping
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    CustomerTaxIds []InvoiceCustomerTaxId
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    EndingBalance float64
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    HostedInvoiceUrl string
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    Id string
    The provider-assigned unique ID for this managed resource.
    InvoicePdf string
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    LastFinalizationError InvoiceLastFinalizationError
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    LatestRevision string
    The ID of the most recent non-draft revision of this invoice
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    NextPaymentAttempt float64
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    Parent InvoiceParent
    The parent that generated this invoice
    PeriodEnd float64
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    PeriodStart float64
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    PostPaymentCreditNotesAmount float64
    Total amount of all post-payment credit notes issued for this invoice.
    PrePaymentCreditNotesAmount float64
    Total amount of all pre-payment credit notes issued for this invoice.
    ReceiptNumber string
    This is the transaction number that appears on email receipts sent for this invoice.
    StartingBalance float64
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    Status string
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    StatusTransitions InvoiceStatusTransitions
    Subtotal float64
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    SubtotalExcludingTax float64
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    TestClock string
    ID of the test clock this invoice belongs to.
    ThresholdReason InvoiceThresholdReason
    Total float64
    Total after discounts and taxes.
    TotalDiscountAmounts []InvoiceTotalDiscountAmount
    The aggregate amounts calculated per discount across all line items.
    TotalExcludingTax float64
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    TotalPretaxCreditAmounts []InvoiceTotalPretaxCreditAmount
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    TotalTaxes []InvoiceTotalTax
    The aggregate tax information of all line items.
    WebhooksDeliveredAt float64
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    account_country string
    The country of the business associated with this invoice, most often the business creating the invoice.
    account_name string
    The public name of the business associated with this invoice, most often the business creating the invoice.
    amount_due number
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    amount_overpaid number
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    amount_paid number
    The amount, in cents (or local equivalent), that was paid.
    amount_paid_off_stripe number
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    amount_remaining number
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    amount_shipping number
    This is the sum of all the shipping amounts.
    application string
    ID of the Connect Application that created the invoice.
    attempt_count number
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    attempted bool
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    billing_reason string
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    confirmation_secret object
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer_address object
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    customer_email string
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    customer_name string
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    customer_phone string
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    customer_shipping object
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    customer_tax_ids list(object)
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    ending_balance number
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    hosted_invoice_url string
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    id string
    The provider-assigned unique ID for this managed resource.
    invoice_pdf string
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    last_finalization_error object
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    latest_revision string
    The ID of the most recent non-draft revision of this invoice
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    next_payment_attempt number
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    object string
    String representing the object's type. Objects of the same type share the same value.
    parent object
    The parent that generated this invoice
    period_end number
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    period_start number
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    post_payment_credit_notes_amount number
    Total amount of all post-payment credit notes issued for this invoice.
    pre_payment_credit_notes_amount number
    Total amount of all pre-payment credit notes issued for this invoice.
    receipt_number string
    This is the transaction number that appears on email receipts sent for this invoice.
    starting_balance number
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    status string
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    status_transitions object
    subtotal number
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    subtotal_excluding_tax number
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    test_clock string
    ID of the test clock this invoice belongs to.
    threshold_reason object
    total number
    Total after discounts and taxes.
    total_discount_amounts list(object)
    The aggregate amounts calculated per discount across all line items.
    total_excluding_tax number
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    total_pretax_credit_amounts list(object)
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    total_taxes list(object)
    The aggregate tax information of all line items.
    webhooks_delivered_at number
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    accountCountry String
    The country of the business associated with this invoice, most often the business creating the invoice.
    accountName String
    The public name of the business associated with this invoice, most often the business creating the invoice.
    amountDue Double
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    amountOverpaid Double
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    amountPaid Double
    The amount, in cents (or local equivalent), that was paid.
    amountPaidOffStripe Double
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    amountRemaining Double
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    amountShipping Double
    This is the sum of all the shipping amounts.
    application String
    ID of the Connect Application that created the invoice.
    attemptCount Double
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    attempted Boolean
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    billingReason String
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    confirmationSecret InvoiceConfirmationSecret
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customerAddress InvoiceCustomerAddress
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    customerEmail String
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    customerName String
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    customerPhone String
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    customerShipping InvoiceCustomerShipping
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    customerTaxIds List<InvoiceCustomerTaxId>
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    endingBalance Double
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    hostedInvoiceUrl String
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    id String
    The provider-assigned unique ID for this managed resource.
    invoicePdf String
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    lastFinalizationError InvoiceLastFinalizationError
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    latestRevision String
    The ID of the most recent non-draft revision of this invoice
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    nextPaymentAttempt Double
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    object String
    String representing the object's type. Objects of the same type share the same value.
    parent InvoiceParent
    The parent that generated this invoice
    periodEnd Double
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    periodStart Double
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    postPaymentCreditNotesAmount Double
    Total amount of all post-payment credit notes issued for this invoice.
    prePaymentCreditNotesAmount Double
    Total amount of all pre-payment credit notes issued for this invoice.
    receiptNumber String
    This is the transaction number that appears on email receipts sent for this invoice.
    startingBalance Double
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    status String
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    statusTransitions InvoiceStatusTransitions
    subtotal Double
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    subtotalExcludingTax Double
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    testClock String
    ID of the test clock this invoice belongs to.
    thresholdReason InvoiceThresholdReason
    total Double
    Total after discounts and taxes.
    totalDiscountAmounts List<InvoiceTotalDiscountAmount>
    The aggregate amounts calculated per discount across all line items.
    totalExcludingTax Double
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    totalPretaxCreditAmounts List<InvoiceTotalPretaxCreditAmount>
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    totalTaxes List<InvoiceTotalTax>
    The aggregate tax information of all line items.
    webhooksDeliveredAt Double
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    accountCountry string
    The country of the business associated with this invoice, most often the business creating the invoice.
    accountName string
    The public name of the business associated with this invoice, most often the business creating the invoice.
    amountDue number
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    amountOverpaid number
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    amountPaid number
    The amount, in cents (or local equivalent), that was paid.
    amountPaidOffStripe number
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    amountRemaining number
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    amountShipping number
    This is the sum of all the shipping amounts.
    application string
    ID of the Connect Application that created the invoice.
    attemptCount number
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    attempted boolean
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    billingReason string
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    confirmationSecret InvoiceConfirmationSecret
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customerAddress InvoiceCustomerAddress
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    customerEmail string
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    customerName string
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    customerPhone string
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    customerShipping InvoiceCustomerShipping
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    customerTaxIds InvoiceCustomerTaxId[]
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    endingBalance number
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    hostedInvoiceUrl string
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    id string
    The provider-assigned unique ID for this managed resource.
    invoicePdf string
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    lastFinalizationError InvoiceLastFinalizationError
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    latestRevision string
    The ID of the most recent non-draft revision of this invoice
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    nextPaymentAttempt number
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    object string
    String representing the object's type. Objects of the same type share the same value.
    parent InvoiceParent
    The parent that generated this invoice
    periodEnd number
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    periodStart number
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    postPaymentCreditNotesAmount number
    Total amount of all post-payment credit notes issued for this invoice.
    prePaymentCreditNotesAmount number
    Total amount of all pre-payment credit notes issued for this invoice.
    receiptNumber string
    This is the transaction number that appears on email receipts sent for this invoice.
    startingBalance number
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    status string
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    statusTransitions InvoiceStatusTransitions
    subtotal number
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    subtotalExcludingTax number
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    testClock string
    ID of the test clock this invoice belongs to.
    thresholdReason InvoiceThresholdReason
    total number
    Total after discounts and taxes.
    totalDiscountAmounts InvoiceTotalDiscountAmount[]
    The aggregate amounts calculated per discount across all line items.
    totalExcludingTax number
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    totalPretaxCreditAmounts InvoiceTotalPretaxCreditAmount[]
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    totalTaxes InvoiceTotalTax[]
    The aggregate tax information of all line items.
    webhooksDeliveredAt number
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    account_country str
    The country of the business associated with this invoice, most often the business creating the invoice.
    account_name str
    The public name of the business associated with this invoice, most often the business creating the invoice.
    amount_due float
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    amount_overpaid float
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    amount_paid float
    The amount, in cents (or local equivalent), that was paid.
    amount_paid_off_stripe float
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    amount_remaining float
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    amount_shipping float
    This is the sum of all the shipping amounts.
    application str
    ID of the Connect Application that created the invoice.
    attempt_count float
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    attempted bool
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    billing_reason str
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    confirmation_secret InvoiceConfirmationSecret
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customer_address InvoiceCustomerAddress
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    customer_email str
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    customer_name str
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    customer_phone str
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    customer_shipping InvoiceCustomerShipping
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    customer_tax_ids Sequence[InvoiceCustomerTaxId]
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    ending_balance float
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    hosted_invoice_url str
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    id str
    The provider-assigned unique ID for this managed resource.
    invoice_pdf str
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    last_finalization_error InvoiceLastFinalizationError
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    latest_revision str
    The ID of the most recent non-draft revision of this invoice
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    next_payment_attempt float
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    object str
    String representing the object's type. Objects of the same type share the same value.
    parent InvoiceParent
    The parent that generated this invoice
    period_end float
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    period_start float
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    post_payment_credit_notes_amount float
    Total amount of all post-payment credit notes issued for this invoice.
    pre_payment_credit_notes_amount float
    Total amount of all pre-payment credit notes issued for this invoice.
    receipt_number str
    This is the transaction number that appears on email receipts sent for this invoice.
    starting_balance float
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    status str
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    status_transitions InvoiceStatusTransitions
    subtotal float
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    subtotal_excluding_tax float
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    test_clock str
    ID of the test clock this invoice belongs to.
    threshold_reason InvoiceThresholdReason
    total float
    Total after discounts and taxes.
    total_discount_amounts Sequence[InvoiceTotalDiscountAmount]
    The aggregate amounts calculated per discount across all line items.
    total_excluding_tax float
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    total_pretax_credit_amounts Sequence[InvoiceTotalPretaxCreditAmount]
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    total_taxes Sequence[InvoiceTotalTax]
    The aggregate tax information of all line items.
    webhooks_delivered_at float
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    accountCountry String
    The country of the business associated with this invoice, most often the business creating the invoice.
    accountName String
    The public name of the business associated with this invoice, most often the business creating the invoice.
    amountDue Number
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    amountOverpaid Number
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    amountPaid Number
    The amount, in cents (or local equivalent), that was paid.
    amountPaidOffStripe Number
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    amountRemaining Number
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    amountShipping Number
    This is the sum of all the shipping amounts.
    application String
    ID of the Connect Application that created the invoice.
    attemptCount Number
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    attempted Boolean
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    billingReason String
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    confirmationSecret Property Map
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    customerAddress Property Map
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    customerEmail String
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    customerName String
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    customerPhone String
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    customerShipping Property Map
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    customerTaxIds List<Property Map>
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    endingBalance Number
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    hostedInvoiceUrl String
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    id String
    The provider-assigned unique ID for this managed resource.
    invoicePdf String
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    lastFinalizationError Property Map
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    latestRevision String
    The ID of the most recent non-draft revision of this invoice
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    nextPaymentAttempt Number
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    object String
    String representing the object's type. Objects of the same type share the same value.
    parent Property Map
    The parent that generated this invoice
    periodEnd Number
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    periodStart Number
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    postPaymentCreditNotesAmount Number
    Total amount of all post-payment credit notes issued for this invoice.
    prePaymentCreditNotesAmount Number
    Total amount of all pre-payment credit notes issued for this invoice.
    receiptNumber String
    This is the transaction number that appears on email receipts sent for this invoice.
    startingBalance Number
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    status String
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    statusTransitions Property Map
    subtotal Number
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    subtotalExcludingTax Number
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    testClock String
    ID of the test clock this invoice belongs to.
    thresholdReason Property Map
    total Number
    Total after discounts and taxes.
    totalDiscountAmounts List<Property Map>
    The aggregate amounts calculated per discount across all line items.
    totalExcludingTax Number
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    totalPretaxCreditAmounts List<Property Map>
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    totalTaxes List<Property Map>
    The aggregate tax information of all line items.
    webhooksDeliveredAt Number
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.

    Look up Existing Invoice Resource

    Get an existing Invoice resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InvoiceState, opts?: CustomResourceOptions): Invoice
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_country: Optional[str] = None,
        account_name: Optional[str] = None,
        account_tax_ids: Optional[Sequence[str]] = None,
        amount_due: Optional[float] = None,
        amount_overpaid: Optional[float] = None,
        amount_paid: Optional[float] = None,
        amount_paid_off_stripe: Optional[float] = None,
        amount_remaining: Optional[float] = None,
        amount_shipping: Optional[float] = None,
        application: Optional[str] = None,
        application_fee_amount: Optional[float] = None,
        attempt_count: Optional[float] = None,
        attempted: Optional[bool] = None,
        auto_advance: Optional[bool] = None,
        automatic_tax: Optional[InvoiceAutomaticTaxArgs] = None,
        automatically_finalizes_at: Optional[float] = None,
        billing_reason: Optional[str] = None,
        collection_method: Optional[str] = None,
        confirmation_secret: Optional[InvoiceConfirmationSecretArgs] = None,
        created: Optional[float] = None,
        currency: Optional[str] = None,
        custom_fields: Optional[Sequence[InvoiceCustomFieldArgs]] = None,
        customer: Optional[str] = None,
        customer_account: Optional[str] = None,
        customer_address: Optional[InvoiceCustomerAddressArgs] = None,
        customer_email: Optional[str] = None,
        customer_name: Optional[str] = None,
        customer_phone: Optional[str] = None,
        customer_shipping: Optional[InvoiceCustomerShippingArgs] = None,
        customer_tax_ids: Optional[Sequence[InvoiceCustomerTaxIdArgs]] = None,
        days_until_due: Optional[float] = None,
        default_payment_method: Optional[str] = None,
        default_source: Optional[str] = None,
        default_tax_rates: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        discounts: Optional[Sequence[InvoiceDiscountArgs]] = None,
        due_date: Optional[float] = None,
        effective_at: Optional[float] = None,
        ending_balance: Optional[float] = None,
        footer: Optional[str] = None,
        from_invoice: Optional[InvoiceFromInvoiceArgs] = None,
        hosted_invoice_url: Optional[str] = None,
        invoice_pdf: Optional[str] = None,
        issuer: Optional[InvoiceIssuerArgs] = None,
        last_finalization_error: Optional[InvoiceLastFinalizationErrorArgs] = None,
        latest_revision: Optional[str] = None,
        livemode: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        next_payment_attempt: Optional[float] = None,
        number: Optional[str] = None,
        object: Optional[str] = None,
        on_behalf_of: Optional[str] = None,
        parent: Optional[InvoiceParentArgs] = None,
        payment_settings: Optional[InvoicePaymentSettingsArgs] = None,
        pending_invoice_items_behavior: Optional[str] = None,
        period_end: Optional[float] = None,
        period_start: Optional[float] = None,
        post_payment_credit_notes_amount: Optional[float] = None,
        pre_payment_credit_notes_amount: Optional[float] = None,
        receipt_number: Optional[str] = None,
        rendering: Optional[InvoiceRenderingArgs] = None,
        shipping_cost: Optional[InvoiceShippingCostArgs] = None,
        shipping_details: Optional[InvoiceShippingDetailsArgs] = None,
        starting_balance: Optional[float] = None,
        statement_descriptor: Optional[str] = None,
        status: Optional[str] = None,
        status_transitions: Optional[InvoiceStatusTransitionsArgs] = None,
        subscription: Optional[str] = None,
        subtotal: Optional[float] = None,
        subtotal_excluding_tax: Optional[float] = None,
        test_clock: Optional[str] = None,
        threshold_reason: Optional[InvoiceThresholdReasonArgs] = None,
        total: Optional[float] = None,
        total_discount_amounts: Optional[Sequence[InvoiceTotalDiscountAmountArgs]] = None,
        total_excluding_tax: Optional[float] = None,
        total_pretax_credit_amounts: Optional[Sequence[InvoiceTotalPretaxCreditAmountArgs]] = None,
        total_taxes: Optional[Sequence[InvoiceTotalTaxArgs]] = None,
        transfer_data: Optional[InvoiceTransferDataArgs] = None,
        webhooks_delivered_at: Optional[float] = None) -> Invoice
    func GetInvoice(ctx *Context, name string, id IDInput, state *InvoiceState, opts ...ResourceOption) (*Invoice, error)
    public static Invoice Get(string name, Input<string> id, InvoiceState? state, CustomResourceOptions? opts = null)
    public static Invoice get(String name, Output<String> id, InvoiceState state, CustomResourceOptions options)
    resources:  _:    type: stripe:Invoice    get:      id: ${id}
    import {
  to = stripe_invoice.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountCountry string
    The country of the business associated with this invoice, most often the business creating the invoice.
    AccountName string
    The public name of the business associated with this invoice, most often the business creating the invoice.
    AccountTaxIds List<string>
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    AmountDue double
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    AmountOverpaid double
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    AmountPaid double
    The amount, in cents (or local equivalent), that was paid.
    AmountPaidOffStripe double
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    AmountRemaining double
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    AmountShipping double
    This is the sum of all the shipping amounts.
    Application string
    ID of the Connect Application that created the invoice.
    ApplicationFeeAmount double
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    AttemptCount double
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    Attempted bool
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    AutoAdvance bool
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    AutomaticTax InvoiceAutomaticTax
    AutomaticallyFinalizesAt double
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    BillingReason string
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    ConfirmationSecret InvoiceConfirmationSecret
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    Created double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CustomFields List<InvoiceCustomField>
    Custom fields displayed on the invoice.
    Customer string
    The ID of the customer to bill.
    CustomerAccount string
    The ID of the account representing the customer to bill.
    CustomerAddress InvoiceCustomerAddress
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    CustomerEmail string
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    CustomerName string
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    CustomerPhone string
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    CustomerShipping InvoiceCustomerShipping
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    CustomerTaxIds List<InvoiceCustomerTaxId>
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    DaysUntilDue double
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    DefaultPaymentMethod string
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    DefaultSource string
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    DefaultTaxRates List<string>
    The tax rates applied to this invoice, if any.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    Discounts List<InvoiceDiscount>
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    DueDate double
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    EffectiveAt double
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    EndingBalance double
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    Footer string
    Footer displayed on the invoice.
    FromInvoice InvoiceFromInvoice
    Details of the invoice that was cloned. See the revision documentation for more details.
    HostedInvoiceUrl string
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    InvoicePdf string
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    Issuer InvoiceIssuer
    LastFinalizationError InvoiceLastFinalizationError
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    LatestRevision string
    The ID of the most recent non-draft revision of this invoice
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    NextPaymentAttempt double
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    Number string
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OnBehalfOf string
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    Parent InvoiceParent
    The parent that generated this invoice
    PaymentSettings InvoicePaymentSettings
    PendingInvoiceItemsBehavior string
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    PeriodEnd double
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    PeriodStart double
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    PostPaymentCreditNotesAmount double
    Total amount of all post-payment credit notes issued for this invoice.
    PrePaymentCreditNotesAmount double
    Total amount of all pre-payment credit notes issued for this invoice.
    ReceiptNumber string
    This is the transaction number that appears on email receipts sent for this invoice.
    Rendering InvoiceRendering
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    ShippingCost InvoiceShippingCost
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    ShippingDetails InvoiceShippingDetails
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    StartingBalance double
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    StatementDescriptor string
    Extra information about an invoice for the customer's credit card statement.
    Status string
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    StatusTransitions InvoiceStatusTransitions
    Subscription string
    Subtotal double
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    SubtotalExcludingTax double
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    TestClock string
    ID of the test clock this invoice belongs to.
    ThresholdReason InvoiceThresholdReason
    Total double
    Total after discounts and taxes.
    TotalDiscountAmounts List<InvoiceTotalDiscountAmount>
    The aggregate amounts calculated per discount across all line items.
    TotalExcludingTax double
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    TotalPretaxCreditAmounts List<InvoiceTotalPretaxCreditAmount>
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    TotalTaxes List<InvoiceTotalTax>
    The aggregate tax information of all line items.
    TransferData InvoiceTransferData
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    WebhooksDeliveredAt double
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    AccountCountry string
    The country of the business associated with this invoice, most often the business creating the invoice.
    AccountName string
    The public name of the business associated with this invoice, most often the business creating the invoice.
    AccountTaxIds []string
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    AmountDue float64
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    AmountOverpaid float64
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    AmountPaid float64
    The amount, in cents (or local equivalent), that was paid.
    AmountPaidOffStripe float64
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    AmountRemaining float64
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    AmountShipping float64
    This is the sum of all the shipping amounts.
    Application string
    ID of the Connect Application that created the invoice.
    ApplicationFeeAmount float64
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    AttemptCount float64
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    Attempted bool
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    AutoAdvance bool
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    AutomaticTax InvoiceAutomaticTaxArgs
    AutomaticallyFinalizesAt float64
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    BillingReason string
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    CollectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    ConfirmationSecret InvoiceConfirmationSecretArgs
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    Created float64
    Time at which the object was created. Measured in seconds since the Unix epoch.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CustomFields []InvoiceCustomFieldArgs
    Custom fields displayed on the invoice.
    Customer string
    The ID of the customer to bill.
    CustomerAccount string
    The ID of the account representing the customer to bill.
    CustomerAddress InvoiceCustomerAddressArgs
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    CustomerEmail string
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    CustomerName string
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    CustomerPhone string
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    CustomerShipping InvoiceCustomerShippingArgs
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    CustomerTaxIds []InvoiceCustomerTaxIdArgs
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    DaysUntilDue float64
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    DefaultPaymentMethod string
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    DefaultSource string
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    DefaultTaxRates []string
    The tax rates applied to this invoice, if any.
    Description string
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    Discounts []InvoiceDiscountArgs
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    DueDate float64
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    EffectiveAt float64
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    EndingBalance float64
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    Footer string
    Footer displayed on the invoice.
    FromInvoice InvoiceFromInvoiceArgs
    Details of the invoice that was cloned. See the revision documentation for more details.
    HostedInvoiceUrl string
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    InvoicePdf string
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    Issuer InvoiceIssuerArgs
    LastFinalizationError InvoiceLastFinalizationErrorArgs
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    LatestRevision string
    The ID of the most recent non-draft revision of this invoice
    Livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    NextPaymentAttempt float64
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    Number string
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    Object string
    String representing the object's type. Objects of the same type share the same value.
    OnBehalfOf string
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    Parent InvoiceParentArgs
    The parent that generated this invoice
    PaymentSettings InvoicePaymentSettingsArgs
    PendingInvoiceItemsBehavior string
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    PeriodEnd float64
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    PeriodStart float64
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    PostPaymentCreditNotesAmount float64
    Total amount of all post-payment credit notes issued for this invoice.
    PrePaymentCreditNotesAmount float64
    Total amount of all pre-payment credit notes issued for this invoice.
    ReceiptNumber string
    This is the transaction number that appears on email receipts sent for this invoice.
    Rendering InvoiceRenderingArgs
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    ShippingCost InvoiceShippingCostArgs
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    ShippingDetails InvoiceShippingDetailsArgs
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    StartingBalance float64
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    StatementDescriptor string
    Extra information about an invoice for the customer's credit card statement.
    Status string
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    StatusTransitions InvoiceStatusTransitionsArgs
    Subscription string
    Subtotal float64
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    SubtotalExcludingTax float64
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    TestClock string
    ID of the test clock this invoice belongs to.
    ThresholdReason InvoiceThresholdReasonArgs
    Total float64
    Total after discounts and taxes.
    TotalDiscountAmounts []InvoiceTotalDiscountAmountArgs
    The aggregate amounts calculated per discount across all line items.
    TotalExcludingTax float64
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    TotalPretaxCreditAmounts []InvoiceTotalPretaxCreditAmountArgs
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    TotalTaxes []InvoiceTotalTaxArgs
    The aggregate tax information of all line items.
    TransferData InvoiceTransferDataArgs
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    WebhooksDeliveredAt float64
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    account_country string
    The country of the business associated with this invoice, most often the business creating the invoice.
    account_name string
    The public name of the business associated with this invoice, most often the business creating the invoice.
    account_tax_ids list(string)
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    amount_due number
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    amount_overpaid number
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    amount_paid number
    The amount, in cents (or local equivalent), that was paid.
    amount_paid_off_stripe number
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    amount_remaining number
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    amount_shipping number
    This is the sum of all the shipping amounts.
    application string
    ID of the Connect Application that created the invoice.
    application_fee_amount number
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    attempt_count number
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    attempted bool
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    auto_advance bool
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    automatic_tax object
    automatically_finalizes_at number
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    billing_reason string
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    collection_method string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    confirmation_secret object
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    custom_fields list(object)
    Custom fields displayed on the invoice.
    customer string
    The ID of the customer to bill.
    customer_account string
    The ID of the account representing the customer to bill.
    customer_address object
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    customer_email string
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    customer_name string
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    customer_phone string
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    customer_shipping object
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    customer_tax_ids list(object)
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    days_until_due number
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    default_payment_method string
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    default_source string
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    default_tax_rates list(string)
    The tax rates applied to this invoice, if any.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    discounts list(object)
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    due_date number
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    effective_at number
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    ending_balance number
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    footer string
    Footer displayed on the invoice.
    from_invoice object
    Details of the invoice that was cloned. See the revision documentation for more details.
    hosted_invoice_url string
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    invoice_pdf string
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    issuer object
    last_finalization_error object
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    latest_revision string
    The ID of the most recent non-draft revision of this invoice
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    next_payment_attempt number
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    number string
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    object string
    String representing the object's type. Objects of the same type share the same value.
    on_behalf_of string
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    parent object
    The parent that generated this invoice
    payment_settings object
    pending_invoice_items_behavior string
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    period_end number
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    period_start number
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    post_payment_credit_notes_amount number
    Total amount of all post-payment credit notes issued for this invoice.
    pre_payment_credit_notes_amount number
    Total amount of all pre-payment credit notes issued for this invoice.
    receipt_number string
    This is the transaction number that appears on email receipts sent for this invoice.
    rendering object
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    shipping_cost object
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    shipping_details object
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    starting_balance number
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    statement_descriptor string
    Extra information about an invoice for the customer's credit card statement.
    status string
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    status_transitions object
    subscription string
    subtotal number
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    subtotal_excluding_tax number
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    test_clock string
    ID of the test clock this invoice belongs to.
    threshold_reason object
    total number
    Total after discounts and taxes.
    total_discount_amounts list(object)
    The aggregate amounts calculated per discount across all line items.
    total_excluding_tax number
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    total_pretax_credit_amounts list(object)
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    total_taxes list(object)
    The aggregate tax information of all line items.
    transfer_data object
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    webhooks_delivered_at number
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    accountCountry String
    The country of the business associated with this invoice, most often the business creating the invoice.
    accountName String
    The public name of the business associated with this invoice, most often the business creating the invoice.
    accountTaxIds List<String>
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    amountDue Double
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    amountOverpaid Double
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    amountPaid Double
    The amount, in cents (or local equivalent), that was paid.
    amountPaidOffStripe Double
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    amountRemaining Double
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    amountShipping Double
    This is the sum of all the shipping amounts.
    application String
    ID of the Connect Application that created the invoice.
    applicationFeeAmount Double
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    attemptCount Double
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    attempted Boolean
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    autoAdvance Boolean
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    automaticTax InvoiceAutomaticTax
    automaticallyFinalizesAt Double
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    billingReason String
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    confirmationSecret InvoiceConfirmationSecret
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    created Double
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields List<InvoiceCustomField>
    Custom fields displayed on the invoice.
    customer String
    The ID of the customer to bill.
    customerAccount String
    The ID of the account representing the customer to bill.
    customerAddress InvoiceCustomerAddress
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    customerEmail String
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    customerName String
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    customerPhone String
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    customerShipping InvoiceCustomerShipping
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    customerTaxIds List<InvoiceCustomerTaxId>
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    daysUntilDue Double
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    defaultPaymentMethod String
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    defaultSource String
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    defaultTaxRates List<String>
    The tax rates applied to this invoice, if any.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    discounts List<InvoiceDiscount>
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    dueDate Double
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    effectiveAt Double
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    endingBalance Double
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    footer String
    Footer displayed on the invoice.
    fromInvoice InvoiceFromInvoice
    Details of the invoice that was cloned. See the revision documentation for more details.
    hostedInvoiceUrl String
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    invoicePdf String
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    issuer InvoiceIssuer
    lastFinalizationError InvoiceLastFinalizationError
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    latestRevision String
    The ID of the most recent non-draft revision of this invoice
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    nextPaymentAttempt Double
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    number String
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    object String
    String representing the object's type. Objects of the same type share the same value.
    onBehalfOf String
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    parent InvoiceParent
    The parent that generated this invoice
    paymentSettings InvoicePaymentSettings
    pendingInvoiceItemsBehavior String
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    periodEnd Double
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    periodStart Double
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    postPaymentCreditNotesAmount Double
    Total amount of all post-payment credit notes issued for this invoice.
    prePaymentCreditNotesAmount Double
    Total amount of all pre-payment credit notes issued for this invoice.
    receiptNumber String
    This is the transaction number that appears on email receipts sent for this invoice.
    rendering InvoiceRendering
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    shippingCost InvoiceShippingCost
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    shippingDetails InvoiceShippingDetails
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    startingBalance Double
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    statementDescriptor String
    Extra information about an invoice for the customer's credit card statement.
    status String
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    statusTransitions InvoiceStatusTransitions
    subscription String
    subtotal Double
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    subtotalExcludingTax Double
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    testClock String
    ID of the test clock this invoice belongs to.
    thresholdReason InvoiceThresholdReason
    total Double
    Total after discounts and taxes.
    totalDiscountAmounts List<InvoiceTotalDiscountAmount>
    The aggregate amounts calculated per discount across all line items.
    totalExcludingTax Double
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    totalPretaxCreditAmounts List<InvoiceTotalPretaxCreditAmount>
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    totalTaxes List<InvoiceTotalTax>
    The aggregate tax information of all line items.
    transferData InvoiceTransferData
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    webhooksDeliveredAt Double
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    accountCountry string
    The country of the business associated with this invoice, most often the business creating the invoice.
    accountName string
    The public name of the business associated with this invoice, most often the business creating the invoice.
    accountTaxIds string[]
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    amountDue number
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    amountOverpaid number
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    amountPaid number
    The amount, in cents (or local equivalent), that was paid.
    amountPaidOffStripe number
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    amountRemaining number
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    amountShipping number
    This is the sum of all the shipping amounts.
    application string
    ID of the Connect Application that created the invoice.
    applicationFeeAmount number
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    attemptCount number
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    attempted boolean
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    autoAdvance boolean
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    automaticTax InvoiceAutomaticTax
    automaticallyFinalizesAt number
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    billingReason string
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    collectionMethod string
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    confirmationSecret InvoiceConfirmationSecret
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    created number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields InvoiceCustomField[]
    Custom fields displayed on the invoice.
    customer string
    The ID of the customer to bill.
    customerAccount string
    The ID of the account representing the customer to bill.
    customerAddress InvoiceCustomerAddress
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    customerEmail string
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    customerName string
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    customerPhone string
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    customerShipping InvoiceCustomerShipping
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    customerTaxIds InvoiceCustomerTaxId[]
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    daysUntilDue number
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    defaultPaymentMethod string
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    defaultSource string
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    defaultTaxRates string[]
    The tax rates applied to this invoice, if any.
    description string
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    discounts InvoiceDiscount[]
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    dueDate number
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    effectiveAt number
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    endingBalance number
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    footer string
    Footer displayed on the invoice.
    fromInvoice InvoiceFromInvoice
    Details of the invoice that was cloned. See the revision documentation for more details.
    hostedInvoiceUrl string
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    invoicePdf string
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    issuer InvoiceIssuer
    lastFinalizationError InvoiceLastFinalizationError
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    latestRevision string
    The ID of the most recent non-draft revision of this invoice
    livemode boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    nextPaymentAttempt number
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    number string
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    object string
    String representing the object's type. Objects of the same type share the same value.
    onBehalfOf string
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    parent InvoiceParent
    The parent that generated this invoice
    paymentSettings InvoicePaymentSettings
    pendingInvoiceItemsBehavior string
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    periodEnd number
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    periodStart number
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    postPaymentCreditNotesAmount number
    Total amount of all post-payment credit notes issued for this invoice.
    prePaymentCreditNotesAmount number
    Total amount of all pre-payment credit notes issued for this invoice.
    receiptNumber string
    This is the transaction number that appears on email receipts sent for this invoice.
    rendering InvoiceRendering
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    shippingCost InvoiceShippingCost
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    shippingDetails InvoiceShippingDetails
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    startingBalance number
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    statementDescriptor string
    Extra information about an invoice for the customer's credit card statement.
    status string
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    statusTransitions InvoiceStatusTransitions
    subscription string
    subtotal number
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    subtotalExcludingTax number
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    testClock string
    ID of the test clock this invoice belongs to.
    thresholdReason InvoiceThresholdReason
    total number
    Total after discounts and taxes.
    totalDiscountAmounts InvoiceTotalDiscountAmount[]
    The aggregate amounts calculated per discount across all line items.
    totalExcludingTax number
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    totalPretaxCreditAmounts InvoiceTotalPretaxCreditAmount[]
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    totalTaxes InvoiceTotalTax[]
    The aggregate tax information of all line items.
    transferData InvoiceTransferData
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    webhooksDeliveredAt number
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    account_country str
    The country of the business associated with this invoice, most often the business creating the invoice.
    account_name str
    The public name of the business associated with this invoice, most often the business creating the invoice.
    account_tax_ids Sequence[str]
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    amount_due float
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    amount_overpaid float
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    amount_paid float
    The amount, in cents (or local equivalent), that was paid.
    amount_paid_off_stripe float
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    amount_remaining float
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    amount_shipping float
    This is the sum of all the shipping amounts.
    application str
    ID of the Connect Application that created the invoice.
    application_fee_amount float
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    attempt_count float
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    attempted bool
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    auto_advance bool
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    automatic_tax InvoiceAutomaticTaxArgs
    automatically_finalizes_at float
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    billing_reason str
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    collection_method str
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    confirmation_secret InvoiceConfirmationSecretArgs
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    created float
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    custom_fields Sequence[InvoiceCustomFieldArgs]
    Custom fields displayed on the invoice.
    customer str
    The ID of the customer to bill.
    customer_account str
    The ID of the account representing the customer to bill.
    customer_address InvoiceCustomerAddressArgs
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    customer_email str
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    customer_name str
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    customer_phone str
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    customer_shipping InvoiceCustomerShippingArgs
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    customer_tax_ids Sequence[InvoiceCustomerTaxIdArgs]
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    days_until_due float
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    default_payment_method str
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    default_source str
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    default_tax_rates Sequence[str]
    The tax rates applied to this invoice, if any.
    description str
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    discounts Sequence[InvoiceDiscountArgs]
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    due_date float
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    effective_at float
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    ending_balance float
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    footer str
    Footer displayed on the invoice.
    from_invoice InvoiceFromInvoiceArgs
    Details of the invoice that was cloned. See the revision documentation for more details.
    hosted_invoice_url str
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    invoice_pdf str
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    issuer InvoiceIssuerArgs
    last_finalization_error InvoiceLastFinalizationErrorArgs
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    latest_revision str
    The ID of the most recent non-draft revision of this invoice
    livemode bool
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    next_payment_attempt float
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    number str
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    object str
    String representing the object's type. Objects of the same type share the same value.
    on_behalf_of str
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    parent InvoiceParentArgs
    The parent that generated this invoice
    payment_settings InvoicePaymentSettingsArgs
    pending_invoice_items_behavior str
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    period_end float
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    period_start float
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    post_payment_credit_notes_amount float
    Total amount of all post-payment credit notes issued for this invoice.
    pre_payment_credit_notes_amount float
    Total amount of all pre-payment credit notes issued for this invoice.
    receipt_number str
    This is the transaction number that appears on email receipts sent for this invoice.
    rendering InvoiceRenderingArgs
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    shipping_cost InvoiceShippingCostArgs
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    shipping_details InvoiceShippingDetailsArgs
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    starting_balance float
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    statement_descriptor str
    Extra information about an invoice for the customer's credit card statement.
    status str
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    status_transitions InvoiceStatusTransitionsArgs
    subscription str
    subtotal float
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    subtotal_excluding_tax float
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    test_clock str
    ID of the test clock this invoice belongs to.
    threshold_reason InvoiceThresholdReasonArgs
    total float
    Total after discounts and taxes.
    total_discount_amounts Sequence[InvoiceTotalDiscountAmountArgs]
    The aggregate amounts calculated per discount across all line items.
    total_excluding_tax float
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    total_pretax_credit_amounts Sequence[InvoiceTotalPretaxCreditAmountArgs]
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    total_taxes Sequence[InvoiceTotalTaxArgs]
    The aggregate tax information of all line items.
    transfer_data InvoiceTransferDataArgs
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    webhooks_delivered_at float
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
    accountCountry String
    The country of the business associated with this invoice, most often the business creating the invoice.
    accountName String
    The public name of the business associated with this invoice, most often the business creating the invoice.
    accountTaxIds List<String>
    The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
    amountDue Number
    Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.
    amountOverpaid Number
    Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance.
    amountPaid Number
    The amount, in cents (or local equivalent), that was paid.
    amountPaidOffStripe Number
    Amount, in cents (or local equivalent), that was paid on the invoice outside of Stripe.
    amountRemaining Number
    The difference between amount_due and amount_paid, in cents (or local equivalent).
    amountShipping Number
    This is the sum of all the shipping amounts.
    application String
    ID of the Connect Application that created the invoice.
    applicationFeeAmount Number
    A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation.
    attemptCount Number
    Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.
    attempted Boolean
    Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.
    autoAdvance Boolean
    Controls whether Stripe performs automatic collection of the invoice. If false, the invoice's state doesn't automatically advance without an explicit action.
    automaticTax Property Map
    automaticallyFinalizesAt Number
    The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.
    billingReason String
    Indicates the reason why the invoice was created.

    • manual: Unrelated to a subscription, for example, created via the invoice editor.
    • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
    • subscription_create: A new subscription was created.
    • subscription_cycle: A subscription advanced into a new period.
    • subscription_threshold: A subscription reached a billing threshold.
    • subscription_update: A subscription was updated.
    • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.
    collectionMethod String
    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.
    confirmationSecret Property Map
    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.
    created Number
    Time at which the object was created. Measured in seconds since the Unix epoch.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    customFields List<Property Map>
    Custom fields displayed on the invoice.
    customer String
    The ID of the customer to bill.
    customerAccount String
    The ID of the account representing the customer to bill.
    customerAddress Property Map
    The customer's address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.
    customerEmail String
    The customer's email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.
    customerName String
    The customer's name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.
    customerPhone String
    The customer's phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.
    customerShipping Property Map
    The customer's shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.
    customerTaxIds List<Property Map>
    The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.
    daysUntilDue Number
    The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
    defaultPaymentMethod String
    ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
    defaultSource String
    ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
    defaultTaxRates List<String>
    The tax rates applied to this invoice, if any.
    description String
    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
    discounts List<Property Map>
    The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
    dueDate Number
    The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.
    effectiveAt Number
    The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt.
    endingBalance Number
    Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
    footer String
    Footer displayed on the invoice.
    fromInvoice Property Map
    Details of the invoice that was cloned. See the revision documentation for more details.
    hostedInvoiceUrl String
    The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
    invoicePdf String
    The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
    issuer Property Map
    lastFinalizationError Property Map
    The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
    latestRevision String
    The ID of the most recent non-draft revision of this invoice
    livemode Boolean
    If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    nextPaymentAttempt Number
    The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.
    number String
    A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
    object String
    String representing the object's type. Objects of the same type share the same value.
    onBehalfOf String
    The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.
    parent Property Map
    The parent that generated this invoice
    paymentSettings Property Map
    pendingInvoiceItemsBehavior String
    How to handle pending invoice items on invoice creation. Defaults to exclude if the parameter is omitted.
    periodEnd Number
    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    periodStart Number
    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.
    postPaymentCreditNotesAmount Number
    Total amount of all post-payment credit notes issued for this invoice.
    prePaymentCreditNotesAmount Number
    Total amount of all pre-payment credit notes issued for this invoice.
    receiptNumber String
    This is the transaction number that appears on email receipts sent for this invoice.
    rendering Property Map
    The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
    shippingCost Property Map
    The details of the cost of shipping, including the ShippingRate applied on the invoice.
    shippingDetails Property Map
    Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.
    startingBalance Number
    Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
    statementDescriptor String
    Extra information about an invoice for the customer's credit card statement.
    status String
    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more
    statusTransitions Property Map
    subscription String
    subtotal Number
    Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
    subtotalExcludingTax Number
    The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
    testClock String
    ID of the test clock this invoice belongs to.
    thresholdReason Property Map
    total Number
    Total after discounts and taxes.
    totalDiscountAmounts List<Property Map>
    The aggregate amounts calculated per discount across all line items.
    totalExcludingTax Number
    The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.
    totalPretaxCreditAmounts List<Property Map>
    Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
    totalTaxes List<Property Map>
    The aggregate tax information of all line items.
    transferData Property Map
    If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge.
    webhooksDeliveredAt Number
    Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.

    Supporting Types

    InvoiceAutomaticTax, InvoiceAutomaticTaxArgs

    Enabled bool
    Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or tax_behavior=unspecified) cannot be added to automatic tax invoices.
    DisabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    Liability InvoiceAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    Provider string
    The tax provider powering automatic tax.
    Status string
    The status of the most recent automated tax calculation for this invoice.
    Enabled bool
    Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or tax_behavior=unspecified) cannot be added to automatic tax invoices.
    DisabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    Liability InvoiceAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    Provider string
    The tax provider powering automatic tax.
    Status string
    The status of the most recent automated tax calculation for this invoice.
    enabled bool
    Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or tax_behavior=unspecified) cannot be added to automatic tax invoices.
    disabled_reason string
    If Stripe disabled automatic tax, this enum describes why.
    liability object
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    provider string
    The tax provider powering automatic tax.
    status string
    The status of the most recent automated tax calculation for this invoice.
    enabled Boolean
    Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or tax_behavior=unspecified) cannot be added to automatic tax invoices.
    disabledReason String
    If Stripe disabled automatic tax, this enum describes why.
    liability InvoiceAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    provider String
    The tax provider powering automatic tax.
    status String
    The status of the most recent automated tax calculation for this invoice.
    enabled boolean
    Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or tax_behavior=unspecified) cannot be added to automatic tax invoices.
    disabledReason string
    If Stripe disabled automatic tax, this enum describes why.
    liability InvoiceAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    provider string
    The tax provider powering automatic tax.
    status string
    The status of the most recent automated tax calculation for this invoice.
    enabled bool
    Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or tax_behavior=unspecified) cannot be added to automatic tax invoices.
    disabled_reason str
    If Stripe disabled automatic tax, this enum describes why.
    liability InvoiceAutomaticTaxLiability
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    provider str
    The tax provider powering automatic tax.
    status str
    The status of the most recent automated tax calculation for this invoice.
    enabled Boolean
    Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or tax_behavior=unspecified) cannot be added to automatic tax invoices.
    disabledReason String
    If Stripe disabled automatic tax, this enum describes why.
    liability Property Map
    The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
    provider String
    The tax provider powering automatic tax.
    status String
    The status of the most recent automated tax calculation for this invoice.

    InvoiceAutomaticTaxLiability, InvoiceAutomaticTaxLiabilityArgs

    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type str
    Type of the account referenced.
    account str
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.

    InvoiceConfirmationSecret, InvoiceConfirmationSecretArgs

    ClientSecret string
    The client_secret of the payment that Stripe creates for the invoice after finalization.
    Type string
    The type of clientsecret. Currently this is always paymentintent, referencing the default payment_intent that Stripe creates during invoice finalization
    ClientSecret string
    The client_secret of the payment that Stripe creates for the invoice after finalization.
    Type string
    The type of clientsecret. Currently this is always paymentintent, referencing the default payment_intent that Stripe creates during invoice finalization
    client_secret string
    The client_secret of the payment that Stripe creates for the invoice after finalization.
    type string
    The type of clientsecret. Currently this is always paymentintent, referencing the default payment_intent that Stripe creates during invoice finalization
    clientSecret String
    The client_secret of the payment that Stripe creates for the invoice after finalization.
    type String
    The type of clientsecret. Currently this is always paymentintent, referencing the default payment_intent that Stripe creates during invoice finalization
    clientSecret string
    The client_secret of the payment that Stripe creates for the invoice after finalization.
    type string
    The type of clientsecret. Currently this is always paymentintent, referencing the default payment_intent that Stripe creates during invoice finalization
    client_secret str
    The client_secret of the payment that Stripe creates for the invoice after finalization.
    type str
    The type of clientsecret. Currently this is always paymentintent, referencing the default payment_intent that Stripe creates during invoice finalization
    clientSecret String
    The client_secret of the payment that Stripe creates for the invoice after finalization.
    type String
    The type of clientsecret. Currently this is always paymentintent, referencing the default payment_intent that Stripe creates during invoice finalization

    InvoiceCustomField, InvoiceCustomFieldArgs

    Name string
    The name of the custom field.
    Value string
    The value of the custom field.
    Name string
    The name of the custom field.
    Value string
    The value of the custom field.
    name string
    The name of the custom field.
    value string
    The value of the custom field.
    name String
    The name of the custom field.
    value String
    The value of the custom field.
    name string
    The name of the custom field.
    value string
    The value of the custom field.
    name str
    The name of the custom field.
    value str
    The value of the custom field.
    name String
    The name of the custom field.
    value String
    The value of the custom field.

    InvoiceCustomerAddress, InvoiceCustomerAddressArgs

    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city str
    City, district, suburb, town, or village.
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 str
    Address line 1, such as the street, PO Box, or company name.
    line2 str
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code str
    ZIP or postal code.
    state str
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).

    InvoiceCustomerShipping, InvoiceCustomerShippingArgs

    Address InvoiceCustomerShippingAddress
    Carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    Name string
    Recipient name.
    Phone string
    Recipient phone (including extension).
    TrackingNumber string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    Address InvoiceCustomerShippingAddress
    Carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    Name string
    Recipient name.
    Phone string
    Recipient phone (including extension).
    TrackingNumber string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address object
    carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    name string
    Recipient name.
    phone string
    Recipient phone (including extension).
    tracking_number string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address InvoiceCustomerShippingAddress
    carrier String
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    name String
    Recipient name.
    phone String
    Recipient phone (including extension).
    trackingNumber String
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address InvoiceCustomerShippingAddress
    carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    name string
    Recipient name.
    phone string
    Recipient phone (including extension).
    trackingNumber string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address InvoiceCustomerShippingAddress
    carrier str
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    name str
    Recipient name.
    phone str
    Recipient phone (including extension).
    tracking_number str
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address Property Map
    carrier String
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    name String
    Recipient name.
    phone String
    Recipient phone (including extension).
    trackingNumber String
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

    InvoiceCustomerShippingAddress, InvoiceCustomerShippingAddressArgs

    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city str
    City, district, suburb, town, or village.
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 str
    Address line 1, such as the street, PO Box, or company name.
    line2 str
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code str
    ZIP or postal code.
    state str
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).

    InvoiceCustomerTaxId, InvoiceCustomerTaxIdArgs

    Type string
    The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, lk_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown
    Value string
    The value of the tax ID.
    Type string
    The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, lk_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown
    Value string
    The value of the tax ID.
    type string
    The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, lk_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown
    value string
    The value of the tax ID.
    type String
    The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, lk_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown
    value String
    The value of the tax ID.
    type string
    The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, lk_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown
    value string
    The value of the tax ID.
    type str
    The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, lk_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown
    value str
    The value of the tax ID.
    type String
    The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, pl_nip, it_cf, fo_vat, gi_tin, py_ruc, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, lk_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown
    value String
    The value of the tax ID.

    InvoiceDiscount, InvoiceDiscountArgs

    Coupon string
    ID of the coupon to create a new discount for.
    Discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    PromotionCode string
    ID of the promotion code to create a new discount for.
    Coupon string
    ID of the coupon to create a new discount for.
    Discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    PromotionCode string
    ID of the promotion code to create a new discount for.
    coupon string
    ID of the coupon to create a new discount for.
    discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotion_code string
    ID of the promotion code to create a new discount for.
    coupon String
    ID of the coupon to create a new discount for.
    discount String
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode String
    ID of the promotion code to create a new discount for.
    coupon string
    ID of the coupon to create a new discount for.
    discount string
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode string
    ID of the promotion code to create a new discount for.
    coupon str
    ID of the coupon to create a new discount for.
    discount str
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotion_code str
    ID of the promotion code to create a new discount for.
    coupon String
    ID of the coupon to create a new discount for.
    discount String
    ID of an existing discount on the object (or one of its ancestors) to reuse.
    promotionCode String
    ID of the promotion code to create a new discount for.

    InvoiceFromInvoice, InvoiceFromInvoiceArgs

    Action string
    The relation between this invoice and the cloned invoice
    Invoice string
    The invoice that was cloned.
    Action string
    The relation between this invoice and the cloned invoice
    Invoice string
    The invoice that was cloned.
    action string
    The relation between this invoice and the cloned invoice
    invoice string
    The invoice that was cloned.
    action String
    The relation between this invoice and the cloned invoice
    invoice String
    The invoice that was cloned.
    action string
    The relation between this invoice and the cloned invoice
    invoice string
    The invoice that was cloned.
    action str
    The relation between this invoice and the cloned invoice
    invoice str
    The invoice that was cloned.
    action String
    The relation between this invoice and the cloned invoice
    invoice String
    The invoice that was cloned.

    InvoiceIssuer, InvoiceIssuerArgs

    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    Type string
    Type of the account referenced.
    Account string
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.
    type string
    Type of the account referenced.
    account string
    The connected account being referenced when type is account.
    type str
    Type of the account referenced.
    account str
    The connected account being referenced when type is account.
    type String
    Type of the account referenced.
    account String
    The connected account being referenced when type is account.

    InvoiceLastFinalizationError, InvoiceLastFinalizationErrorArgs

    AdviceCode string
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    Charge string
    For card errors, the ID of the failed charge.
    Code string
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    DeclineCode string
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    DocUrl string
    A URL to more information about the error code reported.
    Message string
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    NetworkAdviceCode string
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    NetworkDeclineCode string
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    Param string
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    PaymentIntent string
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    PaymentMethod string

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    PaymentMethodType string
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    RequestLogUrl string
    A URL to the request log entry in your dashboard.
    SetupIntent string

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    Source string
    Type string
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    AdviceCode string
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    Charge string
    For card errors, the ID of the failed charge.
    Code string
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    DeclineCode string
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    DocUrl string
    A URL to more information about the error code reported.
    Message string
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    NetworkAdviceCode string
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    NetworkDeclineCode string
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    Param string
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    PaymentIntent string
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    PaymentMethod string

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    PaymentMethodType string
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    RequestLogUrl string
    A URL to the request log entry in your dashboard.
    SetupIntent string

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    Source string
    Type string
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    advice_code string
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    charge string
    For card errors, the ID of the failed charge.
    code string
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    decline_code string
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    doc_url string
    A URL to more information about the error code reported.
    message string
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    network_advice_code string
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    network_decline_code string
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    param string
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    payment_intent string
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    payment_method string

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    payment_method_type string
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    request_log_url string
    A URL to the request log entry in your dashboard.
    setup_intent string

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    source string
    type string
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    adviceCode String
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    charge String
    For card errors, the ID of the failed charge.
    code String
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    declineCode String
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    docUrl String
    A URL to more information about the error code reported.
    message String
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    networkAdviceCode String
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    networkDeclineCode String
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    param String
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    paymentIntent String
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    paymentMethod String

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    paymentMethodType String
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    requestLogUrl String
    A URL to the request log entry in your dashboard.
    setupIntent String

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    source String
    type String
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    adviceCode string
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    charge string
    For card errors, the ID of the failed charge.
    code string
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    declineCode string
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    docUrl string
    A URL to more information about the error code reported.
    message string
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    networkAdviceCode string
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    networkDeclineCode string
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    param string
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    paymentIntent string
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    paymentMethod string

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    paymentMethodType string
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    requestLogUrl string
    A URL to the request log entry in your dashboard.
    setupIntent string

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    source string
    type string
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    advice_code str
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    charge str
    For card errors, the ID of the failed charge.
    code str
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    decline_code str
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    doc_url str
    A URL to more information about the error code reported.
    message str
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    network_advice_code str
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    network_decline_code str
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    param str
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    payment_intent str
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    payment_method str

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    payment_method_type str
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    request_log_url str
    A URL to the request log entry in your dashboard.
    setup_intent str

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    source str
    type str
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
    adviceCode String
    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.
    charge String
    For card errors, the ID of the failed charge.
    code String
    For some errors that could be handled programmatically, a short string indicating the error code reported.
    declineCode String
    For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.
    docUrl String
    A URL to more information about the error code reported.
    message String
    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
    networkAdviceCode String
    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
    networkDeclineCode String
    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
    param String
    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
    paymentIntent String
    A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.
    paymentMethod String

    PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

    Related guides: Payment Methods and More Payment Scenarios.

    paymentMethodType String
    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
    requestLogUrl String
    A URL to the request log entry in your dashboard.
    setupIntent String

    A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

    Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

    Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

    By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

    Related guide: Setup Intents API

    source String
    type String
    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

    InvoiceParent, InvoiceParentArgs

    QuoteDetails InvoiceParentQuoteDetails
    Details about the quote that generated this invoice
    SubscriptionDetails InvoiceParentSubscriptionDetails
    Details about the subscription that generated this invoice
    Type string
    The type of parent that generated this invoice
    QuoteDetails InvoiceParentQuoteDetails
    Details about the quote that generated this invoice
    SubscriptionDetails InvoiceParentSubscriptionDetails
    Details about the subscription that generated this invoice
    Type string
    The type of parent that generated this invoice
    quote_details object
    Details about the quote that generated this invoice
    subscription_details object
    Details about the subscription that generated this invoice
    type string
    The type of parent that generated this invoice
    quoteDetails InvoiceParentQuoteDetails
    Details about the quote that generated this invoice
    subscriptionDetails InvoiceParentSubscriptionDetails
    Details about the subscription that generated this invoice
    type String
    The type of parent that generated this invoice
    quoteDetails InvoiceParentQuoteDetails
    Details about the quote that generated this invoice
    subscriptionDetails InvoiceParentSubscriptionDetails
    Details about the subscription that generated this invoice
    type string
    The type of parent that generated this invoice
    quote_details InvoiceParentQuoteDetails
    Details about the quote that generated this invoice
    subscription_details InvoiceParentSubscriptionDetails
    Details about the subscription that generated this invoice
    type str
    The type of parent that generated this invoice
    quoteDetails Property Map
    Details about the quote that generated this invoice
    subscriptionDetails Property Map
    Details about the subscription that generated this invoice
    type String
    The type of parent that generated this invoice

    InvoiceParentQuoteDetails, InvoiceParentQuoteDetailsArgs

    Quote string
    The quote that generated this invoice
    Quote string
    The quote that generated this invoice
    quote string
    The quote that generated this invoice
    quote String
    The quote that generated this invoice
    quote string
    The quote that generated this invoice
    quote str
    The quote that generated this invoice
    quote String
    The quote that generated this invoice

    InvoiceParentSubscriptionDetails, InvoiceParentSubscriptionDetailsArgs

    Metadata Dictionary<string, string>
    Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. Note: This attribute is populated only for invoices created on or after June 29, 2023.
    Subscription string
    The subscription that generated this invoice
    SubscriptionProrationDate double
    Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
    Metadata map[string]string
    Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. Note: This attribute is populated only for invoices created on or after June 29, 2023.
    Subscription string
    The subscription that generated this invoice
    SubscriptionProrationDate float64
    Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
    metadata map(string)
    Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. Note: This attribute is populated only for invoices created on or after June 29, 2023.
    subscription string
    The subscription that generated this invoice
    subscription_proration_date number
    Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
    metadata Map<String,String>
    Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. Note: This attribute is populated only for invoices created on or after June 29, 2023.
    subscription String
    The subscription that generated this invoice
    subscriptionProrationDate Double
    Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
    metadata {[key: string]: string}
    Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. Note: This attribute is populated only for invoices created on or after June 29, 2023.
    subscription string
    The subscription that generated this invoice
    subscriptionProrationDate number
    Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
    metadata Mapping[str, str]
    Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. Note: This attribute is populated only for invoices created on or after June 29, 2023.
    subscription str
    The subscription that generated this invoice
    subscription_proration_date float
    Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
    metadata Map<String>
    Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. Note: This attribute is populated only for invoices created on or after June 29, 2023.
    subscription String
    The subscription that generated this invoice
    subscriptionProrationDate Number
    Only set for upcoming invoices that preview prorations. The time used to calculate prorations.

    InvoicePaymentSettings, InvoicePaymentSettingsArgs

    DefaultMandate string
    ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's defaultpaymentmethod or default_source, if set.
    PaymentMethodOptions InvoicePaymentSettingsPaymentMethodOptions
    Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
    PaymentMethodTypes List<string>
    The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    DefaultMandate string
    ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's defaultpaymentmethod or default_source, if set.
    PaymentMethodOptions InvoicePaymentSettingsPaymentMethodOptions
    Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
    PaymentMethodTypes []string
    The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    default_mandate string
    ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's defaultpaymentmethod or default_source, if set.
    payment_method_options object
    Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
    payment_method_types list(string)
    The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    defaultMandate String
    ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's defaultpaymentmethod or default_source, if set.
    paymentMethodOptions InvoicePaymentSettingsPaymentMethodOptions
    Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
    paymentMethodTypes List<String>
    The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    defaultMandate string
    ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's defaultpaymentmethod or default_source, if set.
    paymentMethodOptions InvoicePaymentSettingsPaymentMethodOptions
    Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
    paymentMethodTypes string[]
    The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    default_mandate str
    ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's defaultpaymentmethod or default_source, if set.
    payment_method_options InvoicePaymentSettingsPaymentMethodOptions
    Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
    payment_method_types Sequence[str]
    The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.
    defaultMandate String
    ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's defaultpaymentmethod or default_source, if set.
    paymentMethodOptions Property Map
    Payment-method-specific configuration to provide to the invoice’s PaymentIntent.
    paymentMethodTypes List<String>
    The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.

    InvoicePaymentSettingsPaymentMethodOptions, InvoicePaymentSettingsPaymentMethodOptionsArgs

    AcssDebit InvoicePaymentSettingsPaymentMethodOptionsAcssDebit
    If paying by acss_debit, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
    Bancontact InvoicePaymentSettingsPaymentMethodOptionsBancontact
    If paying by bancontact, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
    Card InvoicePaymentSettingsPaymentMethodOptionsCard
    If paying by card, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
    CustomerBalance InvoicePaymentSettingsPaymentMethodOptionsCustomerBalance
    If paying by customer_balance, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
    Payto InvoicePaymentSettingsPaymentMethodOptionsPayto
    If paying by payto, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
    Pix InvoicePaymentSettingsPaymentMethodOptionsPix
    If paying by pix, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
    Upi InvoicePaymentSettingsPaymentMethodOptionsUpi
    If paying by upi, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
    UsBankAccount InvoicePaymentSettingsPaymentMethodOptionsUsBankAccount
    If paying by us_bank_account, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
    AcssDebit InvoicePaymentSettingsPaymentMethodOptionsAcssDebit
    If paying by acss_debit, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
    Bancontact InvoicePaymentSettingsPaymentMethodOptionsBancontact
    If paying by bancontact, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
    Card InvoicePaymentSettingsPaymentMethodOptionsCard
    If paying by card, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
    CustomerBalance InvoicePaymentSettingsPaymentMethodOptionsCustomerBalance
    If paying by customer_balance, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
    Payto InvoicePaymentSettingsPaymentMethodOptionsPayto
    If paying by payto, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
    Pix InvoicePaymentSettingsPaymentMethodOptionsPix
    If paying by pix, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
    Upi InvoicePaymentSettingsPaymentMethodOptionsUpi
    If paying by upi, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
    UsBankAccount InvoicePaymentSettingsPaymentMethodOptionsUsBankAccount
    If paying by us_bank_account, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
    acss_debit object
    If paying by acss_debit, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
    bancontact object
    If paying by bancontact, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
    card object
    If paying by card, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
    customer_balance object
    If paying by customer_balance, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
    payto object
    If paying by payto, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
    pix object
    If paying by pix, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
    upi object
    If paying by upi, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
    us_bank_account object
    If paying by us_bank_account, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
    acssDebit InvoicePaymentSettingsPaymentMethodOptionsAcssDebit
    If paying by acss_debit, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
    bancontact InvoicePaymentSettingsPaymentMethodOptionsBancontact
    If paying by bancontact, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
    card InvoicePaymentSettingsPaymentMethodOptionsCard
    If paying by card, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
    customerBalance InvoicePaymentSettingsPaymentMethodOptionsCustomerBalance
    If paying by customer_balance, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
    payto InvoicePaymentSettingsPaymentMethodOptionsPayto
    If paying by payto, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
    pix InvoicePaymentSettingsPaymentMethodOptionsPix
    If paying by pix, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
    upi InvoicePaymentSettingsPaymentMethodOptionsUpi
    If paying by upi, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
    usBankAccount InvoicePaymentSettingsPaymentMethodOptionsUsBankAccount
    If paying by us_bank_account, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
    acssDebit InvoicePaymentSettingsPaymentMethodOptionsAcssDebit
    If paying by acss_debit, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
    bancontact InvoicePaymentSettingsPaymentMethodOptionsBancontact
    If paying by bancontact, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
    card InvoicePaymentSettingsPaymentMethodOptionsCard
    If paying by card, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
    customerBalance InvoicePaymentSettingsPaymentMethodOptionsCustomerBalance
    If paying by customer_balance, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
    payto InvoicePaymentSettingsPaymentMethodOptionsPayto
    If paying by payto, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
    pix InvoicePaymentSettingsPaymentMethodOptionsPix
    If paying by pix, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
    upi InvoicePaymentSettingsPaymentMethodOptionsUpi
    If paying by upi, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
    usBankAccount InvoicePaymentSettingsPaymentMethodOptionsUsBankAccount
    If paying by us_bank_account, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
    acss_debit InvoicePaymentSettingsPaymentMethodOptionsAcssDebit
    If paying by acss_debit, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
    bancontact InvoicePaymentSettingsPaymentMethodOptionsBancontact
    If paying by bancontact, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
    card InvoicePaymentSettingsPaymentMethodOptionsCard
    If paying by card, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
    customer_balance InvoicePaymentSettingsPaymentMethodOptionsCustomerBalance
    If paying by customer_balance, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
    payto InvoicePaymentSettingsPaymentMethodOptionsPayto
    If paying by payto, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
    pix InvoicePaymentSettingsPaymentMethodOptionsPix
    If paying by pix, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
    upi InvoicePaymentSettingsPaymentMethodOptionsUpi
    If paying by upi, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
    us_bank_account InvoicePaymentSettingsPaymentMethodOptionsUsBankAccount
    If paying by us_bank_account, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
    acssDebit Property Map
    If paying by acss_debit, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
    bancontact Property Map
    If paying by bancontact, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
    card Property Map
    If paying by card, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
    customerBalance Property Map
    If paying by customer_balance, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
    payto Property Map
    If paying by payto, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent.
    pix Property Map
    If paying by pix, this sub-hash contains details about the Pix payment method options to pass to the invoice’s PaymentIntent.
    upi Property Map
    If paying by upi, this sub-hash contains details about the UPI payment method options to pass to the invoice’s PaymentIntent.
    usBankAccount Property Map
    If paying by us_bank_account, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.

    InvoicePaymentSettingsPaymentMethodOptionsAcssDebit, InvoicePaymentSettingsPaymentMethodOptionsAcssDebitArgs

    MandateOptions InvoicePaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions
    VerificationMethod string
    Bank account verification method. The default value is automatic.
    MandateOptions InvoicePaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions
    VerificationMethod string
    Bank account verification method. The default value is automatic.
    mandate_options object
    verification_method string
    Bank account verification method. The default value is automatic.
    mandateOptions InvoicePaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions
    verificationMethod String
    Bank account verification method. The default value is automatic.
    mandateOptions InvoicePaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions
    verificationMethod string
    Bank account verification method. The default value is automatic.
    mandate_options InvoicePaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions
    verification_method str
    Bank account verification method. The default value is automatic.
    mandateOptions Property Map
    verificationMethod String
    Bank account verification method. The default value is automatic.

    InvoicePaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions, InvoicePaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsArgs

    TransactionType string
    Transaction type of the mandate.
    TransactionType string
    Transaction type of the mandate.
    transaction_type string
    Transaction type of the mandate.
    transactionType String
    Transaction type of the mandate.
    transactionType string
    Transaction type of the mandate.
    transaction_type str
    Transaction type of the mandate.
    transactionType String
    Transaction type of the mandate.

    InvoicePaymentSettingsPaymentMethodOptionsBancontact, InvoicePaymentSettingsPaymentMethodOptionsBancontactArgs

    PreferredLanguage string
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    PreferredLanguage string
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    preferred_language string
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    preferredLanguage String
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    preferredLanguage string
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    preferred_language str
    Preferred language of the Bancontact authorization page that the customer is redirected to.
    preferredLanguage String
    Preferred language of the Bancontact authorization page that the customer is redirected to.

    InvoicePaymentSettingsPaymentMethodOptionsCard, InvoicePaymentSettingsPaymentMethodOptionsCardArgs

    Installments InvoicePaymentSettingsPaymentMethodOptionsCardInstallments
    RequestThreeDSecure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    Installments InvoicePaymentSettingsPaymentMethodOptionsCardInstallments
    RequestThreeDSecure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    installments object
    request_three_d_secure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    installments InvoicePaymentSettingsPaymentMethodOptionsCardInstallments
    requestThreeDSecure String
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    installments InvoicePaymentSettingsPaymentMethodOptionsCardInstallments
    requestThreeDSecure string
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    installments InvoicePaymentSettingsPaymentMethodOptionsCardInstallments
    request_three_d_secure str
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.
    installments Property Map
    requestThreeDSecure String
    We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.

    InvoicePaymentSettingsPaymentMethodOptionsCardInstallments, InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsArgs

    Enabled bool
    Whether Installments are enabled for this Invoice.
    Plan InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlan
    The selected installment plan to use for this invoice.
    Enabled bool
    Whether Installments are enabled for this Invoice.
    Plan InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlan
    The selected installment plan to use for this invoice.
    enabled bool
    Whether Installments are enabled for this Invoice.
    plan object
    The selected installment plan to use for this invoice.
    enabled Boolean
    Whether Installments are enabled for this Invoice.
    plan InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlan
    The selected installment plan to use for this invoice.
    enabled boolean
    Whether Installments are enabled for this Invoice.
    plan InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlan
    The selected installment plan to use for this invoice.
    enabled bool
    Whether Installments are enabled for this Invoice.
    plan InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlan
    The selected installment plan to use for this invoice.
    enabled Boolean
    Whether Installments are enabled for this Invoice.
    plan Property Map
    The selected installment plan to use for this invoice.

    InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlan, InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlanArgs

    Type string
    Type of installment plan, one of fixed_count, bonus, or revolving.
    Count double
    For fixed_count installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
    Interval string
    For fixed_count installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card. One of month.
    Type string
    Type of installment plan, one of fixed_count, bonus, or revolving.
    Count float64
    For fixed_count installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
    Interval string
    For fixed_count installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card. One of month.
    type string
    Type of installment plan, one of fixed_count, bonus, or revolving.
    count number
    For fixed_count installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
    interval string
    For fixed_count installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card. One of month.
    type String
    Type of installment plan, one of fixed_count, bonus, or revolving.
    count Double
    For fixed_count installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
    interval String
    For fixed_count installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card. One of month.
    type string
    Type of installment plan, one of fixed_count, bonus, or revolving.
    count number
    For fixed_count installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
    interval string
    For fixed_count installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card. One of month.
    type str
    Type of installment plan, one of fixed_count, bonus, or revolving.
    count float
    For fixed_count installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
    interval str
    For fixed_count installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card. One of month.
    type String
    Type of installment plan, one of fixed_count, bonus, or revolving.
    count Number
    For fixed_count installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
    interval String
    For fixed_count installment plans, this is required. It represents the interval between installment payments your customer will make to their credit card. One of month.

    InvoicePaymentSettingsPaymentMethodOptionsCustomerBalance, InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceArgs

    BankTransfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer
    FundingType string
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    BankTransfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer
    FundingType string
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    bank_transfer object
    funding_type string
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    bankTransfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer
    fundingType String
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    bankTransfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer
    fundingType string
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    bank_transfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer
    funding_type str
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.
    bankTransfer Property Map
    fundingType String
    The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.

    InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer, InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferArgs

    EuBankTransfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
    Type string
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    EuBankTransfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
    Type string
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    eu_bank_transfer object
    type string
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    euBankTransfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
    type String
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    euBankTransfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
    type string
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    eu_bank_transfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
    type str
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.
    euBankTransfer Property Map
    type String
    The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.

    InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer, InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransferArgs

    Country string
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    Country string
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    country string
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    country String
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    country string
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    country str
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.
    country String
    The desired country code of the bank account information. Permitted values include: DE, FR, IE, or NL.

    InvoicePaymentSettingsPaymentMethodOptionsPayto, InvoicePaymentSettingsPaymentMethodOptionsPaytoArgs

    InvoicePaymentSettingsPaymentMethodOptionsPaytoMandateOptions, InvoicePaymentSettingsPaymentMethodOptionsPaytoMandateOptionsArgs

    Amount double
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    AmountType string
    Only maximum is supported.
    Purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    Amount float64
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    AmountType string
    Only maximum is supported.
    Purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    amount number
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    amount_type string
    Only maximum is supported.
    purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    amount Double
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    amountType String
    Only maximum is supported.
    purpose String
    The purpose for which payments are made. Has a default value based on your merchant category code.
    amount number
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    amountType string
    Only maximum is supported.
    purpose string
    The purpose for which payments are made. Has a default value based on your merchant category code.
    amount float
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    amount_type str
    Only maximum is supported.
    purpose str
    The purpose for which payments are made. Has a default value based on your merchant category code.
    amount Number
    The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit.
    amountType String
    Only maximum is supported.
    purpose String
    The purpose for which payments are made. Has a default value based on your merchant category code.

    InvoicePaymentSettingsPaymentMethodOptionsPix, InvoicePaymentSettingsPaymentMethodOptionsPixArgs

    AmountIncludesIof string
    Determines if the amount includes the IOF tax.
    ExpiresAfterSeconds double
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    AmountIncludesIof string
    Determines if the amount includes the IOF tax.
    ExpiresAfterSeconds float64
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    amount_includes_iof string
    Determines if the amount includes the IOF tax.
    expires_after_seconds number
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    amountIncludesIof String
    Determines if the amount includes the IOF tax.
    expiresAfterSeconds Double
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    amountIncludesIof string
    Determines if the amount includes the IOF tax.
    expiresAfterSeconds number
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    amount_includes_iof str
    Determines if the amount includes the IOF tax.
    expires_after_seconds float
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
    amountIncludesIof String
    Determines if the amount includes the IOF tax.
    expiresAfterSeconds Number
    The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.

    InvoicePaymentSettingsPaymentMethodOptionsUpi, InvoicePaymentSettingsPaymentMethodOptionsUpiArgs

    InvoicePaymentSettingsPaymentMethodOptionsUpiMandateOptions, InvoicePaymentSettingsPaymentMethodOptionsUpiMandateOptionsArgs

    Amount double
    Amount to be charged for future payments.
    AmountType string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    EndDate double
    End date of the mandate or subscription.
    Amount float64
    Amount to be charged for future payments.
    AmountType string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    Description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    EndDate float64
    End date of the mandate or subscription.
    amount number
    Amount to be charged for future payments.
    amount_type string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    end_date number
    End date of the mandate or subscription.
    amount Double
    Amount to be charged for future payments.
    amountType String
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate Double
    End date of the mandate or subscription.
    amount number
    Amount to be charged for future payments.
    amountType string
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description string
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate number
    End date of the mandate or subscription.
    amount float
    Amount to be charged for future payments.
    amount_type str
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description str
    A description of the mandate or subscription that is meant to be displayed to the customer.
    end_date float
    End date of the mandate or subscription.
    amount Number
    Amount to be charged for future payments.
    amountType String
    One of fixed or maximum. If fixed, the amount param refers to the exact amount to be charged in future payments. If maximum, the amount charged can be up to the value passed for the amount param.
    description String
    A description of the mandate or subscription that is meant to be displayed to the customer.
    endDate Number
    End date of the mandate or subscription.

    InvoicePaymentSettingsPaymentMethodOptionsUsBankAccount, InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountArgs

    financial_connections object
    verification_method string
    Bank account verification method. The default value is automatic.
    financialConnections Property Map
    verificationMethod String
    Bank account verification method. The default value is automatic.

    InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections, InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsArgs

    Filters InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    Permissions List<string>
    The list of permissions to request. The payment_method permission must be included.
    Prefetches List<string>
    Data features requested to be retrieved upon account creation.
    Filters InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    Permissions []string
    The list of permissions to request. The payment_method permission must be included.
    Prefetches []string
    Data features requested to be retrieved upon account creation.
    filters object
    permissions list(string)
    The list of permissions to request. The payment_method permission must be included.
    prefetches list(string)
    Data features requested to be retrieved upon account creation.
    filters InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    permissions List<String>
    The list of permissions to request. The payment_method permission must be included.
    prefetches List<String>
    Data features requested to be retrieved upon account creation.
    filters InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    permissions string[]
    The list of permissions to request. The payment_method permission must be included.
    prefetches string[]
    Data features requested to be retrieved upon account creation.
    filters InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters
    permissions Sequence[str]
    The list of permissions to request. The payment_method permission must be included.
    prefetches Sequence[str]
    Data features requested to be retrieved upon account creation.
    filters Property Map
    permissions List<String>
    The list of permissions to request. The payment_method permission must be included.
    prefetches List<String>
    Data features requested to be retrieved upon account creation.

    InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFilters, InvoicePaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsFiltersArgs

    AccountSubcategories List<string>
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    AccountSubcategories []string
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    account_subcategories list(string)
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    accountSubcategories List<String>
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    accountSubcategories string[]
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    account_subcategories Sequence[str]
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
    accountSubcategories List<String>
    The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.

    InvoiceRendering, InvoiceRenderingArgs

    AmountTaxDisplay string
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    Pdf InvoiceRenderingPdf
    Invoice pdf rendering options
    Template string
    ID of the rendering template that the invoice is formatted by.
    TemplateVersion double
    Version of the rendering template that the invoice is using.
    AmountTaxDisplay string
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    Pdf InvoiceRenderingPdf
    Invoice pdf rendering options
    Template string
    ID of the rendering template that the invoice is formatted by.
    TemplateVersion float64
    Version of the rendering template that the invoice is using.
    amount_tax_display string
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    pdf object
    Invoice pdf rendering options
    template string
    ID of the rendering template that the invoice is formatted by.
    template_version number
    Version of the rendering template that the invoice is using.
    amountTaxDisplay String
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    pdf InvoiceRenderingPdf
    Invoice pdf rendering options
    template String
    ID of the rendering template that the invoice is formatted by.
    templateVersion Double
    Version of the rendering template that the invoice is using.
    amountTaxDisplay string
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    pdf InvoiceRenderingPdf
    Invoice pdf rendering options
    template string
    ID of the rendering template that the invoice is formatted by.
    templateVersion number
    Version of the rendering template that the invoice is using.
    amount_tax_display str
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    pdf InvoiceRenderingPdf
    Invoice pdf rendering options
    template str
    ID of the rendering template that the invoice is formatted by.
    template_version float
    Version of the rendering template that the invoice is using.
    amountTaxDisplay String
    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
    pdf Property Map
    Invoice pdf rendering options
    template String
    ID of the rendering template that the invoice is formatted by.
    templateVersion Number
    Version of the rendering template that the invoice is using.

    InvoiceRenderingPdf, InvoiceRenderingPdfArgs

    PageSize string
    Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
    PageSize string
    Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
    page_size string
    Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
    pageSize String
    Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
    pageSize string
    Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
    page_size str
    Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.
    pageSize String
    Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.

    InvoiceShippingCost, InvoiceShippingCostArgs

    AmountSubtotal double
    Total shipping cost before any taxes are applied.
    AmountTax double
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    AmountTotal double
    Total shipping cost after taxes are applied.
    ShippingRate string
    The ID of the ShippingRate for this invoice.
    ShippingRateData InvoiceShippingCostShippingRateData
    Parameters to create a new ad-hoc shipping rate for this order.
    Taxes List<InvoiceShippingCostTax>
    The taxes applied to the shipping rate.
    AmountSubtotal float64
    Total shipping cost before any taxes are applied.
    AmountTax float64
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    AmountTotal float64
    Total shipping cost after taxes are applied.
    ShippingRate string
    The ID of the ShippingRate for this invoice.
    ShippingRateData InvoiceShippingCostShippingRateData
    Parameters to create a new ad-hoc shipping rate for this order.
    Taxes []InvoiceShippingCostTax
    The taxes applied to the shipping rate.
    amount_subtotal number
    Total shipping cost before any taxes are applied.
    amount_tax number
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    amount_total number
    Total shipping cost after taxes are applied.
    shipping_rate string
    The ID of the ShippingRate for this invoice.
    shipping_rate_data object
    Parameters to create a new ad-hoc shipping rate for this order.
    taxes list(object)
    The taxes applied to the shipping rate.
    amountSubtotal Double
    Total shipping cost before any taxes are applied.
    amountTax Double
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    amountTotal Double
    Total shipping cost after taxes are applied.
    shippingRate String
    The ID of the ShippingRate for this invoice.
    shippingRateData InvoiceShippingCostShippingRateData
    Parameters to create a new ad-hoc shipping rate for this order.
    taxes List<InvoiceShippingCostTax>
    The taxes applied to the shipping rate.
    amountSubtotal number
    Total shipping cost before any taxes are applied.
    amountTax number
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    amountTotal number
    Total shipping cost after taxes are applied.
    shippingRate string
    The ID of the ShippingRate for this invoice.
    shippingRateData InvoiceShippingCostShippingRateData
    Parameters to create a new ad-hoc shipping rate for this order.
    taxes InvoiceShippingCostTax[]
    The taxes applied to the shipping rate.
    amount_subtotal float
    Total shipping cost before any taxes are applied.
    amount_tax float
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    amount_total float
    Total shipping cost after taxes are applied.
    shipping_rate str
    The ID of the ShippingRate for this invoice.
    shipping_rate_data InvoiceShippingCostShippingRateData
    Parameters to create a new ad-hoc shipping rate for this order.
    taxes Sequence[InvoiceShippingCostTax]
    The taxes applied to the shipping rate.
    amountSubtotal Number
    Total shipping cost before any taxes are applied.
    amountTax Number
    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
    amountTotal Number
    Total shipping cost after taxes are applied.
    shippingRate String
    The ID of the ShippingRate for this invoice.
    shippingRateData Property Map
    Parameters to create a new ad-hoc shipping rate for this order.
    taxes List<Property Map>
    The taxes applied to the shipping rate.

    InvoiceShippingCostShippingRateData, InvoiceShippingCostShippingRateDataArgs

    DisplayName string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    DeliveryEstimate InvoiceShippingCostShippingRateDataDeliveryEstimate
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    FixedAmount InvoiceShippingCostShippingRateDataFixedAmount
    Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
    Metadata Dictionary<string, string>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    TaxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    TaxCode string
    A tax code ID. The Shipping tax code is txcd_92010001.
    Type string
    The type of calculation to use on the shipping rate.
    DisplayName string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    DeliveryEstimate InvoiceShippingCostShippingRateDataDeliveryEstimate
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    FixedAmount InvoiceShippingCostShippingRateDataFixedAmount
    Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
    Metadata map[string]string
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    TaxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    TaxCode string
    A tax code ID. The Shipping tax code is txcd_92010001.
    Type string
    The type of calculation to use on the shipping rate.
    display_name string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    delivery_estimate object
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixed_amount object
    Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
    metadata map(string)
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    tax_behavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    tax_code string
    A tax code ID. The Shipping tax code is txcd_92010001.
    type string
    The type of calculation to use on the shipping rate.
    displayName String
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    deliveryEstimate InvoiceShippingCostShippingRateDataDeliveryEstimate
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixedAmount InvoiceShippingCostShippingRateDataFixedAmount
    Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
    metadata Map<String,String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    taxBehavior String
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    taxCode String
    A tax code ID. The Shipping tax code is txcd_92010001.
    type String
    The type of calculation to use on the shipping rate.
    displayName string
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    deliveryEstimate InvoiceShippingCostShippingRateDataDeliveryEstimate
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixedAmount InvoiceShippingCostShippingRateDataFixedAmount
    Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
    metadata {[key: string]: string}
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    taxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    taxCode string
    A tax code ID. The Shipping tax code is txcd_92010001.
    type string
    The type of calculation to use on the shipping rate.
    display_name str
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    delivery_estimate InvoiceShippingCostShippingRateDataDeliveryEstimate
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixed_amount InvoiceShippingCostShippingRateDataFixedAmount
    Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
    metadata Mapping[str, str]
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    tax_behavior str
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    tax_code str
    A tax code ID. The Shipping tax code is txcd_92010001.
    type str
    The type of calculation to use on the shipping rate.
    displayName String
    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
    deliveryEstimate Property Map
    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
    fixedAmount Property Map
    Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
    metadata Map<String>
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
    taxBehavior String
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    taxCode String
    A tax code ID. The Shipping tax code is txcd_92010001.
    type String
    The type of calculation to use on the shipping rate.

    InvoiceShippingCostShippingRateDataDeliveryEstimate, InvoiceShippingCostShippingRateDataDeliveryEstimateArgs

    Maximum InvoiceShippingCostShippingRateDataDeliveryEstimateMaximum
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    Minimum InvoiceShippingCostShippingRateDataDeliveryEstimateMinimum
    The lower bound of the estimated range. If empty, represents no lower bound.
    Maximum InvoiceShippingCostShippingRateDataDeliveryEstimateMaximum
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    Minimum InvoiceShippingCostShippingRateDataDeliveryEstimateMinimum
    The lower bound of the estimated range. If empty, represents no lower bound.
    maximum object
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    minimum object
    The lower bound of the estimated range. If empty, represents no lower bound.
    maximum InvoiceShippingCostShippingRateDataDeliveryEstimateMaximum
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    minimum InvoiceShippingCostShippingRateDataDeliveryEstimateMinimum
    The lower bound of the estimated range. If empty, represents no lower bound.
    maximum InvoiceShippingCostShippingRateDataDeliveryEstimateMaximum
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    minimum InvoiceShippingCostShippingRateDataDeliveryEstimateMinimum
    The lower bound of the estimated range. If empty, represents no lower bound.
    maximum InvoiceShippingCostShippingRateDataDeliveryEstimateMaximum
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    minimum InvoiceShippingCostShippingRateDataDeliveryEstimateMinimum
    The lower bound of the estimated range. If empty, represents no lower bound.
    maximum Property Map
    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
    minimum Property Map
    The lower bound of the estimated range. If empty, represents no lower bound.

    InvoiceShippingCostShippingRateDataDeliveryEstimateMaximum, InvoiceShippingCostShippingRateDataDeliveryEstimateMaximumArgs

    Unit string
    A unit of time.
    Value double
    Must be greater than 0.
    Unit string
    A unit of time.
    Value float64
    Must be greater than 0.
    unit string
    A unit of time.
    value number
    Must be greater than 0.
    unit String
    A unit of time.
    value Double
    Must be greater than 0.
    unit string
    A unit of time.
    value number
    Must be greater than 0.
    unit str
    A unit of time.
    value float
    Must be greater than 0.
    unit String
    A unit of time.
    value Number
    Must be greater than 0.

    InvoiceShippingCostShippingRateDataDeliveryEstimateMinimum, InvoiceShippingCostShippingRateDataDeliveryEstimateMinimumArgs

    Unit string
    A unit of time.
    Value double
    Must be greater than 0.
    Unit string
    A unit of time.
    Value float64
    Must be greater than 0.
    unit string
    A unit of time.
    value number
    Must be greater than 0.
    unit String
    A unit of time.
    value Double
    Must be greater than 0.
    unit string
    A unit of time.
    value number
    Must be greater than 0.
    unit str
    A unit of time.
    value float
    Must be greater than 0.
    unit String
    A unit of time.
    value Number
    Must be greater than 0.

    InvoiceShippingCostShippingRateDataFixedAmount, InvoiceShippingCostShippingRateDataFixedAmountArgs

    Amount double
    A non-negative integer in cents representing how much to charge.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CurrencyOptions Dictionary<string, InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptions>
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    Amount float64
    A non-negative integer in cents representing how much to charge.
    Currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    CurrencyOptions map[string]InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptions
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    amount number
    A non-negative integer in cents representing how much to charge.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currency_options map(object)
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    amount Double
    A non-negative integer in cents representing how much to charge.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions Map<String,InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptions>
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    amount number
    A non-negative integer in cents representing how much to charge.
    currency string
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions {[key: string]: InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptions}
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    amount float
    A non-negative integer in cents representing how much to charge.
    currency str
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currency_options Mapping[str, InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptions]
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
    amount Number
    A non-negative integer in cents representing how much to charge.
    currency String
    Three-letter ISO currency code, in lowercase. Must be a supported currency.
    currencyOptions Map<Property Map>
    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

    InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptions, InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptionsArgs

    Amount double
    A non-negative integer in cents representing how much to charge.
    TaxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    Amount float64
    A non-negative integer in cents representing how much to charge.
    TaxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    amount number
    A non-negative integer in cents representing how much to charge.
    tax_behavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    amount Double
    A non-negative integer in cents representing how much to charge.
    taxBehavior String
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    amount number
    A non-negative integer in cents representing how much to charge.
    taxBehavior string
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    amount float
    A non-negative integer in cents representing how much to charge.
    tax_behavior str
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
    amount Number
    A non-negative integer in cents representing how much to charge.
    taxBehavior String
    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.

    InvoiceShippingCostTax, InvoiceShippingCostTaxArgs

    Amount double
    Amount of tax applied for this rate.
    Rate string
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    TaxabilityReason string
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    TaxableAmount double
    The amount on which tax is calculated, in cents (or local equivalent).
    Amount float64
    Amount of tax applied for this rate.
    Rate string
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    TaxabilityReason string
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    TaxableAmount float64
    The amount on which tax is calculated, in cents (or local equivalent).
    amount number
    Amount of tax applied for this rate.
    rate string
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    taxability_reason string
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    taxable_amount number
    The amount on which tax is calculated, in cents (or local equivalent).
    amount Double
    Amount of tax applied for this rate.
    rate String
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    taxabilityReason String
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    taxableAmount Double
    The amount on which tax is calculated, in cents (or local equivalent).
    amount number
    Amount of tax applied for this rate.
    rate string
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    taxabilityReason string
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    taxableAmount number
    The amount on which tax is calculated, in cents (or local equivalent).
    amount float
    Amount of tax applied for this rate.
    rate str
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    taxability_reason str
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    taxable_amount float
    The amount on which tax is calculated, in cents (or local equivalent).
    amount Number
    Amount of tax applied for this rate.
    rate String
    Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.
    taxabilityReason String
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    taxableAmount Number
    The amount on which tax is calculated, in cents (or local equivalent).

    InvoiceShippingDetails, InvoiceShippingDetailsArgs

    Address InvoiceShippingDetailsAddress
    Name string
    Recipient name.
    Carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    Phone string
    Recipient phone (including extension).
    TrackingNumber string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    Address InvoiceShippingDetailsAddress
    Name string
    Recipient name.
    Carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    Phone string
    Recipient phone (including extension).
    TrackingNumber string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address object
    name string
    Recipient name.
    carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    phone string
    Recipient phone (including extension).
    tracking_number string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address InvoiceShippingDetailsAddress
    name String
    Recipient name.
    carrier String
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    phone String
    Recipient phone (including extension).
    trackingNumber String
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address InvoiceShippingDetailsAddress
    name string
    Recipient name.
    carrier string
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    phone string
    Recipient phone (including extension).
    trackingNumber string
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address InvoiceShippingDetailsAddress
    name str
    Recipient name.
    carrier str
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    phone str
    Recipient phone (including extension).
    tracking_number str
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
    address Property Map
    name String
    Recipient name.
    carrier String
    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
    phone String
    Recipient phone (including extension).
    trackingNumber String
    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

    InvoiceShippingDetailsAddress, InvoiceShippingDetailsAddressArgs

    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    City string
    City, district, suburb, town, or village.
    Country string
    Two-letter country code (ISO 3166-1 alpha-2).
    Line1 string
    Address line 1, such as the street, PO Box, or company name.
    Line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    PostalCode string
    ZIP or postal code.
    State string
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).
    city string
    City, district, suburb, town, or village.
    country string
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 string
    Address line 1, such as the street, PO Box, or company name.
    line2 string
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode string
    ZIP or postal code.
    state string
    State, county, province, or region (ISO 3166-2).
    city str
    City, district, suburb, town, or village.
    country str
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 str
    Address line 1, such as the street, PO Box, or company name.
    line2 str
    Address line 2, such as the apartment, suite, unit, or building.
    postal_code str
    ZIP or postal code.
    state str
    State, county, province, or region (ISO 3166-2).
    city String
    City, district, suburb, town, or village.
    country String
    Two-letter country code (ISO 3166-1 alpha-2).
    line1 String
    Address line 1, such as the street, PO Box, or company name.
    line2 String
    Address line 2, such as the apartment, suite, unit, or building.
    postalCode String
    ZIP or postal code.
    state String
    State, county, province, or region (ISO 3166-2).

    InvoiceStatusTransitions, InvoiceStatusTransitionsArgs

    FinalizedAt double
    The time that the invoice draft was finalized.
    MarkedUncollectibleAt double
    The time that the invoice was marked uncollectible.
    PaidAt double
    The time that the invoice was paid.
    VoidedAt double
    The time that the invoice was voided.
    FinalizedAt float64
    The time that the invoice draft was finalized.
    MarkedUncollectibleAt float64
    The time that the invoice was marked uncollectible.
    PaidAt float64
    The time that the invoice was paid.
    VoidedAt float64
    The time that the invoice was voided.
    finalized_at number
    The time that the invoice draft was finalized.
    marked_uncollectible_at number
    The time that the invoice was marked uncollectible.
    number
    The time that the invoice was paid.
    voided_at number
    The time that the invoice was voided.
    finalizedAt Double
    The time that the invoice draft was finalized.
    markedUncollectibleAt Double
    The time that the invoice was marked uncollectible.
    paidAt Double
    The time that the invoice was paid.
    voidedAt Double
    The time that the invoice was voided.
    finalizedAt number
    The time that the invoice draft was finalized.
    markedUncollectibleAt number
    The time that the invoice was marked uncollectible.
    paidAt number
    The time that the invoice was paid.
    voidedAt number
    The time that the invoice was voided.
    finalized_at float
    The time that the invoice draft was finalized.
    marked_uncollectible_at float
    The time that the invoice was marked uncollectible.
    float
    The time that the invoice was paid.
    voided_at float
    The time that the invoice was voided.
    finalizedAt Number
    The time that the invoice draft was finalized.
    markedUncollectibleAt Number
    The time that the invoice was marked uncollectible.
    paidAt Number
    The time that the invoice was paid.
    voidedAt Number
    The time that the invoice was voided.

    InvoiceThresholdReason, InvoiceThresholdReasonArgs

    AmountGte double
    The total invoice amount threshold boundary if it triggered the threshold invoice.
    ItemReasons List<InvoiceThresholdReasonItemReason>
    Indicates which line items triggered a threshold invoice.
    AmountGte float64
    The total invoice amount threshold boundary if it triggered the threshold invoice.
    ItemReasons []InvoiceThresholdReasonItemReason
    Indicates which line items triggered a threshold invoice.
    amount_gte number
    The total invoice amount threshold boundary if it triggered the threshold invoice.
    item_reasons list(object)
    Indicates which line items triggered a threshold invoice.
    amountGte Double
    The total invoice amount threshold boundary if it triggered the threshold invoice.
    itemReasons List<InvoiceThresholdReasonItemReason>
    Indicates which line items triggered a threshold invoice.
    amountGte number
    The total invoice amount threshold boundary if it triggered the threshold invoice.
    itemReasons InvoiceThresholdReasonItemReason[]
    Indicates which line items triggered a threshold invoice.
    amount_gte float
    The total invoice amount threshold boundary if it triggered the threshold invoice.
    item_reasons Sequence[InvoiceThresholdReasonItemReason]
    Indicates which line items triggered a threshold invoice.
    amountGte Number
    The total invoice amount threshold boundary if it triggered the threshold invoice.
    itemReasons List<Property Map>
    Indicates which line items triggered a threshold invoice.

    InvoiceThresholdReasonItemReason, InvoiceThresholdReasonItemReasonArgs

    LineItemIds List<string>
    The IDs of the line items that triggered the threshold invoice.
    UsageGte double
    The quantity threshold boundary that applied to the given line item.
    LineItemIds []string
    The IDs of the line items that triggered the threshold invoice.
    UsageGte float64
    The quantity threshold boundary that applied to the given line item.
    line_item_ids list(string)
    The IDs of the line items that triggered the threshold invoice.
    usage_gte number
    The quantity threshold boundary that applied to the given line item.
    lineItemIds List<String>
    The IDs of the line items that triggered the threshold invoice.
    usageGte Double
    The quantity threshold boundary that applied to the given line item.
    lineItemIds string[]
    The IDs of the line items that triggered the threshold invoice.
    usageGte number
    The quantity threshold boundary that applied to the given line item.
    line_item_ids Sequence[str]
    The IDs of the line items that triggered the threshold invoice.
    usage_gte float
    The quantity threshold boundary that applied to the given line item.
    lineItemIds List<String>
    The IDs of the line items that triggered the threshold invoice.
    usageGte Number
    The quantity threshold boundary that applied to the given line item.

    InvoiceTotalDiscountAmount, InvoiceTotalDiscountAmountArgs

    Amount double
    The amount, in cents (or local equivalent), of the discount.
    Discount string
    The discount that was applied to get this discount amount.
    Amount float64
    The amount, in cents (or local equivalent), of the discount.
    Discount string
    The discount that was applied to get this discount amount.
    amount number
    The amount, in cents (or local equivalent), of the discount.
    discount string
    The discount that was applied to get this discount amount.
    amount Double
    The amount, in cents (or local equivalent), of the discount.
    discount String
    The discount that was applied to get this discount amount.
    amount number
    The amount, in cents (or local equivalent), of the discount.
    discount string
    The discount that was applied to get this discount amount.
    amount float
    The amount, in cents (or local equivalent), of the discount.
    discount str
    The discount that was applied to get this discount amount.
    amount Number
    The amount, in cents (or local equivalent), of the discount.
    discount String
    The discount that was applied to get this discount amount.

    InvoiceTotalPretaxCreditAmount, InvoiceTotalPretaxCreditAmountArgs

    Amount double
    The amount, in cents (or local equivalent), of the pretax credit amount.
    CreditBalanceTransaction string
    The credit balance transaction that was applied to get this pretax credit amount.
    Discount string
    The discount that was applied to get this pretax credit amount.
    Type string
    Type of the pretax credit amount referenced.
    Amount float64
    The amount, in cents (or local equivalent), of the pretax credit amount.
    CreditBalanceTransaction string
    The credit balance transaction that was applied to get this pretax credit amount.
    Discount string
    The discount that was applied to get this pretax credit amount.
    Type string
    Type of the pretax credit amount referenced.
    amount number
    The amount, in cents (or local equivalent), of the pretax credit amount.
    credit_balance_transaction string
    The credit balance transaction that was applied to get this pretax credit amount.
    discount string
    The discount that was applied to get this pretax credit amount.
    type string
    Type of the pretax credit amount referenced.
    amount Double
    The amount, in cents (or local equivalent), of the pretax credit amount.
    creditBalanceTransaction String
    The credit balance transaction that was applied to get this pretax credit amount.
    discount String
    The discount that was applied to get this pretax credit amount.
    type String
    Type of the pretax credit amount referenced.
    amount number
    The amount, in cents (or local equivalent), of the pretax credit amount.
    creditBalanceTransaction string
    The credit balance transaction that was applied to get this pretax credit amount.
    discount string
    The discount that was applied to get this pretax credit amount.
    type string
    Type of the pretax credit amount referenced.
    amount float
    The amount, in cents (or local equivalent), of the pretax credit amount.
    credit_balance_transaction str
    The credit balance transaction that was applied to get this pretax credit amount.
    discount str
    The discount that was applied to get this pretax credit amount.
    type str
    Type of the pretax credit amount referenced.
    amount Number
    The amount, in cents (or local equivalent), of the pretax credit amount.
    creditBalanceTransaction String
    The credit balance transaction that was applied to get this pretax credit amount.
    discount String
    The discount that was applied to get this pretax credit amount.
    type String
    Type of the pretax credit amount referenced.

    InvoiceTotalTax, InvoiceTotalTaxArgs

    Amount double
    The amount of the tax, in cents (or local equivalent).
    TaxBehavior string
    Whether this tax is inclusive or exclusive.
    TaxRateDetails InvoiceTotalTaxTaxRateDetails
    Additional details about the tax rate. Only present when type is tax_rate_details.
    TaxabilityReason string
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    TaxableAmount double
    The amount on which tax is calculated, in cents (or local equivalent).
    Type string
    The type of tax information.
    Amount float64
    The amount of the tax, in cents (or local equivalent).
    TaxBehavior string
    Whether this tax is inclusive or exclusive.
    TaxRateDetails InvoiceTotalTaxTaxRateDetails
    Additional details about the tax rate. Only present when type is tax_rate_details.
    TaxabilityReason string
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    TaxableAmount float64
    The amount on which tax is calculated, in cents (or local equivalent).
    Type string
    The type of tax information.
    amount number
    The amount of the tax, in cents (or local equivalent).
    tax_behavior string
    Whether this tax is inclusive or exclusive.
    tax_rate_details object
    Additional details about the tax rate. Only present when type is tax_rate_details.
    taxability_reason string
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    taxable_amount number
    The amount on which tax is calculated, in cents (or local equivalent).
    type string
    The type of tax information.
    amount Double
    The amount of the tax, in cents (or local equivalent).
    taxBehavior String
    Whether this tax is inclusive or exclusive.
    taxRateDetails InvoiceTotalTaxTaxRateDetails
    Additional details about the tax rate. Only present when type is tax_rate_details.
    taxabilityReason String
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    taxableAmount Double
    The amount on which tax is calculated, in cents (or local equivalent).
    type String
    The type of tax information.
    amount number
    The amount of the tax, in cents (or local equivalent).
    taxBehavior string
    Whether this tax is inclusive or exclusive.
    taxRateDetails InvoiceTotalTaxTaxRateDetails
    Additional details about the tax rate. Only present when type is tax_rate_details.
    taxabilityReason string
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    taxableAmount number
    The amount on which tax is calculated, in cents (or local equivalent).
    type string
    The type of tax information.
    amount float
    The amount of the tax, in cents (or local equivalent).
    tax_behavior str
    Whether this tax is inclusive or exclusive.
    tax_rate_details InvoiceTotalTaxTaxRateDetails
    Additional details about the tax rate. Only present when type is tax_rate_details.
    taxability_reason str
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    taxable_amount float
    The amount on which tax is calculated, in cents (or local equivalent).
    type str
    The type of tax information.
    amount Number
    The amount of the tax, in cents (or local equivalent).
    taxBehavior String
    Whether this tax is inclusive or exclusive.
    taxRateDetails Property Map
    Additional details about the tax rate. Only present when type is tax_rate_details.
    taxabilityReason String
    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
    taxableAmount Number
    The amount on which tax is calculated, in cents (or local equivalent).
    type String
    The type of tax information.

    InvoiceTotalTaxTaxRateDetails, InvoiceTotalTaxTaxRateDetailsArgs

    TaxRate string
    ID of the tax rate
    TaxRate string
    ID of the tax rate
    tax_rate string
    ID of the tax rate
    taxRate String
    ID of the tax rate
    taxRate string
    ID of the tax rate
    tax_rate str
    ID of the tax rate
    taxRate String
    ID of the tax rate

    InvoiceTransferData, InvoiceTransferDataArgs

    Destination string
    ID of an existing, connected Stripe account.
    Amount double
    The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
    Destination string
    ID of an existing, connected Stripe account.
    Amount float64
    The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
    destination string
    ID of an existing, connected Stripe account.
    amount number
    The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
    destination String
    ID of an existing, connected Stripe account.
    amount Double
    The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
    destination string
    ID of an existing, connected Stripe account.
    amount number
    The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
    destination str
    ID of an existing, connected Stripe account.
    amount float
    The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
    destination String
    ID of an existing, connected Stripe account.
    amount Number
    The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.

    Package Details

    Repository
    stripe stripe/terraform-provider-stripe
    License
    Notes
    This Pulumi package is based on the stripe Terraform Provider.
    Viewing docs for Stripe 0.3.0
    published on Friday, Aug 14, 2026 by Pulumi
    Schema (JSON)
    stripe/terraform-provider-stripe

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial