stripe / stripe-go / 11296113556

//

//

// File generated from our OpenAPI spec

//

//

package stripe

import (

        "encoding/json"

        "github.com/stripe/stripe-go/v80/form"

)

// The status of the payment, one of `open`, `paid`, or `past_due`

type InvoiceAmountsDueStatus string

// List of values that InvoiceAmountsDueStatus can take

const (

        InvoiceAmountsDueStatusOpen    InvoiceAmountsDueStatus = "open"

        InvoiceAmountsDueStatusPaid    InvoiceAmountsDueStatus = "paid"

        InvoiceAmountsDueStatusPastDue InvoiceAmountsDueStatus = "past_due"

)

// Type of the account referenced.

type InvoiceAutomaticTaxLiabilityType string

// List of values that InvoiceAutomaticTaxLiabilityType can take

const (

        InvoiceAutomaticTaxLiabilityTypeAccount InvoiceAutomaticTaxLiabilityType = "account"

        InvoiceAutomaticTaxLiabilityTypeSelf    InvoiceAutomaticTaxLiabilityType = "self"

)

// The status of the most recent automated tax calculation for this invoice.

type InvoiceAutomaticTaxStatus string

// List of values that InvoiceAutomaticTaxStatus can take

const (

        InvoiceAutomaticTaxStatusComplete               InvoiceAutomaticTaxStatus = "complete"

        InvoiceAutomaticTaxStatusFailed                 InvoiceAutomaticTaxStatus = "failed"

        InvoiceAutomaticTaxStatusRequiresLocationInputs InvoiceAutomaticTaxStatus = "requires_location_inputs"

)

// 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 simulated invoices, per the upcoming invoice endpoint.

type InvoiceBillingReason string

// List of values that InvoiceBillingReason can take

const (

        InvoiceBillingReasonAutomaticPendingInvoiceItemInvoice InvoiceBillingReason = "automatic_pending_invoice_item_invoice"

        InvoiceBillingReasonManual                             InvoiceBillingReason = "manual"

        InvoiceBillingReasonQuoteAccept                        InvoiceBillingReason = "quote_accept"

        InvoiceBillingReasonSubscription                       InvoiceBillingReason = "subscription"

        InvoiceBillingReasonSubscriptionCreate                 InvoiceBillingReason = "subscription_create"

        InvoiceBillingReasonSubscriptionCycle                  InvoiceBillingReason = "subscription_cycle"

        InvoiceBillingReasonSubscriptionThreshold              InvoiceBillingReason = "subscription_threshold"

        InvoiceBillingReasonSubscriptionUpdate                 InvoiceBillingReason = "subscription_update"

        InvoiceBillingReasonUpcoming                           InvoiceBillingReason = "upcoming"

)

// 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.

type InvoiceCollectionMethod string

// List of values that InvoiceCollectionMethod can take

const (

        InvoiceCollectionMethodChargeAutomatically InvoiceCollectionMethod = "charge_automatically"

        InvoiceCollectionMethodSendInvoice         InvoiceCollectionMethod = "send_invoice"

)

// Type of the account referenced.

type InvoiceIssuerType string

// List of values that InvoiceIssuerType can take

const (

        InvoiceIssuerTypeAccount InvoiceIssuerType = "account"

        InvoiceIssuerTypeSelf    InvoiceIssuerType = "self"

)

// Transaction type of the mandate.

type InvoicePaymentSettingsPaymentMethodOptionsACSSDebitMandateOptionsTransactionType string

// List of values that InvoicePaymentSettingsPaymentMethodOptionsACSSDebitMandateOptionsTransactionType can take

const (

        InvoicePaymentSettingsPaymentMethodOptionsACSSDebitMandateOptionsTransactionTypeBusiness InvoicePaymentSettingsPaymentMethodOptionsACSSDebitMandateOptionsTransactionType = "business"

        InvoicePaymentSettingsPaymentMethodOptionsACSSDebitMandateOptionsTransactionTypePersonal InvoicePaymentSettingsPaymentMethodOptionsACSSDebitMandateOptionsTransactionType = "personal"

)

// Bank account verification method.

type InvoicePaymentSettingsPaymentMethodOptionsACSSDebitVerificationMethod string

// List of values that InvoicePaymentSettingsPaymentMethodOptionsACSSDebitVerificationMethod can take

const (

        InvoicePaymentSettingsPaymentMethodOptionsACSSDebitVerificationMethodAutomatic     InvoicePaymentSettingsPaymentMethodOptionsACSSDebitVerificationMethod = "automatic"

        InvoicePaymentSettingsPaymentMethodOptionsACSSDebitVerificationMethodInstant       InvoicePaymentSettingsPaymentMethodOptionsACSSDebitVerificationMethod = "instant"

        InvoicePaymentSettingsPaymentMethodOptionsACSSDebitVerificationMethodMicrodeposits InvoicePaymentSettingsPaymentMethodOptionsACSSDebitVerificationMethod = "microdeposits"

)

// We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). 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](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.

type InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure string

// List of values that InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure can take

