stripe 18.1.0-beta.2 → 18.1.0-beta.3

package/types/InvoicesResource.d.ts

@@ -602,6 +602,7 @@ declare module 'stripe' {
           | 'ach_credit_transfer'
           | 'ach_debit'
           | 'acss_debit'
+          | 'affirm'
           | 'amazon_pay'
           | 'au_becs_debit'
           | 'bacs_debit'
@@ -1415,6 +1416,7 @@ declare module 'stripe' {
           | 'ach_credit_transfer'
           | 'ach_debit'
           | 'acss_debit'
+          | 'affirm'
           | 'amazon_pay'
           | 'au_becs_debit'
           | 'bacs_debit'
@@ -2118,23 +2120,6 @@ declare module 'stripe' {
       }
     }
 
-    interface InvoiceAttachPaymentIntentParams {
-      /**
-       * The ID of the PaymentIntent to attach to the invoice.
-       */
-      payment_intent: string;
-
-      /**
-       * The portion of the PaymentIntent's `amount` that should be applied to thisinvoice. Defaults to the entire amount.
-       */
-      amount_requested?: number;
-
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-    }
-
     interface InvoiceCreatePreviewParams {
       /**
        * Settings for automatic tax lookup for this invoice preview.
@@ -4251,13 +4236,6 @@ declare module 'stripe' {
       expand?: Array<string>;
     }
 
-    interface InvoiceListPaymentsParams extends PaginationParams {
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-    }
-
     interface InvoiceMarkUncollectibleParams {
       /**
        * Specifies which fields in the response should be expanded.
@@ -4341,13 +4319,6 @@ declare module 'stripe' {
       }
     }
 
-    interface InvoiceRetrievePaymentParams {
-      /**
-       * Specifies which fields in the response should be expanded.
-       */
-      expand?: Array<string>;
-    }
-
     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).
@@ -5158,23 +5129,6 @@ declare module 'stripe' {
         options?: RequestOptions
       ): Promise<Stripe.Response<Stripe.Invoice>>;
 
-      /**
-       * Attaches a PaymentIntent to the invoice, adding it to the list of payments.
-       * When the PaymentIntent's status changes to succeeded, the payment is credited
-       * to the invoice, increasing its amount_paid. When the invoice is fully paid, the
-       * invoice's status becomes paid.
-       *
-       * If the PaymentIntent's status is already succeeded when it is attached, it is
-       * credited to the invoice immediately.
-       *
-       * Related guide: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create)
-       */
-      attachPaymentIntent(
-        id: string,
-        params: InvoiceAttachPaymentIntentParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.Invoice>>;
-
       /**
        * At any time, you can preview the upcoming invoice for a subscription or subscription schedule. 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.
        *
@@ -5218,19 +5172,6 @@ declare module 'stripe' {
         options?: RequestOptions
       ): ApiListPromise<Stripe.InvoiceLineItem>;
 
-      /**
-       * When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
-       */
-      listPayments(
-        id: string,
-        params?: InvoiceListPaymentsParams,
-        options?: RequestOptions
-      ): ApiListPromise<Stripe.InvoicePayment>;
-      listPayments(
-        id: string,
-        options?: RequestOptions
-      ): ApiListPromise<Stripe.InvoicePayment>;
-
       /**
        * Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
        */
@@ -5266,21 +5207,6 @@ declare module 'stripe' {
         options?: RequestOptions
       ): Promise<Stripe.Response<Stripe.Invoice>>;
 
-      /**
-       * Retrieves the invoice payment with the given ID.
-       */
-      retrievePayment(
-        invoiceId: string,
-        id: string,
-        params?: InvoiceRetrievePaymentParams,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.InvoicePayment>>;
-      retrievePayment(
-        invoiceId: string,
-        id: string,
-        options?: RequestOptions
-      ): Promise<Stripe.Response<Stripe.InvoicePayment>>;
-
       /**
        * 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

package/types/PaymentIntentAmountDetailsLineItems.d.ts

@@ -0,0 +1,110 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * The PaymentIntentAmountDetailsLineItem object.
+     */
+    interface PaymentIntentAmountDetailsLineItem {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'payment_intent_amount_details_line_item';
+
+      /**
+       * The amount an item was discounted for. Positive integer.
+       */
+      discount_amount: number | null;
+
+      /**
+       * Payment method-specific information for line items.
+       */
+      payment_method_options: PaymentIntentAmountDetailsLineItem.PaymentMethodOptions | null;
+
+      /**
+       * Unique identifier of the product. At most 12 characters long.
+       */
+      product_code: string | null;
+
+      /**
+       * Name of the product. At most 100 characters long.
+       */
+      product_name: string;
+
+      /**
+       * Number of items of the product. Positive integer.
+       */
+      quantity: number;
+
+      /**
+       * Contains information about the tax on the item.
+       */
+      tax: PaymentIntentAmountDetailsLineItem.Tax | null;
+
+      /**
+       * Cost of the product. Non-negative integer.
+       */
+      unit_cost: number;
+
+      /**
+       * A unit of measure for the line item, such as gallons, feet, meters, etc.
+       */
+      unit_of_measure: string | null;
+    }
+
+    namespace PaymentIntentAmountDetailsLineItem {
+      interface PaymentMethodOptions {
+        card?: PaymentMethodOptions.Card;
+
+        klarna?: PaymentMethodOptions.Klarna;
+
+        paypal?: PaymentMethodOptions.Paypal;
+      }
+
+      namespace PaymentMethodOptions {
+        interface Card {
+          commodity_code: string | null;
+        }
+
+        interface Klarna {
+          image_url: string | null;
+
+          product_url: string | null;
+        }
+
+        interface Paypal {
+          /**
+           * Type of the line item.
+           */
+          category?: Paypal.Category;
+
+          /**
+           * Description of the line item.
+           */
+          description?: string;
+
+          /**
+           * The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers).
+           */
+          sold_by?: string;
+        }
+
+        namespace Paypal {
+          type Category = 'digital_goods' | 'donation' | 'physical_goods';
+        }
+      }
+
+      interface Tax {
+        /**
+         * Total portion of the amount that is for tax.
+         */
+        total_tax_amount: number;
+      }
+    }
+  }
+}

