File: //var/www/api.javaapp.co.uk/node_modules/stripe/types/InvoicesResource.d.ts
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
interface InvoiceCreateParams {
/**
* The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
*/
account_tax_ids?: Stripe.Emptyable<Array<string>>;
/**
* 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).
*/
application_fee_amount?: number;
/**
* 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.
*/
auto_advance?: boolean;
/**
* Settings for automatic tax lookup for this invoice.
*/
automatic_tax?: InvoiceCreateParams.AutomaticTax;
/**
* 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`.
*/
collection_method?: InvoiceCreateParams.CollectionMethod;
/**
* The currency to create this invoice in. Defaults to that of `customer` if not specified.
*/
currency?: string;
/**
* A list of up to 4 custom fields to be displayed on the invoice.
*/
custom_fields?: Stripe.Emptyable<Array<InvoiceCreateParams.CustomField>>;
/**
* The ID of the customer who will be billed.
*/
customer?: string;
/**
* The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`.
*/
days_until_due?: number;
/**
* 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_payment_method?: 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_source?: string;
/**
* The tax rates that will apply to any line item that does not have `tax_rates` set.
*/
default_tax_rates?: Array<string>;
/**
* An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
*/
description?: string;
/**
* 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?: Stripe.Emptyable<Array<InvoiceCreateParams.Discount>>;
/**
* The date on which payment for this invoice is due. Valid only for invoices where `collection_method=send_invoice`.
*/
due_date?: 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.
*/
effective_at?: number;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Footer to be displayed on the invoice.
*/
footer?: string;
/**
* 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.
*/
from_invoice?: InvoiceCreateParams.FromInvoice;
/**
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
*/
issuer?: InvoiceCreateParams.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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* 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;
/**
* 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.
*/
on_behalf_of?: string;
/**
* Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
*/
payment_settings?: InvoiceCreateParams.PaymentSettings;
/**
* How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.
*/
pending_invoice_items_behavior?: InvoiceCreateParams.PendingInvoiceItemsBehavior;
/**
* The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
*/
rendering?: InvoiceCreateParams.Rendering;
/**
* Settings for the cost of shipping for this invoice.
*/
shipping_cost?: InvoiceCreateParams.ShippingCost;
/**
* 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.
*/
shipping_details?: InvoiceCreateParams.ShippingDetails;
/**
* 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`.
*/
statement_descriptor?: string;
/**
* 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;
/**
* 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.
*/
transfer_data?: InvoiceCreateParams.TransferData;
}
namespace InvoiceCreateParams {
interface AutomaticTax {
/**
* 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: boolean;
/**
* 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?: AutomaticTax.Liability;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
}
type CollectionMethod = 'charge_automatically' | 'send_invoice';
interface CustomField {
/**
* The name of the custom field. This may be up to 40 characters.
*/
name: string;
/**
* The value of the custom field. This may be up to 140 characters.
*/
value: string;
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface FromInvoice {
/**
* The relation between the new invoice and the original invoice. Currently, only 'revision' is permitted
*/
action: 'revision';
/**
* The `id` of the invoice that will be cloned.
*/
invoice: string;
}
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Issuer.Type;
}
namespace Issuer {
type Type = 'account' | 'self';
}
interface PaymentSettings {
/**
* 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.
*/
default_mandate?: Stripe.Emptyable<string>;
/**
* Payment-method-specific configuration to provide to the invoice's PaymentIntent.
*/
payment_method_options?: PaymentSettings.PaymentMethodOptions;
/**
* 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).
*/
payment_method_types?: Stripe.Emptyable<
Array<PaymentSettings.PaymentMethodType>
>;
}
namespace PaymentSettings {
interface PaymentMethodOptions {
/**
* 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.
*/
acss_debit?: Stripe.Emptyable<PaymentMethodOptions.AcssDebit>;
/**
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
*/
bancontact?: Stripe.Emptyable<PaymentMethodOptions.Bancontact>;
/**
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
*/
card?: Stripe.Emptyable<PaymentMethodOptions.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.
*/
customer_balance?: Stripe.Emptyable<
PaymentMethodOptions.CustomerBalance
>;
/**
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
*/
konbini?: Stripe.Emptyable<PaymentMethodOptions.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.
*/
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
/**
* 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.
*/
us_bank_account?: Stripe.Emptyable<
PaymentMethodOptions.UsBankAccount
>;
}
namespace PaymentMethodOptions {
interface AcssDebit {
/**
* Additional fields for Mandate creation
*/
mandate_options?: AcssDebit.MandateOptions;
/**
* Verification method for the intent
*/
verification_method?: AcssDebit.VerificationMethod;
}
namespace AcssDebit {
interface MandateOptions {
/**
* Transaction type of the mandate.
*/
transaction_type?: MandateOptions.TransactionType;
}
namespace MandateOptions {
type TransactionType = 'business' | 'personal';
}
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
}
interface Bancontact {
/**
* Preferred language of the Bancontact authorization page that the customer is redirected to.
*/
preferred_language?: Bancontact.PreferredLanguage;
}
namespace Bancontact {
type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
}
interface Card {
/**
* 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?: Card.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.
*/
request_three_d_secure?: Card.RequestThreeDSecure;
}
namespace Card {
interface Installments {
/**
* Setting to true enables installments for this invoice.
* Setting to false will prevent any selected plan from applying to a payment.
*/
enabled?: boolean;
/**
* The selected installment plan to use for this invoice.
*/
plan?: Stripe.Emptyable<Installments.Plan>;
}
namespace Installments {
interface Plan {
/**
* For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
*/
count?: number;
/**
* 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?: 'month';
/**
* Type of installment plan, one of `fixed_count`.
*/
type: 'fixed_count';
}
}
type RequestThreeDSecure = 'any' | 'automatic' | 'challenge';
}
interface CustomerBalance {
/**
* Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
*/
bank_transfer?: CustomerBalance.BankTransfer;
/**
* The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
*/
funding_type?: string;
}
namespace CustomerBalance {
interface BankTransfer {
/**
* Configuration for eu_bank_transfer funding type.
*/
eu_bank_transfer?: BankTransfer.EuBankTransfer;
/**
* 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;
}
namespace BankTransfer {
interface EuBankTransfer {
/**
* The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
*/
country: string;
}
}
}
interface Konbini {}
interface SepaDebit {}
interface UsBankAccount {
/**
* Additional fields for Financial Connections Session creation
*/
financial_connections?: UsBankAccount.FinancialConnections;
/**
* Verification method for the intent
*/
verification_method?: UsBankAccount.VerificationMethod;
}
namespace UsBankAccount {
interface FinancialConnections {
/**
* Provide filters for the linked accounts that the customer can select for the payment method.
*/
filters?: FinancialConnections.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?: Array<FinancialConnections.Permission>;
/**
* List of data features that you would like to retrieve upon account creation.
*/
prefetch?: Array<FinancialConnections.Prefetch>;
}
namespace FinancialConnections {
interface Filters {
/**
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
*/
account_subcategories?: Array<Filters.AccountSubcategory>;
}
namespace Filters {
type AccountSubcategory = 'checking' | 'savings';
}
type Permission =
| 'balances'
| 'ownership'
| 'payment_method'
| 'transactions';
type Prefetch = 'balances' | 'ownership' | 'transactions';
}
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
}
}
type PaymentMethodType =
| 'ach_credit_transfer'
| 'ach_debit'
| 'acss_debit'
| 'amazon_pay'
| 'au_becs_debit'
| 'bacs_debit'
| 'bancontact'
| 'boleto'
| 'card'
| 'cashapp'
| 'customer_balance'
| 'eps'
| 'fpx'
| 'giropay'
| 'grabpay'
| 'ideal'
| 'konbini'
| 'link'
| 'multibanco'
| 'p24'
| 'paynow'
| 'paypal'
| 'promptpay'
| 'revolut_pay'
| 'sepa_credit_transfer'
| 'sepa_debit'
| 'sofort'
| 'swish'
| 'us_bank_account'
| 'wechat_pay';
}
type PendingInvoiceItemsBehavior = 'exclude' | 'include';
interface Rendering {
/**
* 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.
*/
amount_tax_display?: Stripe.Emptyable<Rendering.AmountTaxDisplay>;
/**
* Invoice pdf rendering options
*/
pdf?: Rendering.Pdf;
/**
* ID of the invoice rendering template to use for this invoice.
*/
template?: string;
/**
* The specific version of invoice rendering template to use for this invoice.
*/
template_version?: Stripe.Emptyable<number>;
}
namespace Rendering {
type AmountTaxDisplay = 'exclude_tax' | 'include_inclusive_tax';
interface Pdf {
/**
* 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.
*/
page_size?: Pdf.PageSize;
}
namespace Pdf {
type PageSize = 'a4' | 'auto' | 'letter';
}
}
interface ShippingCost {
/**
* The ID of the shipping rate to use for this order.
*/
shipping_rate?: string;
/**
* Parameters to create a new ad-hoc shipping rate for this order.
*/
shipping_rate_data?: ShippingCost.ShippingRateData;
}
namespace ShippingCost {
interface ShippingRateData {
/**
* The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
*/
delivery_estimate?: ShippingRateData.DeliveryEstimate;
/**
* The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
*/
display_name: string;
/**
* Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
*/
fixed_amount?: ShippingRateData.FixedAmount;
/**
* 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?: Stripe.MetadataParam;
/**
* Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
*/
tax_behavior?: ShippingRateData.TaxBehavior;
/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
*/
tax_code?: string;
/**
* The type of calculation to use on the shipping rate.
*/
type?: 'fixed_amount';
}
namespace ShippingRateData {
interface DeliveryEstimate {
/**
* The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
*/
maximum?: DeliveryEstimate.Maximum;
/**
* The lower bound of the estimated range. If empty, represents no lower bound.
*/
minimum?: DeliveryEstimate.Minimum;
}
namespace DeliveryEstimate {
interface Maximum {
/**
* A unit of time.
*/
unit: Maximum.Unit;
/**
* Must be greater than 0.
*/
value: number;
}
namespace Maximum {
type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
}
interface Minimum {
/**
* A unit of time.
*/
unit: Minimum.Unit;
/**
* Must be greater than 0.
*/
value: number;
}
namespace Minimum {
type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
}
}
interface FixedAmount {
/**
* A non-negative integer in cents representing how much to charge.
*/
amount: number;
/**
* 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;
/**
* 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).
*/
currency_options?: {
[key: string]: FixedAmount.CurrencyOptions;
};
}
namespace FixedAmount {
interface CurrencyOptions {
/**
* A non-negative integer in cents representing how much to charge.
*/
amount: number;
/**
* Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
*/
tax_behavior?: CurrencyOptions.TaxBehavior;
}
namespace CurrencyOptions {
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
interface ShippingDetails {
/**
* Shipping address
*/
address: Stripe.AddressParam;
/**
* Recipient name.
*/
name: string;
/**
* Recipient phone (including extension)
*/
phone?: Stripe.Emptyable<string>;
}
interface TransferData {
/**
* The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
*/
amount?: number;
/**
* ID of an existing, connected Stripe account.
*/
destination: string;
}
}
interface InvoiceRetrieveParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface InvoiceUpdateParams {
/**
* The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
*/
account_tax_ids?: Stripe.Emptyable<Array<string>>;
/**
* 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).
*/
application_fee_amount?: number;
/**
* Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice.
*/
auto_advance?: boolean;
/**
* Settings for automatic tax lookup for this invoice.
*/
automatic_tax?: InvoiceUpdateParams.AutomaticTax;
/**
* Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.
*/
collection_method?: InvoiceUpdateParams.CollectionMethod;
/**
* 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.
*/
custom_fields?: Stripe.Emptyable<Array<InvoiceUpdateParams.CustomField>>;
/**
* 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.
*/
days_until_due?: number;
/**
* 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_payment_method?: 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_source?: Stripe.Emptyable<string>;
/**
* 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.
*/
default_tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
*/
description?: string;
/**
* The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.
*/
discounts?: Stripe.Emptyable<Array<InvoiceUpdateParams.Discount>>;
/**
* 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.
*/
due_date?: 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.
*/
effective_at?: Stripe.Emptyable<number>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* Footer to be displayed on the invoice.
*/
footer?: string;
/**
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
*/
issuer?: InvoiceUpdateParams.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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* 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?: Stripe.Emptyable<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](https://stripe.com/docs/billing/invoices/connect) documentation for details.
*/
on_behalf_of?: Stripe.Emptyable<string>;
/**
* Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
*/
payment_settings?: InvoiceUpdateParams.PaymentSettings;
/**
* The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
*/
rendering?: InvoiceUpdateParams.Rendering;
/**
* Settings for the cost of shipping for this invoice.
*/
shipping_cost?: Stripe.Emptyable<InvoiceUpdateParams.ShippingCost>;
/**
* 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.
*/
shipping_details?: Stripe.Emptyable<InvoiceUpdateParams.ShippingDetails>;
/**
* 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`.
*/
statement_descriptor?: string;
/**
* 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.
*/
transfer_data?: Stripe.Emptyable<InvoiceUpdateParams.TransferData>;
}
namespace InvoiceUpdateParams {
interface AutomaticTax {
/**
* 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: boolean;
/**
* 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?: AutomaticTax.Liability;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
}
type CollectionMethod = 'charge_automatically' | 'send_invoice';
interface CustomField {
/**
* The name of the custom field. This may be up to 40 characters.
*/
name: string;
/**
* The value of the custom field. This may be up to 140 characters.
*/
value: string;
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Issuer.Type;
}
namespace Issuer {
type Type = 'account' | 'self';
}
interface PaymentSettings {
/**
* 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.
*/
default_mandate?: Stripe.Emptyable<string>;
/**
* Payment-method-specific configuration to provide to the invoice's PaymentIntent.
*/
payment_method_options?: PaymentSettings.PaymentMethodOptions;
/**
* 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).
*/
payment_method_types?: Stripe.Emptyable<
Array<PaymentSettings.PaymentMethodType>
>;
}
namespace PaymentSettings {
interface PaymentMethodOptions {
/**
* 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.
*/
acss_debit?: Stripe.Emptyable<PaymentMethodOptions.AcssDebit>;
/**
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
*/
bancontact?: Stripe.Emptyable<PaymentMethodOptions.Bancontact>;
/**
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
*/
card?: Stripe.Emptyable<PaymentMethodOptions.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.
*/
customer_balance?: Stripe.Emptyable<
PaymentMethodOptions.CustomerBalance
>;
/**
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
*/
konbini?: Stripe.Emptyable<PaymentMethodOptions.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.
*/
sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;
/**
* 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.
*/
us_bank_account?: Stripe.Emptyable<
PaymentMethodOptions.UsBankAccount
>;
}
namespace PaymentMethodOptions {
interface AcssDebit {
/**
* Additional fields for Mandate creation
*/
mandate_options?: AcssDebit.MandateOptions;
/**
* Verification method for the intent
*/
verification_method?: AcssDebit.VerificationMethod;
}
namespace AcssDebit {
interface MandateOptions {
/**
* Transaction type of the mandate.
*/
transaction_type?: MandateOptions.TransactionType;
}
namespace MandateOptions {
type TransactionType = 'business' | 'personal';
}
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
}
interface Bancontact {
/**
* Preferred language of the Bancontact authorization page that the customer is redirected to.
*/
preferred_language?: Bancontact.PreferredLanguage;
}
namespace Bancontact {
type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
}
interface Card {
/**
* 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?: Card.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.
*/
request_three_d_secure?: Card.RequestThreeDSecure;
}
namespace Card {
interface Installments {
/**
* Setting to true enables installments for this invoice.
* Setting to false will prevent any selected plan from applying to a payment.
*/
enabled?: boolean;
/**
* The selected installment plan to use for this invoice.
*/
plan?: Stripe.Emptyable<Installments.Plan>;
}
namespace Installments {
interface Plan {
/**
* For `fixed_count` installment plans, this is required. It represents the number of installment payments your customer will make to their credit card.
*/
count?: number;
/**
* 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?: 'month';
/**
* Type of installment plan, one of `fixed_count`.
*/
type: 'fixed_count';
}
}
type RequestThreeDSecure = 'any' | 'automatic' | 'challenge';
}
interface CustomerBalance {
/**
* Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
*/
bank_transfer?: CustomerBalance.BankTransfer;
/**
* The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
*/
funding_type?: string;
}
namespace CustomerBalance {
interface BankTransfer {
/**
* Configuration for eu_bank_transfer funding type.
*/
eu_bank_transfer?: BankTransfer.EuBankTransfer;
/**
* 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;
}
namespace BankTransfer {
interface EuBankTransfer {
/**
* The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
*/
country: string;
}
}
}
interface Konbini {}
interface SepaDebit {}
interface UsBankAccount {
/**
* Additional fields for Financial Connections Session creation
*/
financial_connections?: UsBankAccount.FinancialConnections;
/**
* Verification method for the intent
*/
verification_method?: UsBankAccount.VerificationMethod;
}
namespace UsBankAccount {
interface FinancialConnections {
/**
* Provide filters for the linked accounts that the customer can select for the payment method.
*/
filters?: FinancialConnections.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?: Array<FinancialConnections.Permission>;
/**
* List of data features that you would like to retrieve upon account creation.
*/
prefetch?: Array<FinancialConnections.Prefetch>;
}
namespace FinancialConnections {
interface Filters {
/**
* The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
*/
account_subcategories?: Array<Filters.AccountSubcategory>;
}
namespace Filters {
type AccountSubcategory = 'checking' | 'savings';
}
type Permission =
| 'balances'
| 'ownership'
| 'payment_method'
| 'transactions';
type Prefetch = 'balances' | 'ownership' | 'transactions';
}
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
}
}
type PaymentMethodType =
| 'ach_credit_transfer'
| 'ach_debit'
| 'acss_debit'
| 'amazon_pay'
| 'au_becs_debit'
| 'bacs_debit'
| 'bancontact'
| 'boleto'
| 'card'
| 'cashapp'
| 'customer_balance'
| 'eps'
| 'fpx'
| 'giropay'
| 'grabpay'
| 'ideal'
| 'konbini'
| 'link'
| 'multibanco'
| 'p24'
| 'paynow'
| 'paypal'
| 'promptpay'
| 'revolut_pay'
| 'sepa_credit_transfer'
| 'sepa_debit'
| 'sofort'
| 'swish'
| 'us_bank_account'
| 'wechat_pay';
}
interface Rendering {
/**
* 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.
*/
amount_tax_display?: Stripe.Emptyable<Rendering.AmountTaxDisplay>;
/**
* Invoice pdf rendering options
*/
pdf?: Rendering.Pdf;
/**
* ID of the invoice rendering template to use for this invoice.
*/
template?: string;
/**
* The specific version of invoice rendering template to use for this invoice.
*/
template_version?: Stripe.Emptyable<number>;
}
namespace Rendering {
type AmountTaxDisplay = 'exclude_tax' | 'include_inclusive_tax';
interface Pdf {
/**
* 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.
*/
page_size?: Pdf.PageSize;
}
namespace Pdf {
type PageSize = 'a4' | 'auto' | 'letter';
}
}
interface ShippingCost {
/**
* The ID of the shipping rate to use for this order.
*/
shipping_rate?: string;
/**
* Parameters to create a new ad-hoc shipping rate for this order.
*/
shipping_rate_data?: ShippingCost.ShippingRateData;
}
namespace ShippingCost {
interface ShippingRateData {
/**
* The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
*/
delivery_estimate?: ShippingRateData.DeliveryEstimate;
/**
* The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
*/
display_name: string;
/**
* Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
*/
fixed_amount?: ShippingRateData.FixedAmount;
/**
* 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?: Stripe.MetadataParam;
/**
* Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
*/
tax_behavior?: ShippingRateData.TaxBehavior;
/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
*/
tax_code?: string;
/**
* The type of calculation to use on the shipping rate.
*/
type?: 'fixed_amount';
}
namespace ShippingRateData {
interface DeliveryEstimate {
/**
* The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
*/
maximum?: DeliveryEstimate.Maximum;
/**
* The lower bound of the estimated range. If empty, represents no lower bound.
*/
minimum?: DeliveryEstimate.Minimum;
}
namespace DeliveryEstimate {
interface Maximum {
/**
* A unit of time.
*/
unit: Maximum.Unit;
/**
* Must be greater than 0.
*/
value: number;
}
namespace Maximum {
type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
}
interface Minimum {
/**
* A unit of time.
*/
unit: Minimum.Unit;
/**
* Must be greater than 0.
*/
value: number;
}
namespace Minimum {
type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
}
}
interface FixedAmount {
/**
* A non-negative integer in cents representing how much to charge.
*/
amount: number;
/**
* 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;
/**
* 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).
*/
currency_options?: {
[key: string]: FixedAmount.CurrencyOptions;
};
}
namespace FixedAmount {
interface CurrencyOptions {
/**
* A non-negative integer in cents representing how much to charge.
*/
amount: number;
/**
* Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
*/
tax_behavior?: CurrencyOptions.TaxBehavior;
}
namespace CurrencyOptions {
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
interface ShippingDetails {
/**
* Shipping address
*/
address: Stripe.AddressParam;
/**
* Recipient name.
*/
name: string;
/**
* Recipient phone (including extension)
*/
phone?: Stripe.Emptyable<string>;
}
interface TransferData {
/**
* The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
*/
amount?: number;
/**
* ID of an existing, connected Stripe account.
*/
destination: string;
}
}
interface InvoiceListParams extends PaginationParams {
/**
* The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`.
*/
collection_method?: InvoiceListParams.CollectionMethod;
/**
* Only return invoices that were created during the given date interval.
*/
created?: Stripe.RangeQueryParam | number;
/**
* Only return invoices for the customer specified by this customer ID.
*/
customer?: string;
due_date?: Stripe.RangeQueryParam | number;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* 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?: InvoiceListParams.Status;
/**
* Only return invoices for the subscription specified by this subscription ID.
*/
subscription?: string;
}
namespace InvoiceListParams {
type CollectionMethod = 'charge_automatically' | 'send_invoice';
type Status = 'draft' | 'open' | 'paid' | 'uncollectible' | 'void';
}
interface InvoiceDeleteParams {}
interface InvoiceAddLinesParams {
/**
* The line items to add.
*/
lines: Array<InvoiceAddLinesParams.Line>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* 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`.
*/
invoice_metadata?: Stripe.Emptyable<{
[key: string]: string;
}>;
}
namespace InvoiceAddLinesParams {
interface Line {
/**
* The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
*/
amount?: number;
/**
* An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
*/
description?: string;
/**
* Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
*/
discountable?: boolean;
/**
* The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
*/
discounts?: Stripe.Emptyable<Array<Line.Discount>>;
/**
* ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.
*/
invoice_item?: string;
/**
* 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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* 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?: Line.Period;
/**
* The ID of the price object. One of `price` or `price_data` is required.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: Line.PriceData;
/**
* Non-negative integer. The quantity of units for the line item.
*/
quantity?: number;
/**
* A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
*/
tax_amounts?: Stripe.Emptyable<Array<Line.TaxAmount>>;
/**
* The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace Line {
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface Period {
/**
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
*/
end: number;
/**
* The start of the period. This value is inclusive.
*/
start: number;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to. One of `product` or `product_data` is required.
*/
product?: string;
/**
* Data used to generate a new product object inline. One of `product` or `product_data` is required.
*/
product_data?: PriceData.ProductData;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface ProductData {
/**
* The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
*/
description?: string;
/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
*/
images?: Array<string>;
/**
* 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?: Stripe.MetadataParam;
/**
* The product's name, meant to be displayable to the customer.
*/
name: string;
/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: string;
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
interface TaxAmount {
/**
* The amount, in cents (or local equivalent), of the tax.
*/
amount: number;
/**
* Data to find or create a TaxRate object.
*
* Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item's `tax_rates`, and cannot be directly added to invoices, payments, or line items.
*/
tax_rate_data: TaxAmount.TaxRateData;
/**
* The amount on which tax is calculated, in cents (or local equivalent).
*/
taxable_amount: number;
}
namespace TaxAmount {
interface TaxRateData {
/**
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
*/
country?: string;
/**
* An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
*/
description?: string;
/**
* The display name of the tax rate, which will be shown to users.
*/
display_name: string;
/**
* This specifies if the tax rate is inclusive or exclusive.
*/
inclusive: boolean;
/**
* The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice.
*/
jurisdiction?: string;
/**
* The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
*/
percentage: number;
/**
* [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
*/
state?: string;
/**
* The high-level tax type, such as `vat` or `sales_tax`.
*/
tax_type?: TaxRateData.TaxType;
}
namespace TaxRateData {
type TaxType =
| 'amusement_tax'
| 'communications_tax'
| 'gst'
| 'hst'
| 'igst'
| 'jct'
| 'lease_tax'
| 'pst'
| 'qst'
| 'rst'
| 'sales_tax'
| 'vat';
}
}
}
}
interface InvoiceCreatePreviewParams {
/**
* Settings for automatic tax lookup for this invoice preview.
*/
automatic_tax?: InvoiceCreatePreviewParams.AutomaticTax;
/**
* The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
*/
coupon?: string;
/**
* The currency to preview this invoice in. Defaults to that of `customer` if not specified.
*/
currency?: string;
/**
* The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
*/
customer?: string;
/**
* 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.
*/
customer_details?: InvoiceCreatePreviewParams.CustomerDetails;
/**
* The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
*/
discounts?: Stripe.Emptyable<Array<InvoiceCreatePreviewParams.Discount>>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* List of invoice items to add or update in the upcoming invoice preview (up to 250).
*/
invoice_items?: Array<InvoiceCreatePreviewParams.InvoiceItem>;
/**
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
*/
issuer?: InvoiceCreatePreviewParams.Issuer;
/**
* 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.
*/
on_behalf_of?: Stripe.Emptyable<string>;
/**
* Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
*/
preview_mode?: InvoiceCreatePreviewParams.PreviewMode;
/**
* The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
*/
schedule?: string;
/**
* The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
*/
schedule_details?: InvoiceCreatePreviewParams.ScheduleDetails;
/**
* The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
*/
subscription?: string;
/**
* The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.
*/
subscription_details?: InvoiceCreatePreviewParams.SubscriptionDetails;
}
namespace InvoiceCreatePreviewParams {
interface AutomaticTax {
/**
* 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: boolean;
/**
* 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?: AutomaticTax.Liability;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
}
interface CustomerDetails {
/**
* The customer's address.
*/
address?: Stripe.Emptyable<Stripe.AddressParam>;
/**
* The customer's shipping information. Appears on invoices emailed to this customer.
*/
shipping?: Stripe.Emptyable<CustomerDetails.Shipping>;
/**
* Tax details about the customer.
*/
tax?: CustomerDetails.Tax;
/**
* The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
*/
tax_exempt?: Stripe.Emptyable<CustomerDetails.TaxExempt>;
/**
* The customer's tax IDs.
*/
tax_ids?: Array<CustomerDetails.TaxId>;
}
namespace CustomerDetails {
interface Shipping {
/**
* Customer shipping address.
*/
address: Stripe.AddressParam;
/**
* Customer name.
*/
name: string;
/**
* Customer phone (including extension).
*/
phone?: string;
}
interface Tax {
/**
* 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.
*/
ip_address?: Stripe.Emptyable<string>;
}
type TaxExempt = 'exempt' | 'none' | 'reverse';
interface TaxId {
/**
* 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`, `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`, `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`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`
*/
type: TaxId.Type;
/**
* Value of the tax ID.
*/
value: string;
}
namespace TaxId {
type Type =
| 'ad_nrt'
| 'ae_trn'
| 'ar_cuit'
| 'au_abn'
| 'au_arn'
| 'bg_uic'
| 'bh_vat'
| 'bo_tin'
| 'br_cnpj'
| 'br_cpf'
| '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'
| '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'
| 'ua_vat'
| 'us_ein'
| 'uy_ruc'
| 've_rif'
| 'vn_tin'
| 'za_vat';
}
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface InvoiceItem {
/**
* The integer amount in cents (or local equivalent) of previewed invoice item.
*/
amount?: number;
/**
* 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;
/**
* An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
*/
description?: string;
/**
* Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.
*/
discountable?: boolean;
/**
* The coupons to redeem into discounts for the invoice item in the preview.
*/
discounts?: Stripe.Emptyable<Array<InvoiceItem.Discount>>;
/**
* 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;
/**
* 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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* 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?: InvoiceItem.Period;
/**
* The ID of the price object. One of `price` or `price_data` is required.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: InvoiceItem.PriceData;
/**
* Non-negative integer. The quantity of units for the invoice item.
*/
quantity?: number;
/**
* 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.
*/
tax_behavior?: InvoiceItem.TaxBehavior;
/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: Stripe.Emptyable<string>;
/**
* The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* 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.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace InvoiceItem {
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface Period {
/**
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
*/
end: number;
/**
* The start of the period. This value is inclusive.
*/
start: number;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Issuer.Type;
}
namespace Issuer {
type Type = 'account' | 'self';
}
type PreviewMode = 'next' | 'recurring';
interface ScheduleDetails {
/**
* Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
*/
end_behavior?: ScheduleDetails.EndBehavior;
/**
* List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
*/
phases?: Array<ScheduleDetails.Phase>;
/**
* In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
*/
proration_behavior?: ScheduleDetails.ProrationBehavior;
}
namespace ScheduleDetails {
type EndBehavior = 'cancel' | 'release';
interface Phase {
/**
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
*/
add_invoice_items?: Array<Phase.AddInvoiceItem>;
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
*/
application_fee_percent?: number;
/**
* Automatic tax settings for this phase.
*/
automatic_tax?: Phase.AutomaticTax;
/**
* Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
*/
billing_cycle_anchor?: Phase.BillingCycleAnchor;
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<Phase.BillingThresholds>;
/**
* Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
*/
collection_method?: Phase.CollectionMethod;
/**
* The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
*/
coupon?: string;
/**
* 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;
/**
* ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
*/
default_payment_method?: string;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
*/
default_tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
*/
description?: Stripe.Emptyable<string>;
/**
* The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
*/
discounts?: Stripe.Emptyable<Array<Phase.Discount>>;
/**
* The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
*/
end_date?: number | 'now';
/**
* All invoices will be billed using the specified settings.
*/
invoice_settings?: Phase.InvoiceSettings;
/**
* List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
*/
items: Array<Phase.Item>;
/**
* Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
*/
iterations?: number;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* The account on behalf of which to charge, for each of the associated subscription's invoices.
*/
on_behalf_of?: string;
/**
* Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
*/
proration_behavior?: Phase.ProrationBehavior;
/**
* The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
*/
start_date?: number | 'now';
/**
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
*/
transfer_data?: Phase.TransferData;
/**
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
*/
trial?: boolean;
/**
* Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
*/
trial_end?: number | 'now';
}
namespace Phase {
interface AddInvoiceItem {
/**
* The coupons to redeem into discounts for the item.
*/
discounts?: Array<AddInvoiceItem.Discount>;
/**
* The ID of the price object. One of `price` or `price_data` is required.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: AddInvoiceItem.PriceData;
/**
* Quantity for this item. Defaults to 1.
*/
quantity?: number;
/**
* The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace AddInvoiceItem {
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
interface AutomaticTax {
/**
* Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
*/
enabled: boolean;
/**
* 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?: AutomaticTax.Liability;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
}
type BillingCycleAnchor = 'automatic' | 'phase_start';
interface BillingThresholds {
/**
* Monetary threshold that triggers the subscription to advance to a new billing period
*/
amount_gte?: number;
/**
* Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
*/
reset_billing_cycle_anchor?: boolean;
}
type CollectionMethod = 'charge_automatically' | 'send_invoice';
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface InvoiceSettings {
/**
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
*/
account_tax_ids?: Stripe.Emptyable<Array<string>>;
/**
* Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
*/
days_until_due?: number;
/**
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
*/
issuer?: InvoiceSettings.Issuer;
}
namespace InvoiceSettings {
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Issuer.Type;
}
namespace Issuer {
type Type = 'account' | 'self';
}
}
interface Item {
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
/**
* The coupons to redeem into discounts for the subscription item.
*/
discounts?: Stripe.Emptyable<Array<Item.Discount>>;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
*/
plan?: string;
/**
* The ID of the price object.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
*/
price_data?: Item.PriceData;
/**
* Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
*/
quantity?: number;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace Item {
interface BillingThresholds {
/**
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
*/
usage_gte: number;
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type ProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
interface TransferData {
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
*/
amount_percent?: number;
/**
* ID of an existing, connected Stripe account.
*/
destination: string;
}
}
type ProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
}
interface SubscriptionDetails {
/**
* For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
*/
billing_cycle_anchor?: SubscriptionDetails.BillingCycleAnchor | number;
/**
* A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
*/
cancel_at?: Stripe.Emptyable<number>;
/**
* Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
*/
cancel_at_period_end?: boolean;
/**
* This simulates the subscription being canceled or expired immediately.
*/
cancel_now?: boolean;
/**
* If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.
*/
default_tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* A list of up to 20 subscription items, each with an attached price.
*/
items?: Array<SubscriptionDetails.Item>;
/**
* Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
*/
proration_behavior?: SubscriptionDetails.ProrationBehavior;
/**
* If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
*/
proration_date?: number;
/**
* For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.
*/
resume_at?: 'now';
/**
* Date a subscription is intended to start (can be future or past).
*/
start_date?: number;
/**
* If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.
*/
trial_end?: 'now' | number;
}
namespace SubscriptionDetails {
type BillingCycleAnchor = 'now' | 'unchanged';
interface Item {
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
/**
* Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
*/
clear_usage?: boolean;
/**
* A flag that, if set to `true`, will delete the specified item.
*/
deleted?: boolean;
/**
* The coupons to redeem into discounts for the subscription item.
*/
discounts?: Stripe.Emptyable<Array<Item.Discount>>;
/**
* Subscription item to update.
*/
id?: string;
/**
* 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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Plan ID for this item, as a string.
*/
plan?: string;
/**
* The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: Item.PriceData;
/**
* Quantity for this item.
*/
quantity?: number;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace Item {
interface BillingThresholds {
/**
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
*/
usage_gte: number;
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type ProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
}
}
interface InvoiceFinalizeInvoiceParams {
/**
* 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.
*/
auto_advance?: boolean;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface InvoiceListLineItemsParams extends PaginationParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface InvoiceListUpcomingLinesParams extends PaginationParams {
/**
* Settings for automatic tax lookup for this invoice preview.
*/
automatic_tax?: InvoiceListUpcomingLinesParams.AutomaticTax;
/**
* The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
*/
coupon?: string;
/**
* The currency to preview this invoice in. Defaults to that of `customer` if not specified.
*/
currency?: string;
/**
* The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
*/
customer?: string;
/**
* 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.
*/
customer_details?: InvoiceListUpcomingLinesParams.CustomerDetails;
/**
* The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
*/
discounts?: Stripe.Emptyable<
Array<InvoiceListUpcomingLinesParams.Discount>
>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* List of invoice items to add or update in the upcoming invoice preview (up to 250).
*/
invoice_items?: Array<InvoiceListUpcomingLinesParams.InvoiceItem>;
/**
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
*/
issuer?: InvoiceListUpcomingLinesParams.Issuer;
/**
* 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.
*/
on_behalf_of?: Stripe.Emptyable<string>;
/**
* Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
*/
preview_mode?: InvoiceListUpcomingLinesParams.PreviewMode;
/**
* The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
*/
schedule?: string;
/**
* The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
*/
schedule_details?: InvoiceListUpcomingLinesParams.ScheduleDetails;
/**
* The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
*/
subscription?: string;
/**
* For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.
*/
subscription_billing_cycle_anchor?:
| InvoiceListUpcomingLinesParams.SubscriptionBillingCycleAnchor
| number;
/**
* A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.
*/
subscription_cancel_at?: Stripe.Emptyable<number>;
/**
* Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.
*/
subscription_cancel_at_period_end?: boolean;
/**
* This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.
*/
subscription_cancel_now?: boolean;
/**
* If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.
*/
subscription_default_tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.
*/
subscription_details?: InvoiceListUpcomingLinesParams.SubscriptionDetails;
/**
* A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.
*/
subscription_items?: Array<
InvoiceListUpcomingLinesParams.SubscriptionItem
>;
/**
* Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.
*/
subscription_proration_behavior?: InvoiceListUpcomingLinesParams.SubscriptionProrationBehavior;
/**
* If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.
*/
subscription_proration_date?: number;
/**
* For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.
*/
subscription_resume_at?: 'now';
/**
* Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.
*/
subscription_start_date?: number;
/**
* If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.
*/
subscription_trial_end?: 'now' | number;
/**
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
*/
subscription_trial_from_plan?: boolean;
}
namespace InvoiceListUpcomingLinesParams {
interface AutomaticTax {
/**
* 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: boolean;
/**
* 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?: AutomaticTax.Liability;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
}
interface CustomerDetails {
/**
* The customer's address.
*/
address?: Stripe.Emptyable<Stripe.AddressParam>;
/**
* The customer's shipping information. Appears on invoices emailed to this customer.
*/
shipping?: Stripe.Emptyable<CustomerDetails.Shipping>;
/**
* Tax details about the customer.
*/
tax?: CustomerDetails.Tax;
/**
* The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
*/
tax_exempt?: Stripe.Emptyable<CustomerDetails.TaxExempt>;
/**
* The customer's tax IDs.
*/
tax_ids?: Array<CustomerDetails.TaxId>;
}
namespace CustomerDetails {
interface Shipping {
/**
* Customer shipping address.
*/
address: Stripe.AddressParam;
/**
* Customer name.
*/
name: string;
/**
* Customer phone (including extension).
*/
phone?: string;
}
interface Tax {
/**
* 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.
*/
ip_address?: Stripe.Emptyable<string>;
}
type TaxExempt = 'exempt' | 'none' | 'reverse';
interface TaxId {
/**
* 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`, `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`, `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`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`
*/
type: TaxId.Type;
/**
* Value of the tax ID.
*/
value: string;
}
namespace TaxId {
type Type =
| 'ad_nrt'
| 'ae_trn'
| 'ar_cuit'
| 'au_abn'
| 'au_arn'
| 'bg_uic'
| 'bh_vat'
| 'bo_tin'
| 'br_cnpj'
| 'br_cpf'
| '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'
| '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'
| 'ua_vat'
| 'us_ein'
| 'uy_ruc'
| 've_rif'
| 'vn_tin'
| 'za_vat';
}
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface InvoiceItem {
/**
* The integer amount in cents (or local equivalent) of previewed invoice item.
*/
amount?: number;
/**
* 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;
/**
* An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
*/
description?: string;
/**
* Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.
*/
discountable?: boolean;
/**
* The coupons to redeem into discounts for the invoice item in the preview.
*/
discounts?: Stripe.Emptyable<Array<InvoiceItem.Discount>>;
/**
* 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;
/**
* 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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* 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?: InvoiceItem.Period;
/**
* The ID of the price object. One of `price` or `price_data` is required.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: InvoiceItem.PriceData;
/**
* Non-negative integer. The quantity of units for the invoice item.
*/
quantity?: number;
/**
* 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.
*/
tax_behavior?: InvoiceItem.TaxBehavior;
/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: Stripe.Emptyable<string>;
/**
* The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* 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.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace InvoiceItem {
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface Period {
/**
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
*/
end: number;
/**
* The start of the period. This value is inclusive.
*/
start: number;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Issuer.Type;
}
namespace Issuer {
type Type = 'account' | 'self';
}
type PreviewMode = 'next' | 'recurring';
interface ScheduleDetails {
/**
* Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
*/
end_behavior?: ScheduleDetails.EndBehavior;
/**
* List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
*/
phases?: Array<ScheduleDetails.Phase>;
/**
* In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
*/
proration_behavior?: ScheduleDetails.ProrationBehavior;
}
namespace ScheduleDetails {
type EndBehavior = 'cancel' | 'release';
interface Phase {
/**
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
*/
add_invoice_items?: Array<Phase.AddInvoiceItem>;
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
*/
application_fee_percent?: number;
/**
* Automatic tax settings for this phase.
*/
automatic_tax?: Phase.AutomaticTax;
/**
* Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
*/
billing_cycle_anchor?: Phase.BillingCycleAnchor;
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<Phase.BillingThresholds>;
/**
* Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
*/
collection_method?: Phase.CollectionMethod;
/**
* The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
*/
coupon?: string;
/**
* 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;
/**
* ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
*/
default_payment_method?: string;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
*/
default_tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
*/
description?: Stripe.Emptyable<string>;
/**
* The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
*/
discounts?: Stripe.Emptyable<Array<Phase.Discount>>;
/**
* The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
*/
end_date?: number | 'now';
/**
* All invoices will be billed using the specified settings.
*/
invoice_settings?: Phase.InvoiceSettings;
/**
* List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
*/
items: Array<Phase.Item>;
/**
* Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
*/
iterations?: number;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* The account on behalf of which to charge, for each of the associated subscription's invoices.
*/
on_behalf_of?: string;
/**
* Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
*/
proration_behavior?: Phase.ProrationBehavior;
/**
* The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
*/
start_date?: number | 'now';
/**
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
*/
transfer_data?: Phase.TransferData;
/**
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
*/
trial?: boolean;
/**
* Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
*/
trial_end?: number | 'now';
}
namespace Phase {
interface AddInvoiceItem {
/**
* The coupons to redeem into discounts for the item.
*/
discounts?: Array<AddInvoiceItem.Discount>;
/**
* The ID of the price object. One of `price` or `price_data` is required.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: AddInvoiceItem.PriceData;
/**
* Quantity for this item. Defaults to 1.
*/
quantity?: number;
/**
* The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace AddInvoiceItem {
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
interface AutomaticTax {
/**
* Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
*/
enabled: boolean;
/**
* 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?: AutomaticTax.Liability;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
}
type BillingCycleAnchor = 'automatic' | 'phase_start';
interface BillingThresholds {
/**
* Monetary threshold that triggers the subscription to advance to a new billing period
*/
amount_gte?: number;
/**
* Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
*/
reset_billing_cycle_anchor?: boolean;
}
type CollectionMethod = 'charge_automatically' | 'send_invoice';
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface InvoiceSettings {
/**
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
*/
account_tax_ids?: Stripe.Emptyable<Array<string>>;
/**
* Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
*/
days_until_due?: number;
/**
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
*/
issuer?: InvoiceSettings.Issuer;
}
namespace InvoiceSettings {
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Issuer.Type;
}
namespace Issuer {
type Type = 'account' | 'self';
}
}
interface Item {
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
/**
* The coupons to redeem into discounts for the subscription item.
*/
discounts?: Stripe.Emptyable<Array<Item.Discount>>;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
*/
plan?: string;
/**
* The ID of the price object.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
*/
price_data?: Item.PriceData;
/**
* Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
*/
quantity?: number;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace Item {
interface BillingThresholds {
/**
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
*/
usage_gte: number;
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type ProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
interface TransferData {
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
*/
amount_percent?: number;
/**
* ID of an existing, connected Stripe account.
*/
destination: string;
}
}
type ProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
}
type SubscriptionBillingCycleAnchor = 'now' | 'unchanged';
interface SubscriptionDetails {
/**
* For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
*/
billing_cycle_anchor?: SubscriptionDetails.BillingCycleAnchor | number;
/**
* A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
*/
cancel_at?: Stripe.Emptyable<number>;
/**
* Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
*/
cancel_at_period_end?: boolean;
/**
* This simulates the subscription being canceled or expired immediately.
*/
cancel_now?: boolean;
/**
* If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.
*/
default_tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* A list of up to 20 subscription items, each with an attached price.
*/
items?: Array<SubscriptionDetails.Item>;
/**
* Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
*/
proration_behavior?: SubscriptionDetails.ProrationBehavior;
/**
* If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
*/
proration_date?: number;
/**
* For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.
*/
resume_at?: 'now';
/**
* Date a subscription is intended to start (can be future or past).
*/
start_date?: number;
/**
* If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.
*/
trial_end?: 'now' | number;
}
namespace SubscriptionDetails {
type BillingCycleAnchor = 'now' | 'unchanged';
interface Item {
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
/**
* Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
*/
clear_usage?: boolean;
/**
* A flag that, if set to `true`, will delete the specified item.
*/
deleted?: boolean;
/**
* The coupons to redeem into discounts for the subscription item.
*/
discounts?: Stripe.Emptyable<Array<Item.Discount>>;
/**
* Subscription item to update.
*/
id?: string;
/**
* 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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Plan ID for this item, as a string.
*/
plan?: string;
/**
* The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: Item.PriceData;
/**
* Quantity for this item.
*/
quantity?: number;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace Item {
interface BillingThresholds {
/**
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
*/
usage_gte: number;
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type ProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
}
interface SubscriptionItem {
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<
SubscriptionItem.BillingThresholds
>;
/**
* Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
*/
clear_usage?: boolean;
/**
* A flag that, if set to `true`, will delete the specified item.
*/
deleted?: boolean;
/**
* The coupons to redeem into discounts for the subscription item.
*/
discounts?: Stripe.Emptyable<Array<SubscriptionItem.Discount>>;
/**
* Subscription item to update.
*/
id?: string;
/**
* 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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Plan ID for this item, as a string.
*/
plan?: string;
/**
* The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: SubscriptionItem.PriceData;
/**
* Quantity for this item.
*/
quantity?: number;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace SubscriptionItem {
interface BillingThresholds {
/**
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
*/
usage_gte: number;
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type SubscriptionProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
}
interface InvoiceMarkUncollectibleParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface InvoicePayParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due.
*
* Passing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`.
*/
forgive?: boolean;
/**
* ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set.
*/
mandate?: Stripe.Emptyable<string>;
/**
* Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).
*/
off_session?: boolean;
/**
* Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.
*/
paid_out_of_band?: boolean;
/**
* A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.
*/
payment_method?: string;
/**
* A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.
*/
source?: string;
}
interface InvoiceRemoveLinesParams {
/**
* The line items to remove.
*/
lines: Array<InvoiceRemoveLinesParams.Line>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* 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`.
*/
invoice_metadata?: Stripe.Emptyable<{
[key: string]: string;
}>;
}
namespace InvoiceRemoveLinesParams {
interface Line {
/**
* Either `delete` or `unassign`. Deleted line items are permanently deleted. Unassigned line items can be reassigned to an invoice.
*/
behavior: Line.Behavior;
/**
* ID of an existing line item to remove from this invoice.
*/
id: string;
}
namespace Line {
type Behavior = 'delete' | 'unassign';
}
}
interface InvoiceRetrieveUpcomingParams {
/**
* Settings for automatic tax lookup for this invoice preview.
*/
automatic_tax?: InvoiceRetrieveUpcomingParams.AutomaticTax;
/**
* The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
*/
coupon?: string;
/**
* The currency to preview this invoice in. Defaults to that of `customer` if not specified.
*/
currency?: string;
/**
* The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
*/
customer?: string;
/**
* 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.
*/
customer_details?: InvoiceRetrieveUpcomingParams.CustomerDetails;
/**
* The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts.
*/
discounts?: Stripe.Emptyable<
Array<InvoiceRetrieveUpcomingParams.Discount>
>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* List of invoice items to add or update in the upcoming invoice preview (up to 250).
*/
invoice_items?: Array<InvoiceRetrieveUpcomingParams.InvoiceItem>;
/**
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
*/
issuer?: InvoiceRetrieveUpcomingParams.Issuer;
/**
* 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.
*/
on_behalf_of?: Stripe.Emptyable<string>;
/**
* Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
*/
preview_mode?: InvoiceRetrieveUpcomingParams.PreviewMode;
/**
* The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
*/
schedule?: string;
/**
* The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
*/
schedule_details?: InvoiceRetrieveUpcomingParams.ScheduleDetails;
/**
* The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions.
*/
subscription?: string;
/**
* For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead.
*/
subscription_billing_cycle_anchor?:
| InvoiceRetrieveUpcomingParams.SubscriptionBillingCycleAnchor
| number;
/**
* A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead.
*/
subscription_cancel_at?: Stripe.Emptyable<number>;
/**
* Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead.
*/
subscription_cancel_at_period_end?: boolean;
/**
* This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead.
*/
subscription_cancel_now?: boolean;
/**
* If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead.
*/
subscription_default_tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields.
*/
subscription_details?: InvoiceRetrieveUpcomingParams.SubscriptionDetails;
/**
* A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead.
*/
subscription_items?: Array<
InvoiceRetrieveUpcomingParams.SubscriptionItem
>;
/**
* Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead.
*/
subscription_proration_behavior?: InvoiceRetrieveUpcomingParams.SubscriptionProrationBehavior;
/**
* If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead.
*/
subscription_proration_date?: number;
/**
* For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead.
*/
subscription_resume_at?: 'now';
/**
* Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead.
*/
subscription_start_date?: number;
/**
* If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead.
*/
subscription_trial_end?: 'now' | number;
/**
* Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
*/
subscription_trial_from_plan?: boolean;
}
namespace InvoiceRetrieveUpcomingParams {
interface AutomaticTax {
/**
* 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: boolean;
/**
* 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?: AutomaticTax.Liability;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
}
interface CustomerDetails {
/**
* The customer's address.
*/
address?: Stripe.Emptyable<Stripe.AddressParam>;
/**
* The customer's shipping information. Appears on invoices emailed to this customer.
*/
shipping?: Stripe.Emptyable<CustomerDetails.Shipping>;
/**
* Tax details about the customer.
*/
tax?: CustomerDetails.Tax;
/**
* The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
*/
tax_exempt?: Stripe.Emptyable<CustomerDetails.TaxExempt>;
/**
* The customer's tax IDs.
*/
tax_ids?: Array<CustomerDetails.TaxId>;
}
namespace CustomerDetails {
interface Shipping {
/**
* Customer shipping address.
*/
address: Stripe.AddressParam;
/**
* Customer name.
*/
name: string;
/**
* Customer phone (including extension).
*/
phone?: string;
}
interface Tax {
/**
* 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.
*/
ip_address?: Stripe.Emptyable<string>;
}
type TaxExempt = 'exempt' | 'none' | 'reverse';
interface TaxId {
/**
* 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`, `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`, `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`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`
*/
type: TaxId.Type;
/**
* Value of the tax ID.
*/
value: string;
}
namespace TaxId {
type Type =
| 'ad_nrt'
| 'ae_trn'
| 'ar_cuit'
| 'au_abn'
| 'au_arn'
| 'bg_uic'
| 'bh_vat'
| 'bo_tin'
| 'br_cnpj'
| 'br_cpf'
| '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'
| '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'
| 'ua_vat'
| 'us_ein'
| 'uy_ruc'
| 've_rif'
| 'vn_tin'
| 'za_vat';
}
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface InvoiceItem {
/**
* The integer amount in cents (or local equivalent) of previewed invoice item.
*/
amount?: number;
/**
* 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;
/**
* An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
*/
description?: string;
/**
* Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.
*/
discountable?: boolean;
/**
* The coupons to redeem into discounts for the invoice item in the preview.
*/
discounts?: Stripe.Emptyable<Array<InvoiceItem.Discount>>;
/**
* 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;
/**
* 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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* 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?: InvoiceItem.Period;
/**
* The ID of the price object. One of `price` or `price_data` is required.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: InvoiceItem.PriceData;
/**
* Non-negative integer. The quantity of units for the invoice item.
*/
quantity?: number;
/**
* 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.
*/
tax_behavior?: InvoiceItem.TaxBehavior;
/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: Stripe.Emptyable<string>;
/**
* The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* 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.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace InvoiceItem {
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface Period {
/**
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
*/
end: number;
/**
* The start of the period. This value is inclusive.
*/
start: number;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Issuer.Type;
}
namespace Issuer {
type Type = 'account' | 'self';
}
type PreviewMode = 'next' | 'recurring';
interface ScheduleDetails {
/**
* Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
*/
end_behavior?: ScheduleDetails.EndBehavior;
/**
* List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
*/
phases?: Array<ScheduleDetails.Phase>;
/**
* In cases where the `schedule_details` params update the currently active phase, specifies if and how to prorate at the time of the request.
*/
proration_behavior?: ScheduleDetails.ProrationBehavior;
}
namespace ScheduleDetails {
type EndBehavior = 'cancel' | 'release';
interface Phase {
/**
* A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
*/
add_invoice_items?: Array<Phase.AddInvoiceItem>;
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
*/
application_fee_percent?: number;
/**
* Automatic tax settings for this phase.
*/
automatic_tax?: Phase.AutomaticTax;
/**
* Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
*/
billing_cycle_anchor?: Phase.BillingCycleAnchor;
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<Phase.BillingThresholds>;
/**
* Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
*/
collection_method?: Phase.CollectionMethod;
/**
* The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
*/
coupon?: string;
/**
* 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;
/**
* ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
*/
default_payment_method?: string;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
*/
default_tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
*/
description?: Stripe.Emptyable<string>;
/**
* The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
*/
discounts?: Stripe.Emptyable<Array<Phase.Discount>>;
/**
* The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
*/
end_date?: number | 'now';
/**
* All invoices will be billed using the specified settings.
*/
invoice_settings?: Phase.InvoiceSettings;
/**
* List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
*/
items: Array<Phase.Item>;
/**
* Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
*/
iterations?: number;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* The account on behalf of which to charge, for each of the associated subscription's invoices.
*/
on_behalf_of?: string;
/**
* Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
*/
proration_behavior?: Phase.ProrationBehavior;
/**
* The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
*/
start_date?: number | 'now';
/**
* The data with which to automatically create a Transfer for each of the associated subscription's invoices.
*/
transfer_data?: Phase.TransferData;
/**
* If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
*/
trial?: boolean;
/**
* Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
*/
trial_end?: number | 'now';
}
namespace Phase {
interface AddInvoiceItem {
/**
* The coupons to redeem into discounts for the item.
*/
discounts?: Array<AddInvoiceItem.Discount>;
/**
* The ID of the price object. One of `price` or `price_data` is required.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: AddInvoiceItem.PriceData;
/**
* Quantity for this item. Defaults to 1.
*/
quantity?: number;
/**
* The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace AddInvoiceItem {
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
interface AutomaticTax {
/**
* Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
*/
enabled: boolean;
/**
* 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?: AutomaticTax.Liability;
}
namespace AutomaticTax {
interface Liability {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Liability.Type;
}
namespace Liability {
type Type = 'account' | 'self';
}
}
type BillingCycleAnchor = 'automatic' | 'phase_start';
interface BillingThresholds {
/**
* Monetary threshold that triggers the subscription to advance to a new billing period
*/
amount_gte?: number;
/**
* Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
*/
reset_billing_cycle_anchor?: boolean;
}
type CollectionMethod = 'charge_automatically' | 'send_invoice';
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface InvoiceSettings {
/**
* The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
*/
account_tax_ids?: Stripe.Emptyable<Array<string>>;
/**
* Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
*/
days_until_due?: number;
/**
* The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
*/
issuer?: InvoiceSettings.Issuer;
}
namespace InvoiceSettings {
interface Issuer {
/**
* The connected account being referenced when `type` is `account`.
*/
account?: string;
/**
* Type of the account referenced in the request.
*/
type: Issuer.Type;
}
namespace Issuer {
type Type = 'account' | 'self';
}
}
interface Item {
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
/**
* The coupons to redeem into discounts for the subscription item.
*/
discounts?: Stripe.Emptyable<Array<Item.Discount>>;
/**
* Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
*/
metadata?: Stripe.MetadataParam;
/**
* The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
*/
plan?: string;
/**
* The ID of the price object.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
*/
price_data?: Item.PriceData;
/**
* Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
*/
quantity?: number;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace Item {
interface BillingThresholds {
/**
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
*/
usage_gte: number;
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type ProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
interface TransferData {
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
*/
amount_percent?: number;
/**
* ID of an existing, connected Stripe account.
*/
destination: string;
}
}
type ProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
}
type SubscriptionBillingCycleAnchor = 'now' | 'unchanged';
interface SubscriptionDetails {
/**
* For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
*/
billing_cycle_anchor?: SubscriptionDetails.BillingCycleAnchor | number;
/**
* A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
*/
cancel_at?: Stripe.Emptyable<number>;
/**
* Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
*/
cancel_at_period_end?: boolean;
/**
* This simulates the subscription being canceled or expired immediately.
*/
cancel_now?: boolean;
/**
* If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set.
*/
default_tax_rates?: Stripe.Emptyable<Array<string>>;
/**
* A list of up to 20 subscription items, each with an attached price.
*/
items?: Array<SubscriptionDetails.Item>;
/**
* Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
*/
proration_behavior?: SubscriptionDetails.ProrationBehavior;
/**
* If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
*/
proration_date?: number;
/**
* For paused subscriptions, setting `subscription_details.resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed.
*/
resume_at?: 'now';
/**
* Date a subscription is intended to start (can be future or past).
*/
start_date?: number;
/**
* If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_details.items` or `subscription` is required.
*/
trial_end?: 'now' | number;
}
namespace SubscriptionDetails {
type BillingCycleAnchor = 'now' | 'unchanged';
interface Item {
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
/**
* Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
*/
clear_usage?: boolean;
/**
* A flag that, if set to `true`, will delete the specified item.
*/
deleted?: boolean;
/**
* The coupons to redeem into discounts for the subscription item.
*/
discounts?: Stripe.Emptyable<Array<Item.Discount>>;
/**
* Subscription item to update.
*/
id?: string;
/**
* 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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Plan ID for this item, as a string.
*/
plan?: string;
/**
* The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: Item.PriceData;
/**
* Quantity for this item.
*/
quantity?: number;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace Item {
interface BillingThresholds {
/**
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
*/
usage_gte: number;
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type ProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
}
interface SubscriptionItem {
/**
* Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
*/
billing_thresholds?: Stripe.Emptyable<
SubscriptionItem.BillingThresholds
>;
/**
* Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
*/
clear_usage?: boolean;
/**
* A flag that, if set to `true`, will delete the specified item.
*/
deleted?: boolean;
/**
* The coupons to redeem into discounts for the subscription item.
*/
discounts?: Stripe.Emptyable<Array<SubscriptionItem.Discount>>;
/**
* Subscription item to update.
*/
id?: string;
/**
* 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?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Plan ID for this item, as a string.
*/
plan?: string;
/**
* The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: SubscriptionItem.PriceData;
/**
* Quantity for this item.
*/
quantity?: number;
/**
* A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace SubscriptionItem {
interface BillingThresholds {
/**
* Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
*/
usage_gte: number;
}
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type SubscriptionProrationBehavior =
| 'always_invoice'
| 'create_prorations'
| 'none';
}
interface InvoiceSearchParams {
/**
* The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices).
*/
query: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
*/
limit?: number;
/**
* 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;
}
interface InvoiceSendInvoiceParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface InvoiceUpdateLinesParams {
/**
* The line items to update.
*/
lines: Array<InvoiceUpdateLinesParams.Line>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
*/
invoice_metadata?: Stripe.Emptyable<{
[key: string]: string;
}>;
}
namespace InvoiceUpdateLinesParams {
interface Line {
/**
* The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
*/
amount?: number;
/**
* An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
*/
description?: string;
/**
* Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
*/
discountable?: boolean;
/**
* The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
*/
discounts?: Stripe.Emptyable<Array<Line.Discount>>;
/**
* ID of an existing line item on the invoice.
*/
id: string;
/**
* 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* 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?: Line.Period;
/**
* The ID of the price object. One of `price` or `price_data` is required.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: Line.PriceData;
/**
* Non-negative integer. The quantity of units for the line item.
*/
quantity?: number;
/**
* A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
*/
tax_amounts?: Stripe.Emptyable<Array<Line.TaxAmount>>;
/**
* The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace Line {
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface Period {
/**
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
*/
end: number;
/**
* The start of the period. This value is inclusive.
*/
start: number;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to. One of `product` or `product_data` is required.
*/
product?: string;
/**
* Data used to generate a new product object inline. One of `product` or `product_data` is required.
*/
product_data?: PriceData.ProductData;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface ProductData {
/**
* The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
*/
description?: string;
/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
*/
images?: Array<string>;
/**
* 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?: Stripe.MetadataParam;
/**
* The product's name, meant to be displayable to the customer.
*/
name: string;
/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: string;
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
interface TaxAmount {
/**
* The amount, in cents (or local equivalent), of the tax.
*/
amount: number;
/**
* Data to find or create a TaxRate object.
*
* Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item's `tax_rates`, and cannot be directly added to invoices, payments, or line items.
*/
tax_rate_data: TaxAmount.TaxRateData;
/**
* The amount on which tax is calculated, in cents (or local equivalent).
*/
taxable_amount: number;
}
namespace TaxAmount {
interface TaxRateData {
/**
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
*/
country?: string;
/**
* An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
*/
description?: string;
/**
* The display name of the tax rate, which will be shown to users.
*/
display_name: string;
/**
* This specifies if the tax rate is inclusive or exclusive.
*/
inclusive: boolean;
/**
* The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice.
*/
jurisdiction?: string;
/**
* The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
*/
percentage: number;
/**
* [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
*/
state?: string;
/**
* The high-level tax type, such as `vat` or `sales_tax`.
*/
tax_type?: TaxRateData.TaxType;
}
namespace TaxRateData {
type TaxType =
| 'amusement_tax'
| 'communications_tax'
| 'gst'
| 'hst'
| 'igst'
| 'jct'
| 'lease_tax'
| 'pst'
| 'qst'
| 'rst'
| 'sales_tax'
| 'vat';
}
}
}
}
interface InvoiceUpdateLineItemParams {
/**
* The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
*/
amount?: number;
/**
* An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
*/
description?: string;
/**
* Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
*/
discountable?: boolean;
/**
* The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
*/
discounts?: Stripe.Emptyable<Array<InvoiceUpdateLineItemParams.Discount>>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* 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?: InvoiceUpdateLineItemParams.Period;
/**
* The ID of the price object. One of `price` or `price_data` is required.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
*/
price_data?: InvoiceUpdateLineItemParams.PriceData;
/**
* Non-negative integer. The quantity of units for the line item.
*/
quantity?: number;
/**
* A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
*/
tax_amounts?: Stripe.Emptyable<
Array<InvoiceUpdateLineItemParams.TaxAmount>
>;
/**
* The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace InvoiceUpdateLineItemParams {
interface Discount {
/**
* ID of the coupon to create a new discount for.
*/
coupon?: string;
/**
* ID of an existing discount on the object (or one of its ancestors) to reuse.
*/
discount?: string;
/**
* ID of the promotion code to create a new discount for.
*/
promotion_code?: string;
}
interface Period {
/**
* The end of the period, which must be greater than or equal to the start. This value is inclusive.
*/
end: number;
/**
* The start of the period. This value is inclusive.
*/
start: number;
}
interface PriceData {
/**
* 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;
/**
* The ID of the product that this price will belong to. One of `product` or `product_data` is required.
*/
product?: string;
/**
* Data used to generate a new product object inline. One of `product` or `product_data` is required.
*/
product_data?: PriceData.ProductData;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface ProductData {
/**
* The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
*/
description?: string;
/**
* A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
*/
images?: Array<string>;
/**
* 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?: Stripe.MetadataParam;
/**
* The product's name, meant to be displayable to the customer.
*/
name: string;
/**
* A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
*/
tax_code?: string;
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
interface TaxAmount {
/**
* The amount, in cents (or local equivalent), of the tax.
*/
amount: number;
/**
* Data to find or create a TaxRate object.
*
* Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item's `tax_rates`, and cannot be directly added to invoices, payments, or line items.
*/
tax_rate_data: TaxAmount.TaxRateData;
/**
* The amount on which tax is calculated, in cents (or local equivalent).
*/
taxable_amount: number;
}
namespace TaxAmount {
interface TaxRateData {
/**
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
*/
country?: string;
/**
* An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
*/
description?: string;
/**
* The display name of the tax rate, which will be shown to users.
*/
display_name: string;
/**
* This specifies if the tax rate is inclusive or exclusive.
*/
inclusive: boolean;
/**
* The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice.
*/
jurisdiction?: string;
/**
* The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
*/
percentage: number;
/**
* [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
*/
state?: string;
/**
* The high-level tax type, such as `vat` or `sales_tax`.
*/
tax_type?: TaxRateData.TaxType;
}
namespace TaxRateData {
type TaxType =
| 'amusement_tax'
| 'communications_tax'
| 'gst'
| 'hst'
| 'igst'
| 'jct'
| 'lease_tax'
| 'pst'
| 'qst'
| 'rst'
| 'sales_tax'
| 'vat';
}
}
}
interface InvoiceVoidInvoiceParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
class InvoicesResource {
/**
* This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers.
*/
create(
params?: InvoiceCreateParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
create(
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* Retrieves the invoice with the given ID.
*/
retrieve(
id: string,
params?: InvoiceRetrieveParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
retrieve(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* Draft invoices are fully editable. Once an invoice is [finalized](https://stripe.com/docs/billing/invoices/workflow#finalized),
* monetary values, as well as collection_method, become uneditable.
*
* If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,
* sending reminders for, or [automatically reconciling](https://stripe.com/docs/billing/invoices/reconciliation) invoices, pass
* auto_advance=false.
*/
update(
id: string,
params?: InvoiceUpdateParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* 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.
*/
list(
params?: InvoiceListParams,
options?: RequestOptions
): ApiListPromise<Stripe.Invoice>;
list(options?: RequestOptions): ApiListPromise<Stripe.Invoice>;
/**
* 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).
*/
del(
id: string,
params?: InvoiceDeleteParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.DeletedInvoice>>;
del(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.DeletedInvoice>>;
/**
* Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
*/
addLines(
id: string,
params: InvoiceAddLinesParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
*
* Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
*
* You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.
*
* Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
*/
createPreview(
params?: InvoiceCreatePreviewParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
createPreview(
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
*/
finalizeInvoice(
id: string,
params?: InvoiceFinalizeInvoiceParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
finalizeInvoice(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
*/
listLineItems(
id: string,
params?: InvoiceListLineItemsParams,
options?: RequestOptions
): ApiListPromise<Stripe.InvoiceLineItem>;
listLineItems(
id: string,
options?: RequestOptions
): ApiListPromise<Stripe.InvoiceLineItem>;
/**
* When retrieving an upcoming invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
*/
listUpcomingLines(
params?: InvoiceListUpcomingLinesParams,
options?: RequestOptions
): ApiListPromise<Stripe.InvoiceLineItem>;
listUpcomingLines(
options?: RequestOptions
): ApiListPromise<Stripe.InvoiceLineItem>;
/**
* Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
*/
markUncollectible(
id: string,
params?: InvoiceMarkUncollectibleParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
markUncollectible(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
*/
pay(
id: string,
params?: InvoicePayParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
pay(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
*/
removeLines(
id: string,
params: InvoiceRemoveLinesParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
*
* Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
*
* You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.
*
* Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
*/
retrieveUpcoming(
params?: InvoiceRetrieveUpcomingParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.UpcomingInvoice>>;
retrieveUpcoming(
options?: RequestOptions
): Promise<Stripe.Response<Stripe.UpcomingInvoice>>;
/**
* 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.
*/
search(
params: InvoiceSearchParams,
options?: RequestOptions
): ApiSearchResultPromise<Stripe.Invoice>;
/**
* Stripe will automatically send invoices to customers according to your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). However, if you'd like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.
*
* Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event.
*/
sendInvoice(
id: string,
params?: InvoiceSendInvoiceParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
sendInvoice(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
*/
updateLines(
id: string,
params: InvoiceUpdateLinesParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
/**
* Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item,
* so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
* item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
* Updating an invoice's line item is only possible before the invoice is finalized.
*/
updateLineItem(
invoiceId: string,
id: string,
params?: InvoiceUpdateLineItemParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.InvoiceLineItem>>;
updateLineItem(
invoiceId: string,
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.InvoiceLineItem>>;
/**
* Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
*
* Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
*/
voidInvoice(
id: string,
params?: InvoiceVoidInvoiceParams,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
voidInvoice(
id: string,
options?: RequestOptions
): Promise<Stripe.Response<Stripe.Invoice>>;
}
}
}