const (

        InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecureAny       InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure = "any"

        InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecureAutomatic InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure = "automatic"

        InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecureChallenge InvoicePaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure = "challenge"

)

// The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.

type InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceFundingType string

// List of values that InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceFundingType can take

const (

        InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceFundingTypeBankTransfer InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceFundingType = "bank_transfer"

)

// The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.

type InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategory string

// List of values that InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategory can take

const (

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategoryChecking InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategory = "checking"

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategorySavings  InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersAccountSubcategory = "savings"

)

// The list of permissions to request. The `payment_method` permission must be included.

type InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission string

// List of values that InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission can take

const (

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionBalances      InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission = "balances"

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionOwnership     InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission = "ownership"

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionPaymentMethod InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission = "payment_method"

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermissionTransactions  InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPermission = "transactions"

)

// Data features requested to be retrieved upon account creation.

type InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch string

// List of values that InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch can take

const (

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetchBalances         InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch = "balances"

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetchInferredBalances InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch = "inferred_balances"

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetchOwnership        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch = "ownership"

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetchTransactions     InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsPrefetch = "transactions"

)

// Bank account verification method.

type InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountVerificationMethod string

// List of values that InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountVerificationMethod can take

const (

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountVerificationMethodAutomatic     InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountVerificationMethod = "automatic"

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountVerificationMethodInstant       InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountVerificationMethod = "instant"

        InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountVerificationMethodMicrodeposits InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountVerificationMethod = "microdeposits"

)

// 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](https://dashboard.stripe.com/settings/billing/invoice).

type InvoicePaymentSettingsPaymentMethodType string

// List of values that InvoicePaymentSettingsPaymentMethodType can take

const (

        InvoicePaymentSettingsPaymentMethodTypeACHCreditTransfer  InvoicePaymentSettingsPaymentMethodType = "ach_credit_transfer"

        InvoicePaymentSettingsPaymentMethodTypeACHDebit           InvoicePaymentSettingsPaymentMethodType = "ach_debit"

        InvoicePaymentSettingsPaymentMethodTypeACSSDebit          InvoicePaymentSettingsPaymentMethodType = "acss_debit"

        InvoicePaymentSettingsPaymentMethodTypeAmazonPay          InvoicePaymentSettingsPaymentMethodType = "amazon_pay"

        InvoicePaymentSettingsPaymentMethodTypeAUBECSDebit        InvoicePaymentSettingsPaymentMethodType = "au_becs_debit"

        InvoicePaymentSettingsPaymentMethodTypeBACSDebit          InvoicePaymentSettingsPaymentMethodType = "bacs_debit"

        InvoicePaymentSettingsPaymentMethodTypeBancontact         InvoicePaymentSettingsPaymentMethodType = "bancontact"

        InvoicePaymentSettingsPaymentMethodTypeBoleto             InvoicePaymentSettingsPaymentMethodType = "boleto"

        InvoicePaymentSettingsPaymentMethodTypeCard               InvoicePaymentSettingsPaymentMethodType = "card"

        InvoicePaymentSettingsPaymentMethodTypeCashApp            InvoicePaymentSettingsPaymentMethodType = "cashapp"

        InvoicePaymentSettingsPaymentMethodTypeCustomerBalance    InvoicePaymentSettingsPaymentMethodType = "customer_balance"

        InvoicePaymentSettingsPaymentMethodTypeEPS                InvoicePaymentSettingsPaymentMethodType = "eps"

        InvoicePaymentSettingsPaymentMethodTypeFPX                InvoicePaymentSettingsPaymentMethodType = "fpx"

        InvoicePaymentSettingsPaymentMethodTypeGiropay            InvoicePaymentSettingsPaymentMethodType = "giropay"

        InvoicePaymentSettingsPaymentMethodTypeGrabpay            InvoicePaymentSettingsPaymentMethodType = "grabpay"

        InvoicePaymentSettingsPaymentMethodTypeIDEAL              InvoicePaymentSettingsPaymentMethodType = "ideal"

        InvoicePaymentSettingsPaymentMethodTypeKonbini            InvoicePaymentSettingsPaymentMethodType = "konbini"

        InvoicePaymentSettingsPaymentMethodTypeLink               InvoicePaymentSettingsPaymentMethodType = "link"

        InvoicePaymentSettingsPaymentMethodTypeMultibanco         InvoicePaymentSettingsPaymentMethodType = "multibanco"

        InvoicePaymentSettingsPaymentMethodTypeP24                InvoicePaymentSettingsPaymentMethodType = "p24"

        InvoicePaymentSettingsPaymentMethodTypePayNow             InvoicePaymentSettingsPaymentMethodType = "paynow"

        InvoicePaymentSettingsPaymentMethodTypePaypal             InvoicePaymentSettingsPaymentMethodType = "paypal"

        InvoicePaymentSettingsPaymentMethodTypePromptPay          InvoicePaymentSettingsPaymentMethodType = "promptpay"

        InvoicePaymentSettingsPaymentMethodTypeRevolutPay         InvoicePaymentSettingsPaymentMethodType = "revolut_pay"

        InvoicePaymentSettingsPaymentMethodTypeSEPACreditTransfer InvoicePaymentSettingsPaymentMethodType = "sepa_credit_transfer"

        InvoicePaymentSettingsPaymentMethodTypeSEPADebit          InvoicePaymentSettingsPaymentMethodType = "sepa_debit"

        InvoicePaymentSettingsPaymentMethodTypeSofort             InvoicePaymentSettingsPaymentMethodType = "sofort"

        InvoicePaymentSettingsPaymentMethodTypeSwish              InvoicePaymentSettingsPaymentMethodType = "swish"

        InvoicePaymentSettingsPaymentMethodTypeUSBankAccount      InvoicePaymentSettingsPaymentMethodType = "us_bank_account"

        InvoicePaymentSettingsPaymentMethodTypeWeChatPay          InvoicePaymentSettingsPaymentMethodType = "wechat_pay"

)

