stripe 19.3.1 → 19.4.0-alpha.2

package/types/InvoiceLineItems.d.ts

@@ -58,6 +58,16 @@ declare module 'stripe' {
        */
       livemode: boolean;
 
+      /**
+       * The amount of margin calculated per margin for this line item.
+       */
+      margin_amounts?: Array<InvoiceLineItem.MarginAmount> | null;
+
+      /**
+       * The margins applied to the line item. When set, the `default_margins` on the invoice do not apply to the line item. Use `expand[]=margins` to expand each margin.
+       */
+      margins?: Array<string | Stripe.Margin> | null;
+
       /**
        * 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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
        */
@@ -87,6 +97,11 @@ declare module 'stripe' {
 
       subscription: string | Stripe.Subscription | null;
 
+      /**
+       * The tax calculation identifiers of the line item.
+       */
+      tax_calculation_reference?: InvoiceLineItem.TaxCalculationReference | null;
+
       /**
        * The tax information of the line item.
        */
@@ -106,12 +121,34 @@ declare module 'stripe' {
         discount: string | Stripe.Discount | Stripe.DeletedDiscount;
       }
 
+      interface MarginAmount {
+        /**
+         * The amount, in cents (or local equivalent), of the reduction in line item amount.
+         */
+        amount: number;
+
+        /**
+         * The margin that was applied to get this margin amount.
+         */
+        margin: string | Stripe.Margin;
+      }
+
       interface Parent {
         /**
          * Details about the invoice item that generated this line item
          */
         invoice_item_details: Parent.InvoiceItemDetails | null;
 
+        /**
+         * Details about the license fee subscription that generated this line item
+         */
+        license_fee_subscription_details?: Parent.LicenseFeeSubscriptionDetails | null;
+
+        /**
+         * Details about the rate card subscription that generated this line item
+         */
+        rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
+
         /**
          * Details about the subscription item that generated this line item
          */
@@ -121,6 +158,11 @@ declare module 'stripe' {
          * The type of parent that generated this line item
          */
         type: Parent.Type;
+
+        /**
+         * Details about the subscription schedule that generated this line item
+         */
+        schedule_details?: Parent.ScheduleDetails | null;
       }
 
       namespace Parent {
@@ -169,6 +211,67 @@ declare module 'stripe' {
           }
         }
 
+        interface LicenseFeeSubscriptionDetails {
+          /**
+           * The invoice item that generated this line item
+           */
+          invoice_item: string;
+
+          /**
+           * The license fee subscription that generated this line item
+           */
+          license_fee_subscription: string;
+
+          /**
+           * The license fee version at the time this line item was generated
+           */
+          license_fee_version: string;
+
+          /**
+           * The pricing plan subscription that manages the license fee subscription
+           */
+          pricing_plan_subscription: string;
+
+          /**
+           * The pricing plan version at the time this line item was generated
+           */
+          pricing_plan_version: string;
+        }
+
+        interface RateCardSubscriptionDetails {
+          /**
+           * The invoice item that generated this line item
+           */
+          invoice_item: string;
+
+          /**
+           * The pricing plan subscription that manages the rate card subscription
+           */
+          pricing_plan_subscription?: string | null;
+
+          /**
+           * The pricing plan version at the time this line item was generated
+           */
+          pricing_plan_version?: string | null;
+
+          /**
+           * The rate card subscription that generated this line item
+           */
+          rate_card_subscription: string;
+
+          /**
+           * The rate card version at the time this line item was generated
+           */
+          rate_card_version: string;
+        }
+
+        interface ScheduleDetails {
+          /**
+           * The subscription schedule that generated this line item
+           */
+          schedule: string;
+        }
+
         interface SubscriptionItemDetails {
           /**
            * The invoice item that generated this line item
@@ -219,7 +322,12 @@ declare module 'stripe' {
           }
         }
 
-        type Type = 'invoice_item_details' | 'subscription_item_details';
+        type Type =
+          | 'invoice_item_details'
+          | 'license_fee_subscription_details'
+          | 'rate_card_subscription_details'
+          | 'schedule_details'
+          | 'subscription_item_details';
       }
 
       interface Period {
@@ -253,6 +361,11 @@ declare module 'stripe' {
          */
         discount?: string | Stripe.Discount | Stripe.DeletedDiscount;
 
+        /**
+         * The margin that was applied to get this pretax credit amount.
+         */
+        margin?: string | Stripe.Margin;
+
         /**
          * Type of the pretax credit amount referenced.
          */
@@ -260,16 +373,20 @@ declare module 'stripe' {
       }
 
       namespace PretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount';
+        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
       }
 
       interface Pricing {
+        license_fee_details?: Pricing.LicenseFeeDetails;
+
         price_details?: Pricing.PriceDetails;
 
+        rate_card_rate_details?: Pricing.RateCardRateDetails;
+
         /**
          * The type of the pricing details.
          */
-        type: 'price_details';
+        type: Pricing.Type;
 
         /**
          * The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
@@ -278,6 +395,23 @@ declare module 'stripe' {
       }
 
       namespace Pricing {
+        interface LicenseFeeDetails {
+          /**
+           * The ID of the license fee this item is associated with
+           */
+          license_fee: string;
+
+          /**
+           * The version of the license fee this item is associated with
+           */
+          license_fee_version: string;
+
+          /**
+           * The ID of the licensed item this item is associated with
+           */
+          licensed_item: string;
+        }
+
         interface PriceDetails {
           /**
            * The ID of the price this item is associated with.
@@ -289,6 +423,28 @@ declare module 'stripe' {
            */
           product: string;
         }
+
+        interface RateCardRateDetails {
+          /**
+           * The ID of billable item this item is associated with
+           */
+          metered_item: string;
+
+          /**
+           * The ID of the rate card this item is associated with
+           */
+          rate_card: string;
+
+          /**
+           * The ID of the rate card rate this item is associated with
+           */
+          rate_card_rate: string;
+        }
+
+        type Type =
+          | 'license_fee_details'
+          | 'price_details'
+          | 'rate_card_rate_details';
       }
 
       interface Tax {
@@ -348,6 +504,18 @@ declare module 'stripe' {
           tax_rate: string;
         }
       }
+
+      interface TaxCalculationReference {
+        /**
+         * The calculation identifier for tax calculation response.
+         */
+        calculation_id: string | null;
+
+        /**
+         * The calculation identifier for tax calculation response line item.
+         */
+        calculation_item_id: string | null;
+      }
     }
   }
 }