package/types/PaymentIntents.d.ts

@@ -122,6 +122,11 @@ declare module 'stripe' {
        */
       description: string | null;
 
+      /**
+       * The FX Quote used for the PaymentIntent.
+       */
+      fx_quote?: string | null;
+
       /**
        * The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
        */
@@ -251,10 +256,48 @@ declare module 'stripe' {
 
     namespace PaymentIntent {
       interface AmountDetails {
+        /**
+         * The amount an item was discounted for.
+         */
+        discount_amount?: number;
+
+        /**
+         * A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 100 line items.
+         */
+        line_items?: ApiList<Stripe.PaymentIntentAmountDetailsLineItem>;
+
+        shipping?: AmountDetails.Shipping;
+
+        tax?: AmountDetails.Tax;
+
         tip?: AmountDetails.Tip;
       }
 
       namespace AmountDetails {
+        interface Shipping {
+          /**
+           * Portion of the amount that is for shipping.
+           */
+          amount: number | null;
+
+          /**
+           * The postal code that represents the shipping source.
+           */
+          from_postal_code: string | null;
+
+          /**
+           * The postal code that represents the shipping destination.
+           */
+          to_postal_code: string | null;
+        }
+
+        interface Tax {
+          /**
+           * Total portion of the amount that is for tax.
+           */
+          total_tax_amount: number | null;
+        }
+
         interface Tip {
           /**
            * Portion of the amount that corresponds to a tip.
@@ -1378,8 +1421,18 @@ declare module 'stripe' {
       interface PaymentDetails {
         car_rental?: PaymentDetails.CarRental;
 
+        /**
+         * Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
+         */
+        customer_reference?: string | null;
+
         event_details?: PaymentDetails.EventDetails;
 
+        /**
+         * A unique value assigned by the business to identify the transaction.
+         */
+        order_reference?: string | null;
+
         subscription?: PaymentDetails.Subscription;
       }
 

package/types/PaymentIntentsResource.d.ts

@@ -83,6 +83,11 @@ declare module 'stripe' {
        */
       expand?: Array<string>;
 
+      /**
+       * The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
+       */
+      fx_quote?: string;
+
       /**
        * ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
        */
@@ -312,6 +317,11 @@ declare module 'stripe' {
          */
         car_rental?: PaymentDetails.CarRental;
 
+        /**
+         * Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
+         */
+        customer_reference?: Stripe.Emptyable<string>;
+
         /**
          * Event details for this PaymentIntent
          */
@@ -327,6 +337,11 @@ declare module 'stripe' {
          */
         lodging?: PaymentDetails.Lodging;
 
+        /**
+         * A unique value assigned by the business to identify the transaction.
+         */
+        order_reference?: Stripe.Emptyable<string>;
+
         /**
          * Subscription details for this PaymentIntent
          */
@@ -1328,6 +1343,11 @@ declare module 'stripe' {
            * Billing phone number (including extension).
            */
           phone?: Stripe.Emptyable<string>;
+
+          /**
+           * Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
+           */
+          tax_id?: string;
         }
 
         interface Blik {}
@@ -4133,6 +4153,11 @@ declare module 'stripe' {
        */
       expand?: Array<string>;
 
+      /**
+       * The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
+       */
+      fx_quote?: string;
+
       /**
        * This hash contains details about the Mandate to create.
        */
@@ -4291,6 +4316,11 @@ declare module 'stripe' {
          */
         car_rental?: PaymentDetails.CarRental;
 
+        /**
+         * Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
+         */
+        customer_reference?: Stripe.Emptyable<string>;
+
         /**
          * Event details for this PaymentIntent
          */
@@ -4306,6 +4336,11 @@ declare module 'stripe' {
          */
         lodging?: PaymentDetails.Lodging;
 
+        /**
+         * A unique value assigned by the business to identify the transaction.
+         */
+        order_reference?: Stripe.Emptyable<string>;
+
         /**
          * Subscription details for this PaymentIntent
          */
@@ -5307,6 +5342,11 @@ declare module 'stripe' {
            * Billing phone number (including extension).
            */
           phone?: Stripe.Emptyable<string>;
+
+          /**
+           * Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
+           */
+          tax_id?: string;
         }
 
         interface Blik {}
@@ -8175,6 +8215,11 @@ declare module 'stripe' {
          */
         car_rental?: PaymentDetails.CarRental;
 
+        /**
+         * Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
+         */
+        customer_reference?: Stripe.Emptyable<string>;
+
         /**
          * Event details for this PaymentIntent
          */
@@ -8190,6 +8235,11 @@ declare module 'stripe' {
          */
         lodging?: PaymentDetails.Lodging;
 
+        /**
+         * A unique value assigned by the business to identify the transaction.
+         */
+        order_reference?: Stripe.Emptyable<string>;
+
         /**
          * Subscription details for this PaymentIntent
          */
@@ -8852,6 +8902,11 @@ declare module 'stripe' {
        */
       expand?: Array<string>;
 
+      /**
+       * The FX rate in the quote is validated and used to convert the presentment amount to the settlement amount.
+       */
+      fx_quote?: string;
+
       /**
        * ID of the mandate that's used for this payment.
        */
@@ -9021,6 +9076,11 @@ declare module 'stripe' {
          */
         car_rental?: PaymentDetails.CarRental;
 
+        /**
+         * Some customers might be required by their company or organization to provide this information. If so, provide this value. Otherwise you can ignore this field.
+         */
+        customer_reference?: Stripe.Emptyable<string>;
+
         /**
          * Event details for this PaymentIntent
          */
@@ -9036,6 +9096,11 @@ declare module 'stripe' {
          */
         lodging?: PaymentDetails.Lodging;
 
+        /**
+         * A unique value assigned by the business to identify the transaction.
+         */
+        order_reference?: Stripe.Emptyable<string>;
+
         /**
          * Subscription details for this PaymentIntent
          */
@@ -10037,6 +10102,11 @@ declare module 'stripe' {
            * Billing phone number (including extension).
            */
           phone?: Stripe.Emptyable<string>;
+
+          /**
+           * Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
+           */
+          tax_id?: string;
         }
 
         interface Blik {}
@@ -12927,6 +12997,14 @@ declare module 'stripe' {
       }
     }
 
+    interface PaymentIntentListAmountDetailsLineItemsParams
+      extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
     interface PaymentIntentSearchParams {
       /**
        * The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents).
@@ -13197,6 +13275,19 @@ declare module 'stripe' {
         options?: RequestOptions
       ): Promise<Stripe.Response<Stripe.PaymentIntent>>;
 
+      /**
+       * Lists all LineItems of a given PaymentIntent.
+       */
+      listAmountDetailsLineItems(
+        id: string,
+        params?: PaymentIntentListAmountDetailsLineItemsParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.PaymentIntentAmountDetailsLineItem>;
+      listAmountDetailsLineItems(
+        id: string,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.PaymentIntentAmountDetailsLineItem>;
+
       /**
        * Search for PaymentIntents 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

package/types/PaymentMethodConfigurations.d.ts

@@ -135,6 +135,8 @@ declare module 'stripe' {
 
       payto?: PaymentMethodConfiguration.Payto;
 
+      pix?: PaymentMethodConfiguration.Pix;
+
       promptpay?: PaymentMethodConfiguration.Promptpay;
 
       qris?: PaymentMethodConfiguration.Qris;
@@ -1453,6 +1455,40 @@ declare module 'stripe' {
         }
       }
 
+      interface Pix {
+        /**
+         * Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
+         */
+        available: boolean;
+
+        display_preference: Pix.DisplayPreference;
+      }
+
+      namespace Pix {
+        interface DisplayPreference {
+          /**
+           * For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
+           */
+          overridable: boolean | null;
+
+          /**
+           * The account's display preference.
+           */
+          preference: DisplayPreference.Preference;
+
+          /**
+           * The effective display preference value.
+           */
+          value: DisplayPreference.Value;
+        }
+
+        namespace DisplayPreference {
+          type Preference = 'none' | 'off' | 'on';
+
+          type Value = 'off' | 'on';
+        }
+      }
+
       interface Promptpay {
         /**
          * Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.

package/types/PaymentMethodConfigurationsResource.d.ts

@@ -213,6 +213,11 @@ declare module 'stripe' {
        */
       payto?: PaymentMethodConfigurationCreateParams.Payto;
 
+      /**
+       * Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.
+       */
+      pix?: PaymentMethodConfigurationCreateParams.Pix;
+
       /**
        * PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.
        */
@@ -1055,6 +1060,26 @@ declare module 'stripe' {
         }
       }
 
+      interface Pix {
+        /**
+         * Whether or not the payment method should be displayed.
+         */
+        display_preference?: Pix.DisplayPreference;
+      }
+
+      namespace Pix {
+        interface DisplayPreference {
+          /**
+           * The account's preference for whether or not to display this payment method.
+           */
+          preference?: DisplayPreference.Preference;
+        }
+
+        namespace DisplayPreference {
+          type Preference = 'none' | 'off' | 'on';
+        }
+      }
+
       interface Promptpay {
         /**
          * Whether or not the payment method should be displayed.
@@ -1514,6 +1539,11 @@ declare module 'stripe' {
        */
       payto?: PaymentMethodConfigurationUpdateParams.Payto;
 
+      /**
+       * Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details.
+       */
+      pix?: PaymentMethodConfigurationUpdateParams.Pix;
+
       /**
        * PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.
        */
@@ -2356,6 +2386,26 @@ declare module 'stripe' {
         }
       }
 
+      interface Pix {
+        /**
+         * Whether or not the payment method should be displayed.
+         */
+        display_preference?: Pix.DisplayPreference;
+      }
+
+      namespace Pix {
+        interface DisplayPreference {
+          /**
+           * The account's preference for whether or not to display this payment method.
+           */
+          preference?: DisplayPreference.Preference;
+        }
+
+        namespace DisplayPreference {
+          type Preference = 'none' | 'off' | 'on';
+        }
+      }
+
       interface Promptpay {
         /**
          * Whether or not the payment method should be displayed.

package/types/PaymentMethods.d.ts

@@ -272,6 +272,11 @@ declare module 'stripe' {
          * Billing phone number (including extension).
          */
         phone: string | null;
+
+        /**
+         * Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
+         */
+        tax_id: string | null;
       }
 
       interface Blik {}

package/types/PaymentMethodsResource.d.ts

@@ -402,6 +402,11 @@ declare module 'stripe' {
          * Billing phone number (including extension).
          */
         phone?: Stripe.Emptyable<string>;
+
+        /**
+         * Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
+         */
+        tax_id?: string;
       }
 
       interface Blik {}
@@ -988,6 +993,11 @@ declare module 'stripe' {
          * Billing phone number (including extension).
          */
         phone?: Stripe.Emptyable<string>;
+
+        /**
+         * Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
+         */
+        tax_id?: string;
       }
 
       interface Card {