// 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.

type InvoiceRenderingPDFPageSize string

// List of values that InvoiceRenderingPDFPageSize can take

const (

        InvoiceRenderingPDFPageSizeA4     InvoiceRenderingPDFPageSize = "a4"

        InvoiceRenderingPDFPageSizeAuto   InvoiceRenderingPDFPageSize = "auto"

        InvoiceRenderingPDFPageSizeLetter InvoiceRenderingPDFPageSize = "letter"

)

// 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.

type InvoiceShippingCostTaxTaxabilityReason string

// List of values that InvoiceShippingCostTaxTaxabilityReason can take

const (

        InvoiceShippingCostTaxTaxabilityReasonCustomerExempt       InvoiceShippingCostTaxTaxabilityReason = "customer_exempt"

        InvoiceShippingCostTaxTaxabilityReasonNotCollecting        InvoiceShippingCostTaxTaxabilityReason = "not_collecting"

        InvoiceShippingCostTaxTaxabilityReasonNotSubjectToTax      InvoiceShippingCostTaxTaxabilityReason = "not_subject_to_tax"

        InvoiceShippingCostTaxTaxabilityReasonNotSupported         InvoiceShippingCostTaxTaxabilityReason = "not_supported"

        InvoiceShippingCostTaxTaxabilityReasonPortionProductExempt InvoiceShippingCostTaxTaxabilityReason = "portion_product_exempt"

        InvoiceShippingCostTaxTaxabilityReasonPortionReducedRated  InvoiceShippingCostTaxTaxabilityReason = "portion_reduced_rated"

        InvoiceShippingCostTaxTaxabilityReasonPortionStandardRated InvoiceShippingCostTaxTaxabilityReason = "portion_standard_rated"

        InvoiceShippingCostTaxTaxabilityReasonProductExempt        InvoiceShippingCostTaxTaxabilityReason = "product_exempt"

        InvoiceShippingCostTaxTaxabilityReasonProductExemptHoliday InvoiceShippingCostTaxTaxabilityReason = "product_exempt_holiday"

        InvoiceShippingCostTaxTaxabilityReasonProportionallyRated  InvoiceShippingCostTaxTaxabilityReason = "proportionally_rated"

        InvoiceShippingCostTaxTaxabilityReasonReducedRated         InvoiceShippingCostTaxTaxabilityReason = "reduced_rated"

        InvoiceShippingCostTaxTaxabilityReasonReverseCharge        InvoiceShippingCostTaxTaxabilityReason = "reverse_charge"

        InvoiceShippingCostTaxTaxabilityReasonStandardRated        InvoiceShippingCostTaxTaxabilityReason = "standard_rated"

        InvoiceShippingCostTaxTaxabilityReasonTaxableBasisReduced  InvoiceShippingCostTaxTaxabilityReason = "taxable_basis_reduced"

        InvoiceShippingCostTaxTaxabilityReasonZeroRated            InvoiceShippingCostTaxTaxabilityReason = "zero_rated"

)

// The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)

type InvoiceStatus string

// List of values that InvoiceStatus can take

const (

        InvoiceStatusDraft         InvoiceStatus = "draft"

        InvoiceStatusOpen          InvoiceStatus = "open"

        InvoiceStatusPaid          InvoiceStatus = "paid"

        InvoiceStatusUncollectible InvoiceStatus = "uncollectible"

        InvoiceStatusVoid          InvoiceStatus = "void"

)

// The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.

type InvoiceSubscriptionDetailsPauseCollectionBehavior string

// List of values that InvoiceSubscriptionDetailsPauseCollectionBehavior can take

const (

        InvoiceSubscriptionDetailsPauseCollectionBehaviorKeepAsDraft       InvoiceSubscriptionDetailsPauseCollectionBehavior = "keep_as_draft"

        InvoiceSubscriptionDetailsPauseCollectionBehaviorMarkUncollectible InvoiceSubscriptionDetailsPauseCollectionBehavior = "mark_uncollectible"

        InvoiceSubscriptionDetailsPauseCollectionBehaviorVoid              InvoiceSubscriptionDetailsPauseCollectionBehavior = "void"

)

