stripe 17.3.1 → 17.4.0-beta.2

package/types/InvoiceItemsResource.d.ts

@@ -43,6 +43,11 @@ declare module 'stripe' {
        */
       invoice?: string;
 
+      /**
+       * The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+       */
+      margins?: 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`.
        */
@@ -111,12 +116,56 @@ declare module 'stripe' {
          */
         discount?: string;
 
+        /**
+         * Details to determine how long the discount should be applied for.
+         */
+        discount_end?: Discount.DiscountEnd;
+
         /**
          * ID of the promotion code to create a new discount for.
          */
         promotion_code?: string;
       }
 
+      namespace Discount {
+        interface DiscountEnd {
+          /**
+           * Time span for the redeemed discount.
+           */
+          duration?: DiscountEnd.Duration;
+
+          /**
+           * A precise Unix timestamp for the discount to end. Must be in the future.
+           */
+          timestamp?: number;
+
+          /**
+           * The type of calculation made to determine when the discount ends.
+           */
+          type: DiscountEnd.Type;
+        }
+
+        namespace DiscountEnd {
+          interface Duration {
+            /**
+             * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+             */
+            interval: Duration.Interval;
+
+            /**
+             * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
+             */
+            interval_count: number;
+          }
+
+          namespace Duration {
+            type Interval = 'day' | 'month' | 'week' | 'year';
+          }
+
+          type Type = 'duration' | 'timestamp';
+        }
+      }
+
       interface Period {
         /**
          * The end of the period, which must be greater than or equal to the start. This value is inclusive.
@@ -196,6 +245,11 @@ declare module 'stripe' {
        */
       expand?: Array<string>;
 
+      /**
+       * The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+       */
+      margins?: Stripe.Emptyable<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`.
        */
@@ -259,12 +313,56 @@ declare module 'stripe' {
          */
         discount?: string;
 
+        /**
+         * Details to determine how long the discount should be applied for.
+         */
+        discount_end?: Discount.DiscountEnd;
+
         /**
          * ID of the promotion code to create a new discount for.
          */
         promotion_code?: string;
       }
 
+      namespace Discount {
+        interface DiscountEnd {
+          /**
+           * Time span for the redeemed discount.
+           */
+          duration?: DiscountEnd.Duration;
+
+          /**
+           * A precise Unix timestamp for the discount to end. Must be in the future.
+           */
+          timestamp?: number;
+
+          /**
+           * The type of calculation made to determine when the discount ends.
+           */
+          type: DiscountEnd.Type;
+        }
+
+        namespace DiscountEnd {
+          interface Duration {
+            /**
+             * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+             */
+            interval: Duration.Interval;
+
+            /**
+             * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
+             */
+            interval_count: number;
+          }
+
+          namespace Duration {
+            type Interval = 'day' | 'month' | 'week' | 'year';
+          }
+
+          type Type = 'duration' | 'timestamp';
+        }
+      }
+
       interface Period {
         /**
          * The end of the period, which must be greater than or equal to the start. This value is inclusive.

package/types/InvoiceLineItems.d.ts

@@ -68,6 +68,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.
        */
@@ -149,6 +159,18 @@ 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 Period {
         /**
          * The end of the period, which must be greater than or equal to the start. This value is inclusive.
@@ -180,6 +202,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.
          */
@@ -187,7 +214,7 @@ declare module 'stripe' {
       }
 
       namespace PretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount';
+        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
       }
 
       interface ProrationDetails {

package/types/InvoicePayments.d.ts

@@ -0,0 +1,113 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The invoice payment object
+     */
+    interface InvoicePayment {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'invoice_payment';
+
+      /**
+       * Excess payment that was received for this invoice and credited to the customer's `invoice_credit_balance`. This field is null until the payment is `paid`. Overpayment can happen when you attach more than one PaymentIntent to the invoice, and each of them succeeds. To avoid overpayment, cancel any PaymentIntents that you do not need before attaching more.
+       */
+      amount_overpaid: number | null;
+
+      /**
+       * Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent's `amount_received` is not sufficient to pay all of the invoices that it is attached to.
+       */
+      amount_paid: number | null;
+
+      /**
+       * Amount intended to be paid toward this invoice, in cents (or local equivalent)
+       */
+      amount_requested: number;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: 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;
+
+      /**
+       * The invoice that was paid.
+       */
+      invoice: string | Stripe.Invoice | Stripe.DeletedInvoice;
+
+      /**
+       * Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice's `amount_remaining`. The PaymentIntent associated with the default payment can't be edited or canceled directly.
+       */
+      is_default: boolean | null;
+
+      /**
+       * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+       */
+      livemode: boolean;
+
+      payment: InvoicePayment.Payment;
+
+      /**
+       * The status of the payment, one of `open`, `paid`, or `canceled`.
+       */
+      status: string;
+
+      status_transitions: InvoicePayment.StatusTransitions;
+    }
+
+    namespace InvoicePayment {
+      interface Payment {
+        /**
+         * ID of the successful charge for this payment when `type` is `charge`.
+         */
+        charge?: string | Stripe.Charge;
+
+        /**
+         * ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019.
+         */
+        payment_intent?: string | Stripe.PaymentIntent;
+
+        /**
+         * ID of the PaymentRecord associated with this payment when `type` is `payment_record`.
+         */
+        payment_record?: string | Stripe.PaymentRecord;
+
+        /**
+         * Type of payment object associated with this invoice payment.
+         */
+        type: Payment.Type;
+      }
+
+      namespace Payment {
+        type Type =
+          | 'charge'
+          | 'out_of_band_payment'
+          | 'payment_intent'
+          | 'payment_record';
+      }
+
+      interface StatusTransitions {
+        /**
+         * The time that the payment was canceled.
+         */
+        canceled_at: number | null;
+
+        /**
+         * The time that the payment succeeded.
+         */
+        paid_at: number | null;
+      }
+    }
+  }
+}

package/types/Invoices.d.ts

@@ -89,6 +89,11 @@ declare module 'stripe' {
        */
       amount_due: number;
 
+      /**
+       * Amount that was overpaid on the invoice. Overpayments are debited to the customer's credit balance.
+       */
+      amount_overpaid?: number;
+
       /**
        * The amount, in cents (or local equivalent), that was paid.
        */
@@ -104,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.
        */
@@ -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.
        */
@@ -347,6 +362,11 @@ declare module 'stripe' {
 
       payment_settings: Invoice.PaymentSettings;
 
+      /**
+       * Payments for this invoice
+       */
+      payments?: ApiList<Stripe.InvoicePayment>;
+
       /**
        * End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](https://stripe.com/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
        */
@@ -461,6 +481,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.
        */
@@ -485,6 +510,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 {
         /**
          * 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.
@@ -563,7 +634,7 @@ declare module 'stripe' {
 
       interface CustomerTaxId {
         /**
-         * The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`
+         * The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, or `unknown`
          */
         type: CustomerTaxId.Type;
 
@@ -621,6 +692,7 @@ declare module 'stripe' {
           | 'kr_brn'
           | 'kz_bin'
           | 'li_uid'
+          | 'li_vat'
           | 'ma_vat'
           | 'md_vat'
           | 'mx_rfc'
@@ -846,11 +918,15 @@ declare module 'stripe' {
           | 'email_invalid'
           | 'expired_card'
           | 'financial_connections_account_inactive'
+          | 'financial_connections_institution_unavailable'
           | 'financial_connections_no_successful_transaction_refresh'
           | 'forwarding_api_inactive'
           | 'forwarding_api_invalid_parameter'
           | 'forwarding_api_upstream_connection_error'
           | 'forwarding_api_upstream_connection_timeout'
+          | 'gift_card_balance_insufficient'
+          | 'gift_card_code_exists'
+          | 'gift_card_inactive'
           | 'idempotency_key_in_use'
           | 'incorrect_address'
           | 'incorrect_cvc'
@@ -940,6 +1016,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'
@@ -957,6 +1034,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'
@@ -1017,6 +1095,11 @@ 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.
            */
@@ -1122,6 +1205,8 @@ declare module 'stripe' {
             }
           }
 
+          interface IdBankTransfer {}
+
           interface Konbini {}
 
           interface SepaDebit {}
@@ -1156,6 +1241,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 {
@@ -1168,7 +1258,11 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch = 'balances' | 'ownership' | 'transactions';
+              type Prefetch =
+                | 'balances'
+                | 'inferred_balances'
+                | 'ownership'
+                | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -1186,11 +1280,13 @@ declare module 'stripe' {
           | 'boleto'
           | 'card'
           | 'cashapp'
+          | 'custom'
           | 'customer_balance'
           | 'eps'
           | 'fpx'
           | 'giropay'
           | 'grabpay'
+          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
@@ -1374,6 +1470,29 @@ declare module 'stripe' {
          *  *Note: This attribute is populated only for invoices created on or after June 29, 2023.*
          */
         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/billing/subscriptions/pause-payment).
+         */
+        pause_collection?: SubscriptionDetails.PauseCollection | null;
+      }
+
+      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;
+
+          /**
+           * The time after which the subscription will resume collecting payments.
+           */
+          resumes_at: number | null;
+        }
+
+        namespace PauseCollection {
+          type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
+        }
       }
 
       interface ThresholdReason {
@@ -1414,6 +1533,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.
@@ -1433,6 +1564,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.
          */
@@ -1440,7 +1576,7 @@ declare module 'stripe' {
       }
 
       namespace TotalPretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount';
+        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
       }
 
       interface TotalTaxAmount {