package/types/Invoices.d.ts

@@ -109,6 +109,11 @@ declare module 'stripe' {
        */
       amount_shipping: number;
 
+      /**
+       * List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
+       */
+      amounts_due?: Array<Invoice.AmountsDue> | null;
+
       /**
        * ID of the Connect Application that created the invoice.
        */
@@ -149,7 +154,7 @@ declare module 'stripe' {
        * * `subscription_cycle`: A subscription advanced into a new period.
        * * `subscription_threshold`: A subscription reached a billing threshold.
        * * `subscription_update`: A subscription was updated.
-       * * `upcoming`: Reserved for upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription.
+       * * `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint.
        */
       billing_reason: Invoice.BillingReason | null;
 
@@ -183,6 +188,11 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
 
+      /**
+       * The ID of the account who will be billed.
+       */
+      customer_account?: string | null;
+
       /**
        * The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
        */
@@ -218,6 +228,11 @@ declare module 'stripe' {
        */
       customer_tax_ids?: Array<Invoice.CustomerTaxId> | null;
 
+      /**
+       * The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
+       */
+      default_margins?: Array<string | Stripe.Margin> | null;
+
       /**
        * 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.
        */
@@ -426,6 +441,11 @@ declare module 'stripe' {
        */
       total_excluding_tax: number | null;
 
+      /**
+       * The aggregate amounts calculated per margin across all line items.
+       */
+      total_margin_amounts?: Array<Invoice.TotalMarginAmount> | null;
+
       /**
        * Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
        */
@@ -445,6 +465,52 @@ declare module 'stripe' {
     }
 
     namespace Invoice {
+      interface AmountsDue {
+        /**
+         * Incremental amount due for this payment in cents (or local equivalent).
+         */
+        amount: number;
+
+        /**
+         * The amount in cents (or local equivalent) that was paid for this payment.
+         */
+        amount_paid: number;
+
+        /**
+         * The difference between the payment's amount and amount_paid, in cents (or local equivalent).
+         */
+        amount_remaining: number;
+
+        /**
+         * Number of days from when invoice is finalized until the payment is due.
+         */
+        days_until_due: number | null;
+
+        /**
+         * An arbitrary string attached to the object. Often useful for displaying to users.
+         */
+        description: string | null;
+
+        /**
+         * Date on which a payment plan's payment is due.
+         */
+        due_date: number | null;
+
+        /**
+         * Timestamp when the payment was paid.
+         */
+        paid_at: number | null;
+
+        /**
+         * The status of the payment, one of `open`, `paid`, or `past_due`
+         */
+        status: AmountsDue.Status;
+      }
+
+      namespace AmountsDue {
+        type Status = 'open' | 'paid' | 'past_due';
+      }
+
       interface AutomaticTax {
         /**
          * If Stripe disabled automatic tax, this enum describes why.
@@ -880,6 +946,7 @@ declare module 'stripe' {
           | 'financial_connections_account_inactive'
           | 'financial_connections_account_pending_account_numbers'
           | 'financial_connections_account_unavailable_account_numbers'
+          | 'financial_connections_institution_unavailable'
           | 'financial_connections_no_successful_transaction_refresh'
           | 'forwarding_api_inactive'
           | 'forwarding_api_invalid_parameter'
@@ -978,6 +1045,7 @@ declare module 'stripe' {
           | 'return_intent_already_processed'
           | 'routing_number_invalid'
           | 'secret_key_required'
+          | 'sensitive_data_access_expired'
           | 'sepa_unsupported_account'
           | 'setup_attempt_failed'
           | 'setup_intent_authentication_failure'
@@ -997,6 +1065,7 @@ declare module 'stripe' {
           | 'taxes_calculation_failed'
           | 'terminal_location_country_unsupported'
           | 'terminal_reader_busy'
+          | 'terminal_reader_collected_data_invalid'
           | 'terminal_reader_hardware_fault'
           | 'terminal_reader_invalid_location_for_activation'
           | 'terminal_reader_invalid_location_for_payment'
@@ -1009,7 +1078,9 @@ declare module 'stripe' {
           | 'token_in_use'
           | 'transfer_source_balance_parameters_mismatch'
           | 'transfers_not_allowed'
-          | 'url_invalid';
+          | 'url_invalid'
+          | 'v2_account_disconnection_unsupported'
+          | 'v2_account_missing_configuration';
 
         type Type =
           | 'api_error'
@@ -1019,6 +1090,11 @@ declare module 'stripe' {
       }
 
       interface Parent {
+        /**
+         * Details about the billing cadence that generated this invoice
+         */
+        billing_cadence_details?: Parent.BillingCadenceDetails | null;
+
         /**
          * Details about the quote that generated this invoice
          */
@@ -1033,9 +1109,21 @@ declare module 'stripe' {
          * The type of parent that generated this invoice
          */
         type: Parent.Type;
+
+        /**
+         * Details about the schedule that generated this invoice
+         */
+        schedule_details?: Parent.ScheduleDetails | null;
       }
 
       namespace Parent {
+        interface BillingCadenceDetails {
+          /**
+           * The billing cadence that generated this invoice
+           */
+          billing_cadence: string;
+        }
+
         interface QuoteDetails {
           /**
            * The quote that generated this invoice
@@ -1043,6 +1131,13 @@ declare module 'stripe' {
           quote: string;
         }
 
+        interface ScheduleDetails {
+          /**
+           * The schedule that generated this invoice
+           */
+          schedule: string;
+        }
+
         interface SubscriptionDetails {
           /**
            * Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.
@@ -1050,6 +1145,11 @@ declare module 'stripe' {
            */
           metadata: Stripe.Metadata | null;
 
+          /**
+           * If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
+           */
+          pause_collection?: SubscriptionDetails.PauseCollection | null;
+
           /**
            * The subscription that generated this invoice
            */
@@ -1061,7 +1161,29 @@ declare module 'stripe' {
           subscription_proration_date?: number;
         }
 
-        type Type = 'quote_details' | 'subscription_details';
+        namespace SubscriptionDetails {
+          interface PauseCollection {
+            /**
+             * The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
+             */
+            behavior: PauseCollection.Behavior | null;
+
+            /**
+             * The time after which the subscription will resume collecting payments.
+             */
+            resumes_at: number | null;
+          }
+
+          namespace PauseCollection {
+            type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
+          }
+        }
+
+        type Type =
+          | 'billing_cadence_details'
+          | 'quote_details'
+          | 'schedule_details'
+          | 'subscription_details';
       }
 
       interface PaymentSettings {
@@ -1103,16 +1225,31 @@ declare module 'stripe' {
            */
           customer_balance: PaymentMethodOptions.CustomerBalance | null;
 
+          /**
+           * If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
+           */
+          id_bank_transfer?: PaymentMethodOptions.IdBankTransfer | null;
+
           /**
            * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
            */
           konbini: PaymentMethodOptions.Konbini | null;
 
+          /**
+           * If paying by `pix`, this sub-hash contains details about the Pix payment method options to pass to the invoice's PaymentIntent.
+           */
+          pix?: PaymentMethodOptions.Pix | null;
+
           /**
            * 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: PaymentMethodOptions.SepaDebit | null;
 
+          /**
+           * If paying by `upi`, this sub-hash contains details about the UPI payment method options to pass to the invoice's PaymentIntent.
+           */
+          upi?: PaymentMethodOptions.Upi | null;
+
           /**
            * 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.
            */
@@ -1208,10 +1345,55 @@ declare module 'stripe' {
             }
           }
 
+          interface IdBankTransfer {}
+
           interface Konbini {}
 
+          interface Pix {
+            /**
+             * Determines if the amount includes the IOF tax.
+             */
+            amount_includes_iof: Pix.AmountIncludesIof | null;
+          }
+
+          namespace Pix {
+            type AmountIncludesIof = 'always' | 'never';
+          }
+
           interface SepaDebit {}
 
+          interface Upi {
+            mandate_options?: Upi.MandateOptions;
+          }
+
+          namespace Upi {
+            interface MandateOptions {
+              /**
+               * Amount to be charged for future payments.
+               */
+              amount: number | null;
+
+              /**
+               * One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
+               */
+              amount_type: MandateOptions.AmountType | null;
+
+              /**
+               * A description of the mandate or subscription that is meant to be displayed to the customer.
+               */
+              description: string | null;
+
+              /**
+               * End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+               */
+              end_date: number | null;
+            }
+
+            namespace MandateOptions {
+              type AmountType = 'fixed' | 'maximum';
+            }
+          }
+
           interface UsBankAccount {
             financial_connections?: UsBankAccount.FinancialConnections;
 
@@ -1242,6 +1424,11 @@ declare module 'stripe' {
                  * The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
                  */
                 account_subcategories?: Array<Filters.AccountSubcategory>;
+
+                /**
+                 * The institution to use to filter for possible accounts to link.
+                 */
+                institution?: string;
               }
 
               namespace Filters {
@@ -1254,7 +1441,11 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch = 'balances' | 'ownership' | 'transactions';
+              type Prefetch =
+                | 'balances'
+                | 'inferred_balances'
+                | 'ownership'
+                | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -1280,6 +1471,7 @@ declare module 'stripe' {
           | 'fpx'
           | 'giropay'
           | 'grabpay'
+          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
@@ -1294,12 +1486,15 @@ declare module 'stripe' {
           | 'payco'
           | 'paynow'
           | 'paypal'
+          | 'pix'
           | 'promptpay'
           | 'revolut_pay'
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
+          | 'stripe_balance'
           | 'swish'
+          | 'upi'
           | 'us_bank_account'
           | 'wechat_pay';
       }
@@ -1497,6 +1692,18 @@ declare module 'stripe' {
         discount: string | Stripe.Discount | Stripe.DeletedDiscount;
       }
 
+      interface TotalMarginAmount {
+        /**
+         * The amount, in cents (or local equivalent), of the reduction in line item amount.
+         */
+        amount: number;
+
+        /**
+         * The margin that was applied to get this margin amount.
+         */
+        margin: string | Stripe.Margin;
+      }
+
       interface TotalPretaxCreditAmount {
         /**
          * The amount, in cents (or local equivalent), of the pretax credit amount.
@@ -1516,6 +1723,11 @@ declare module 'stripe' {
          */
         discount?: string | Stripe.Discount | Stripe.DeletedDiscount;
 
+        /**
+         * The margin that was applied to get this pretax credit amount.
+         */
+        margin?: string | Stripe.Margin;
+
         /**
          * Type of the pretax credit amount referenced.
          */
@@ -1523,7 +1735,7 @@ declare module 'stripe' {
       }
 
       namespace TotalPretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount';
+        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
       }
 
       interface TotalTax {