// Type of the pretax credit amount referenced.

type InvoiceTotalPretaxCreditAmountType string

// List of values that InvoiceTotalPretaxCreditAmountType can take

const (

        InvoiceTotalPretaxCreditAmountTypeCreditBalanceTransaction InvoiceTotalPretaxCreditAmountType = "credit_balance_transaction"

        InvoiceTotalPretaxCreditAmountTypeDiscount                 InvoiceTotalPretaxCreditAmountType = "discount"

        InvoiceTotalPretaxCreditAmountTypeMargin                   InvoiceTotalPretaxCreditAmountType = "margin"

)

// 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.

type InvoiceTotalTaxAmountTaxabilityReason string

// List of values that InvoiceTotalTaxAmountTaxabilityReason can take

const (

        InvoiceTotalTaxAmountTaxabilityReasonCustomerExempt       InvoiceTotalTaxAmountTaxabilityReason = "customer_exempt"

        InvoiceTotalTaxAmountTaxabilityReasonNotCollecting        InvoiceTotalTaxAmountTaxabilityReason = "not_collecting"

        InvoiceTotalTaxAmountTaxabilityReasonNotSubjectToTax      InvoiceTotalTaxAmountTaxabilityReason = "not_subject_to_tax"

        InvoiceTotalTaxAmountTaxabilityReasonNotSupported         InvoiceTotalTaxAmountTaxabilityReason = "not_supported"

        InvoiceTotalTaxAmountTaxabilityReasonPortionProductExempt InvoiceTotalTaxAmountTaxabilityReason = "portion_product_exempt"

        InvoiceTotalTaxAmountTaxabilityReasonPortionReducedRated  InvoiceTotalTaxAmountTaxabilityReason = "portion_reduced_rated"

        InvoiceTotalTaxAmountTaxabilityReasonPortionStandardRated InvoiceTotalTaxAmountTaxabilityReason = "portion_standard_rated"

        InvoiceTotalTaxAmountTaxabilityReasonProductExempt        InvoiceTotalTaxAmountTaxabilityReason = "product_exempt"

        InvoiceTotalTaxAmountTaxabilityReasonProductExemptHoliday InvoiceTotalTaxAmountTaxabilityReason = "product_exempt_holiday"

        InvoiceTotalTaxAmountTaxabilityReasonProportionallyRated  InvoiceTotalTaxAmountTaxabilityReason = "proportionally_rated"

        InvoiceTotalTaxAmountTaxabilityReasonReducedRated         InvoiceTotalTaxAmountTaxabilityReason = "reduced_rated"

        InvoiceTotalTaxAmountTaxabilityReasonReverseCharge        InvoiceTotalTaxAmountTaxabilityReason = "reverse_charge"

        InvoiceTotalTaxAmountTaxabilityReasonStandardRated        InvoiceTotalTaxAmountTaxabilityReason = "standard_rated"

        InvoiceTotalTaxAmountTaxabilityReasonTaxableBasisReduced  InvoiceTotalTaxAmountTaxabilityReason = "taxable_basis_reduced"

        InvoiceTotalTaxAmountTaxabilityReasonZeroRated            InvoiceTotalTaxAmountTaxabilityReason = "zero_rated"

)

// Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice).

type InvoiceParams struct {

        Params `form:"*"`

        // The account tax IDs associated with the invoice. Only editable when the invoice is a draft.

        AccountTaxIDs []*string `form:"account_tax_ids"`

        // List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.

        AmountsDue []*InvoiceAmountsDueParams `form:"amounts_due"`

        // 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](https://stripe.com/docs/billing/invoices/connect#collecting-fees).

        ApplicationFeeAmount *int64 `form:"application_fee_amount"`

        // Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.

        AutoAdvance *bool `form:"auto_advance"`

        // Settings for automatic tax lookup for this invoice.

        AutomaticTax *InvoiceAutomaticTaxParams `form:"automatic_tax"`

        // 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. Defaults to `charge_automatically`.

        CollectionMethod *string `form:"collection_method"`

        // The currency to create this invoice in. Defaults to that of `customer` if not specified.

        Currency *string `form:"currency"`

        // The ID of the customer who will be billed.

        Customer *string `form:"customer"`

        // A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.

        CustomFields []*InvoiceCustomFieldParams `form:"custom_fields"`

        // The number of days from which the invoice is created until it is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.

        DaysUntilDue *int64 `form:"days_until_due"`

        // The ids of the margins to apply to the invoice. Can be overridden by line item `margins`.

        DefaultMargins []*string `form:"default_margins"`

        // 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.

        DefaultPaymentMethod *string `form:"default_payment_method"`

        // 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.

        DefaultSource *string `form:"default_source"`

        // The tax rates that will apply to any line item that does not have `tax_rates` set. Pass an empty string to remove previously-defined tax rates.

        DefaultTaxRates []*string `form:"default_tax_rates"`

        // An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.

        Description *string `form:"description"`

        // The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts.

        Discounts []*InvoiceDiscountParams `form:"discounts"`

        // The date on which payment for this invoice is due. Only valid for invoices where `collection_method=send_invoice`. This field can only be updated on `draft` invoices.

        DueDate *int64 `form:"due_date"`

        // 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.

        EffectiveAt *int64 `form:"effective_at"`

        // Specifies which fields in the response should be expanded.

        Expand []*string `form:"expand"`

        // Footer to be displayed on the invoice.

        Footer *string `form:"footer"`

        // Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.

        FromInvoice *InvoiceFromInvoiceParams `form:"from_invoice"`

        // The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

        Issuer *InvoiceIssuerParams `form:"issuer"`

        // Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.

        Metadata map[string]string `form:"metadata"`

        // Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically.

        Number *string `form:"number"`

        // 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](https://stripe.com/docs/billing/invoices/connect) documentation for details.

        OnBehalfOf *string `form:"on_behalf_of"`

        // Configuration settings for the PaymentIntent that is generated when the invoice is finalized.

        PaymentSettings *InvoicePaymentSettingsParams `form:"payment_settings"`

        // How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.

        PendingInvoiceItemsBehavior *string `form:"pending_invoice_items_behavior"`

        // The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.

        Rendering *InvoiceRenderingParams `form:"rendering"`

        // Settings for the cost of shipping for this invoice.

        ShippingCost *InvoiceShippingCostParams `form:"shipping_cost"`

        // 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.

        ShippingDetails *InvoiceShippingDetailsParams `form:"shipping_details"`

        // Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.

        StatementDescriptor *string `form:"statement_descriptor"`

        // The ID of the subscription to invoice, if any. If set, the created invoice will only include pending invoice items for that subscription. The subscription's billing cycle and regular subscription events won't be affected.

        Subscription *string `form:"subscription"`

        // 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. This will be unset if you POST an empty value.

        TransferData *InvoiceTransferDataParams `form:"transfer_data"`

}

// AddExpand appends a new field to expand.

// AddMetadata adds a new key-value pair to the Metadata.

}

// List of expected payments and corresponding due dates. Valid only for invoices where `collection_method=send_invoice`.

type InvoiceAmountsDueParams struct {

        // The amount in cents (or local equivalent).

        Amount *int64 `form:"amount"`

        // Number of days from when invoice is finalized until the payment is due.

        DaysUntilDue *int64 `form:"days_until_due"`

        // An arbitrary string attached to the object. Often useful for displaying to users.

        Description *string `form:"description"`

        // Date on which a payment plan's payment is due.

        DueDate *int64 `form:"due_date"`

}

// 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.

type InvoiceAutomaticTaxLiabilityParams struct {

        // The connected account being referenced when `type` is `account`.

        Account *string `form:"account"`

        // Type of the account referenced in the request.

        Type *string `form:"type"`

}

// Settings for automatic tax lookup for this invoice.

type InvoiceAutomaticTaxParams struct {

        // Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.

        Enabled *bool `form:"enabled"`

        // 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.

        Liability *InvoiceAutomaticTaxLiabilityParams `form:"liability"`

}

// A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.

type InvoiceCustomFieldParams struct {

        // The name of the custom field. This may be up to 40 characters.

        Name *string `form:"name"`

        // The value of the custom field. This may be up to 140 characters.

        Value *string `form:"value"`

}

// Time span for the redeemed discount.

type InvoiceDiscountDiscountEndDurationParams struct {

        // Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.

        Interval *string `form:"interval"`

        // The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.

        IntervalCount *int64 `form:"interval_count"`

}

// Details to determine how long the discount should be applied for.

type InvoiceDiscountDiscountEndParams struct {

        // Time span for the redeemed discount.

        Duration *InvoiceDiscountDiscountEndDurationParams `form:"duration"`

        // A precise Unix timestamp for the discount to end. Must be in the future.

        Timestamp *int64 `form:"timestamp"`

        // The type of calculation made to determine when the discount ends.

        Type *string `form:"type"`

}

// The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.

type InvoiceDiscountParams struct {

        // ID of the coupon to create a new discount for.

        Coupon *string `form:"coupon"`

        // ID of an existing discount on the object (or one of its ancestors) to reuse.

        Discount *string `form:"discount"`

        // Details to determine how long the discount should be applied for.

        DiscountEnd *InvoiceDiscountDiscountEndParams `form:"discount_end"`

        // ID of the promotion code to create a new discount for.

        PromotionCode *string `form:"promotion_code"`

}

// The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

type InvoiceIssuerParams struct {

        // The connected account being referenced when `type` is `account`.

        Account *string `form:"account"`

        // Type of the account referenced in the request.

        Type *string `form:"type"`

}

// Additional fields for Mandate creation

type InvoicePaymentSettingsPaymentMethodOptionsACSSDebitMandateOptionsParams struct {

        // Transaction type of the mandate.

        TransactionType *string `form:"transaction_type"`

}

// 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.

type InvoicePaymentSettingsPaymentMethodOptionsACSSDebitParams struct {

        // Additional fields for Mandate creation

        MandateOptions *InvoicePaymentSettingsPaymentMethodOptionsACSSDebitMandateOptionsParams `form:"mandate_options"`

        // Verification method for the intent

        VerificationMethod *string `form:"verification_method"`

}

// If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.

type InvoicePaymentSettingsPaymentMethodOptionsBancontactParams struct {

        // Preferred language of the Bancontact authorization page that the customer is redirected to.

        PreferredLanguage *string `form:"preferred_language"`

}

// The selected installment plan to use for this invoice.

type InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlanParams struct {

        // For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.

        Count *int64 `form:"count"`

        // 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`.

        Interval *string `form:"interval"`

        // Type of installment plan, one of `fixed_count`.

        Type *string `form:"type"`

}

// Installment configuration for payments attempted on this invoice (Mexico Only).

//

// For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).

type InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsParams struct {

        // Setting to true enables installments for this invoice.

        // Setting to false will prevent any selected plan from applying to a payment.

        Enabled *bool `form:"enabled"`

        // The selected installment plan to use for this invoice.

        Plan *InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsPlanParams `form:"plan"`

}

// If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.

type InvoicePaymentSettingsPaymentMethodOptionsCardParams struct {

        // Installment configuration for payments attempted on this invoice (Mexico Only).

        //

        // For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).

        Installments *InvoicePaymentSettingsPaymentMethodOptionsCardInstallmentsParams `form:"installments"`

        // We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). 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](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.

        RequestThreeDSecure *string `form:"request_three_d_secure"`

}

// Configuration for eu_bank_transfer funding type.

type InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEUBankTransferParams struct {

        // The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.

        Country *string `form:"country"`

}

// Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.

type InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferParams struct {

        // Configuration for eu_bank_transfer funding type.

        EUBankTransfer *InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEUBankTransferParams `form:"eu_bank_transfer"`

        // 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`.

        Type *string `form:"type"`

}

// If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.

type InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceParams struct {

        // Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.

        BankTransfer *InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferParams `form:"bank_transfer"`

        // The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.

        FundingType *string `form:"funding_type"`

}

// If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.

type InvoicePaymentSettingsPaymentMethodOptionsKonbiniParams struct{}

// If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.

type InvoicePaymentSettingsPaymentMethodOptionsSEPADebitParams struct{}

// Provide filters for the linked accounts that the customer can select for the payment method.

type InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersParams struct {

        // The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.

        AccountSubcategories []*string `form:"account_subcategories"`

        // ID of the institution to use to filter for selectable accounts.

        Institution *string `form:"institution"`

}

// Additional fields for Financial Connections Session creation

type InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsParams struct {

        // Provide filters for the linked accounts that the customer can select for the payment method.

        Filters *InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsFiltersParams `form:"filters"`

        // The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.

        Permissions []*string `form:"permissions"`

        // List of data features that you would like to retrieve upon account creation.

        Prefetch []*string `form:"prefetch"`

}

// 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.

type InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountParams struct {

        // Additional fields for Financial Connections Session creation

        FinancialConnections *InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountFinancialConnectionsParams `form:"financial_connections"`

        // Verification method for the intent

        VerificationMethod *string `form:"verification_method"`

}

// Payment-method-specific configuration to provide to the invoice's PaymentIntent.

type InvoicePaymentSettingsPaymentMethodOptionsParams struct {

        // 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.

        ACSSDebit *InvoicePaymentSettingsPaymentMethodOptionsACSSDebitParams `form:"acss_debit"`

        // If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.

        Bancontact *InvoicePaymentSettingsPaymentMethodOptionsBancontactParams `form:"bancontact"`

        // If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.

        Card *InvoicePaymentSettingsPaymentMethodOptionsCardParams `form:"card"`

        // If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.

        CustomerBalance *InvoicePaymentSettingsPaymentMethodOptionsCustomerBalanceParams `form:"customer_balance"`

        // If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.

        Konbini *InvoicePaymentSettingsPaymentMethodOptionsKonbiniParams `form:"konbini"`

        // If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.

        SEPADebit *InvoicePaymentSettingsPaymentMethodOptionsSEPADebitParams `form:"sepa_debit"`

        // 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.

        USBankAccount *InvoicePaymentSettingsPaymentMethodOptionsUSBankAccountParams `form:"us_bank_account"`

}

// Configuration settings for the PaymentIntent that is generated when the invoice is finalized.

type InvoicePaymentSettingsParams struct {

        // 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 default_payment_method or default_source, if set.

        DefaultMandate *string `form:"default_mandate"`

        // Payment-method-specific configuration to provide to the invoice's PaymentIntent.

        PaymentMethodOptions *InvoicePaymentSettingsPaymentMethodOptionsParams `form:"payment_method_options"`

        // 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](https://dashboard.stripe.com/settings/billing/invoice).

        PaymentMethodTypes []*string `form:"payment_method_types"`

}

// Invoice pdf rendering options

type InvoiceRenderingPDFParams struct {

        // Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.

        //  If set to `auto`, invoice PDF page size defaults to `a4` for customers with

        //  Japanese locale and `letter` for customers with other locales.

        PageSize *string `form:"page_size"`

}

// The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.

type InvoiceRenderingParams struct {

        // How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.

        AmountTaxDisplay *string `form:"amount_tax_display"`

        // Invoice pdf rendering options

        PDF *InvoiceRenderingPDFParams `form:"pdf"`

        // ID of the invoice rendering template to use for this invoice.

        Template *string `form:"template"`

        // The specific version of invoice rendering template to use for this invoice.

        TemplateVersion *int64 `form:"template_version"`

}

// The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.

type InvoiceShippingCostShippingRateDataDeliveryEstimateMaximumParams struct {

        // A unit of time.

        Unit *string `form:"unit"`

        // Must be greater than 0.

        Value *int64 `form:"value"`

}

// The lower bound of the estimated range. If empty, represents no lower bound.

type InvoiceShippingCostShippingRateDataDeliveryEstimateMinimumParams struct {

        // A unit of time.

        Unit *string `form:"unit"`

        // Must be greater than 0.

        Value *int64 `form:"value"`

}

// The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.

type InvoiceShippingCostShippingRateDataDeliveryEstimateParams struct {

        // The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.

        Maximum *InvoiceShippingCostShippingRateDataDeliveryEstimateMaximumParams `form:"maximum"`

        // The lower bound of the estimated range. If empty, represents no lower bound.

        Minimum *InvoiceShippingCostShippingRateDataDeliveryEstimateMinimumParams `form:"minimum"`

}

// Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).

type InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptionsParams struct {

        // A non-negative integer in cents representing how much to charge.

        Amount *int64 `form:"amount"`

        // Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.

        TaxBehavior *string `form:"tax_behavior"`

}

// Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.

type InvoiceShippingCostShippingRateDataFixedAmountParams struct {

        // A non-negative integer in cents representing how much to charge.

        Amount *int64 `form:"amount"`

        // Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

        Currency *string `form:"currency"`

        // Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).

        CurrencyOptions map[string]*InvoiceShippingCostShippingRateDataFixedAmountCurrencyOptionsParams `form:"currency_options"`

}

// Parameters to create a new ad-hoc shipping rate for this order.

type InvoiceShippingCostShippingRateDataParams struct {

        // The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.

        DeliveryEstimate *InvoiceShippingCostShippingRateDataDeliveryEstimateParams `form:"delivery_estimate"`

        // The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.

        DisplayName *string `form:"display_name"`

        // Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.

        FixedAmount *InvoiceShippingCostShippingRateDataFixedAmountParams `form:"fixed_amount"`

        // Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.

        Metadata map[string]string `form:"metadata"`

        // Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.

        TaxBehavior *string `form:"tax_behavior"`

        // A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.

        TaxCode *string `form:"tax_code"`

        // The type of calculation to use on the shipping rate.

        Type *string `form:"type"`

}

// AddMetadata adds a new key-value pair to the Metadata.

}

// Settings for the cost of shipping for this invoice.

type InvoiceShippingCostParams struct {

        // The ID of the shipping rate to use for this order.

        ShippingRate *string `form:"shipping_rate"`

        // Parameters to create a new ad-hoc shipping rate for this order.

        ShippingRateData *InvoiceShippingCostShippingRateDataParams `form:"shipping_rate_data"`

}

// 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.

type InvoiceShippingDetailsParams struct {

        // Shipping address

        Address *AddressParams `form:"address"`

        // Recipient name.

        Name *string `form:"name"`

        // Recipient phone (including extension)

        Phone *string `form:"phone"`

}

// 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. This will be unset if you POST an empty value.

type InvoiceTransferDataParams struct {

        // The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.

        Amount *int64 `form:"amount"`

        // ID of an existing, connected Stripe account.

        Destination *string `form:"destination"`

}

// You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

type InvoiceListParams struct {

        ListParams `form:"*"`

        // The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.

        CollectionMethod *string `form:"collection_method"`

        // Only return invoices that were created during the given date interval.

        Created *int64 `form:"created"`

        // Only return invoices that were created during the given date interval.

        CreatedRange *RangeQueryParams `form:"created"`

        // Only return invoices for the customer specified by this customer ID.

        Customer     *string           `form:"customer"`

        DueDate      *int64            `form:"due_date"`

        DueDateRange *RangeQueryParams `form:"due_date"`

        // Specifies which fields in the response should be expanded.

        Expand []*string `form:"expand"`

        // The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)

        Status *string `form:"status"`

        // Only return invoices for the subscription specified by this subscription ID.

        Subscription *string `form:"subscription"`

}

// AddExpand appends a new field to expand.

// Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.

type InvoiceFromInvoiceParams struct {

        // The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted

        Action *string `form:"action"`

        // The `id` of the invoice that will be cloned.

        Invoice *string `form:"invoice"`

}

// Search for invoices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).

// Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating

// conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up

// to an hour behind during outages. Search functionality is not available to merchants in India.

type InvoiceSearchParams struct {

        SearchParams `form:"*"`

        // Specifies which fields in the response should be expanded.

        Expand []*string `form:"expand"`

        // A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

        Page *string `form:"page"`

}

// AddExpand appends a new field to expand.

type InvoiceUpcomingAutomaticTaxParams struct {

        Enabled *bool `form:"enabled"`

}

// The customer's shipping information. Appears on invoices emailed to this customer.

type InvoiceUpcomingCustomerDetailsShippingParams struct {

        // Customer shipping address.

        Address *AddressParams `form:"address"`

        // Customer name.

        Name *string `form:"name"`

        // Customer phone (including extension).

        Phone *string `form:"phone"`

}

// Tax details about the customer.

type InvoiceUpcomingCustomerDetailsTaxParams struct {

        // A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes.

        IPAddress *string `form:"ip_address"`

}

// The customer's tax IDs.

type InvoiceUpcomingCustomerDetailsTaxIDParams struct {

        // Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`

        Type *string `form:"type"`

        // Value of the tax ID.

        Value *string `form:"value"`

}

// Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.

type InvoiceUpcomingCustomerDetailsParams struct {

        // The customer's address.

        Address *AddressParams `form:"address"`

        // The customer's shipping information. Appears on invoices emailed to this customer.

        Shipping *InvoiceUpcomingCustomerDetailsShippingParams `form:"shipping"`

        // Tax details about the customer.

        Tax *InvoiceUpcomingCustomerDetailsTaxParams `form:"tax"`

        // The customer's tax exemption. One of `none`, `exempt`, or `reverse`.

        TaxExempt *string `form:"tax_exempt"`

        // The customer's tax IDs.

        TaxIDs []*InvoiceUpcomingCustomerDetailsTaxIDParams `form:"tax_ids"`

}

// The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.

type InvoiceUpcomingInvoiceItemPeriodParams struct {

        // The end of the period, which must be greater than or equal to the start. This value is inclusive.

        End *int64 `form:"end"`

        // The start of the period. This value is inclusive.

        Start *int64 `form:"start"`

}

// List of invoice items to add or update in the upcoming invoice preview (up to 250).

type InvoiceUpcomingInvoiceItemParams struct {

        // The integer amount in cents (or local equivalent) of previewed invoice item.

        Amount *int64 `form:"amount"`

        // Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Only applicable to new invoice items.

        Currency *string `form:"currency"`

        // An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.

        Description *string `form:"description"`

        // Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.

        Discountable *bool `form:"discountable"`

        // The coupons to redeem into discounts for the invoice item in the preview.

        Discounts []*InvoiceItemDiscountParams `form:"discounts"`

        // The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.

        InvoiceItem *string `form:"invoiceitem"`

        // Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.

        Metadata map[string]string `form:"metadata"`

        // The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.

        Period *InvoiceUpcomingInvoiceItemPeriodParams `form:"period"`

        // The ID of the price object. One of `price` or `price_data` is required.

        Price *string `form:"price"`

        // Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.

        PriceData *InvoiceItemPriceDataParams `form:"price_data"`

        // Non-negative integer. The quantity of units for the invoice item.

        Quantity *int64 `form:"quantity"`

        // Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.

        TaxBehavior *string `form:"tax_behavior"`

        // A [tax code](https://stripe.com/docs/tax/tax-categories) ID.

        TaxCode *string `form:"tax_code"`

        // The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.

        TaxRates []*string `form:"tax_rates"`

        // The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.

        UnitAmount *int64 `form:"unit_amount"`

        // Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.

        UnitAmountDecimal *float64 `form:"unit_amount_decimal,high_precision"`

}

// AddMetadata adds a new key-value pair to the Metadata.

}

// The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

type InvoiceUpcomingIssuerParams struct {

        // The connected account being referenced when `type` is `account`.

        Account *string `form:"account"`

        // Type of the account referenced in the request.

        Type *string `form:"type"`

}

// Use the `end` time of a given discount.

type InvoiceUpcomingScheduleDetailsAmendmentAmendmentEndDiscountEndParams struct {

        // The ID of a specific discount.

        Discount *string `form:"discount"`

}

// Time span for the amendment starting from the `amendment_start`.

type InvoiceUpcomingScheduleDetailsAmendmentAmendmentEndDurationParams struct {

        // Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.

        Interval *string `form:"interval"`

        // The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.

        IntervalCount *int64 `form:"interval_count"`

}

// Details to identify the end of the time range modified by the proposed change. If not supplied, the amendment is considered a point-in-time operation that only affects the exact timestamp at `amendment_start`, and a restricted set of attributes is supported on the amendment.

type InvoiceUpcomingScheduleDetailsAmendmentAmendmentEndParams struct {

        // Use the `end` time of a given discount.

        DiscountEnd *InvoiceUpcomingScheduleDetailsAmendmentAmendmentEndDiscountEndParams `form:"discount_end"`

        // Time span for the amendment starting from the `amendment_start`.

        Duration *InvoiceUpcomingScheduleDetailsAmendmentAmendmentEndDurationParams `form:"duration"`

        // A precise Unix timestamp for the amendment to end. Must be after the `amendment_start`.

        Timestamp *int64 `form:"timestamp"`

        // Select one of three ways to pass the `amendment_end`.

        Type *string `form:"type"`

}