stripe 18.5.0-beta.2 → 18.6.0-alpha.1

package/types/Charges.d.ts

@@ -325,7 +325,7 @@ declare module 'stripe' {
         network_advice_code: string | null;
 
         /**
-         * For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed.
+         * For charges declined by the network, an alphanumeric code which indicates the reason the charge failed.
          */
         network_decline_code: string | null;
 
@@ -335,7 +335,7 @@ declare module 'stripe' {
         network_status: string | null;
 
         /**
-         * An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.
+         * An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.
          */
         reason: string | null;
 
@@ -661,10 +661,31 @@ declare module 'stripe' {
           transaction_id: string | null;
         }
 
-        interface Alma {}
+        interface Alma {
+          installments?: Alma.Installments;
+
+          /**
+           * The Alma transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
+        }
+
+        namespace Alma {
+          interface Installments {
+            /**
+             * The number of installments.
+             */
+            count: number;
+          }
+        }
 
         interface AmazonPay {
           funding?: AmazonPay.Funding;
+
+          /**
+           * The Amazon Pay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         namespace AmazonPay {
@@ -809,7 +830,12 @@ declare module 'stripe' {
           type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
         }
 
-        interface Billie {}
+        interface Billie {
+          /**
+           * The Billie transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
+        }
 
         interface Blik {
           /**
@@ -1906,6 +1932,11 @@ declare module 'stripe' {
            * A unique identifier for the buyer as determined by the local payment processor.
            */
           buyer_id: string | null;
+
+          /**
+           * The Kakao Pay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         interface Klarna {
@@ -1980,6 +2011,11 @@ declare module 'stripe' {
            * The last four digits of the card. This may not be present for American Express cards.
            */
           last4: string | null;
+
+          /**
+           * The Korean Card transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         namespace KrCard {
@@ -2071,6 +2107,11 @@ declare module 'stripe' {
            * A unique identifier for the buyer as determined by the local payment processor.
            */
           buyer_id: string | null;
+
+          /**
+           * The Naver Pay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         interface NzBankAccount {
@@ -2168,6 +2209,11 @@ declare module 'stripe' {
            * A unique identifier for the buyer as determined by the local payment processor.
            */
           buyer_id: string | null;
+
+          /**
+           * The Payco transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         interface Paynow {
@@ -2284,6 +2330,11 @@ declare module 'stripe' {
            * Unique transaction id generated by BCB
            */
           bank_transaction_id?: string | null;
+
+          /**
+           * ID of the multi use Mandate generated by the PaymentIntent
+           */
+          mandate?: string;
         }
 
         interface Promptpay {
@@ -2299,6 +2350,11 @@ declare module 'stripe' {
 
         interface RevolutPay {
           funding?: RevolutPay.Funding;
+
+          /**
+           * The Revolut Pay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
         namespace RevolutPay {
@@ -2356,9 +2412,19 @@ declare module 'stripe' {
            * A unique identifier for the buyer as determined by the local payment processor.
            */
           buyer_id: string | null;
+
+          /**
+           * The Samsung Pay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
         }
 
-        interface Satispay {}
+        interface Satispay {
+          /**
+           * The Satispay transaction ID associated with this payment.
+           */
+          transaction_id: string | null;
+        }
 
         interface SepaCreditTransfer {
           /**

package/types/Checkout/Sessions.d.ts

@@ -67,6 +67,8 @@ declare module 'stripe' {
          */
         cancel_url: string | null;
 
+        checkout_items?: Array<Session.CheckoutItem>;
+
         /**
          * A unique string to reference the Checkout Session. This can be a
          * customer ID, a cart ID, or similar, and can be used to reconcile the
@@ -343,7 +345,7 @@ declare module 'stripe' {
       namespace Session {
         interface AdaptivePricing {
           /**
-           * Whether Adaptive Pricing is enabled.
+           * If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions).
            */
           enabled: boolean;
         }
@@ -425,6 +427,62 @@ declare module 'stripe' {
 
         type BillingAddressCollection = 'auto' | 'required';
 
+        interface CheckoutItem {
+          type: CheckoutItem.Type;
+
+          rate_card_subscription_item?: CheckoutItem.RateCardSubscriptionItem;
+
+          pricing_plan_subscription_item?: CheckoutItem.PricingPlanSubscriptionItem;
+        }
+
+        namespace CheckoutItem {
+          interface PricingPlanSubscriptionItem {
+            pricing_plan: string;
+
+            pricing_plan_version: string;
+
+            metadata: Stripe.Metadata;
+
+            component_configurations: {
+              [key: string]: PricingPlanSubscriptionItem.ComponentConfigurations;
+            };
+
+            pricing_plan_subscription?: string;
+
+            billing_cadence?: string;
+          }
+
+          namespace PricingPlanSubscriptionItem {
+            interface ComponentConfigurations {
+              type: 'license_fee_component';
+
+              license_fee_component?: ComponentConfigurations.LicenseFeeComponent;
+            }
+
+            namespace ComponentConfigurations {
+              interface LicenseFeeComponent {
+                quantity: number;
+              }
+            }
+          }
+
+          interface RateCardSubscriptionItem {
+            rate_card: string;
+
+            metadata: Stripe.Metadata;
+
+            rate_card_version: string;
+
+            billing_cadence?: string;
+
+            rate_card_subscription?: string;
+          }
+
+          type Type =
+            | 'rate_card_subscription_item'
+            | 'pricing_plan_subscription_item';
+        }
+
         interface CollectedInformation {
           /**
            * Customer's business name for this Checkout Session
@@ -2043,11 +2101,18 @@ declare module 'stripe' {
           }
 
           interface Pix {
+            /**
+             * Determines if the amount includes the IOF tax.
+             */
+            amount_includes_iof?: Pix.AmountIncludesIof;
+
             /**
              * The number of seconds after which Pix payment will expire.
              */
             expires_after_seconds: number | null;
 
+            mandate_options?: Pix.MandateOptions;
+
             /**
              * Indicates that you intend to make future payments with this PaymentIntent's payment method.
              *
@@ -2057,7 +2122,68 @@ declare module 'stripe' {
              *
              * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
              */
-            setup_future_usage?: 'none';
+            setup_future_usage?: Pix.SetupFutureUsage;
+          }
+
+          namespace Pix {
+            type AmountIncludesIof = 'always' | 'never';
+
+            interface MandateOptions {
+              /**
+               * Amount to be charged for future payments.
+               */
+              amount?: number;
+
+              /**
+               * Determines if the amount includes the IOF tax.
+               */
+              amount_includes_iof?: MandateOptions.AmountIncludesIof;
+
+              /**
+               * Type of amount.
+               */
+              amount_type?: MandateOptions.AmountType;
+
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+               */
+              currency?: string;
+
+              /**
+               * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
+               */
+              end_date?: string;
+
+              /**
+               * Schedule at which the future payments will be charged.
+               */
+              payment_schedule?: MandateOptions.PaymentSchedule;
+
+              /**
+               * Subscription name displayed to buyers in their bank app.
+               */
+              reference?: string;
+
+              /**
+               * Start date of the mandate, in `YYYY-MM-DD`.
+               */
+              start_date?: string;
+            }
+
+            namespace MandateOptions {
+              type AmountIncludesIof = 'always' | 'never';
+
+              type AmountType = 'fixed' | 'maximum';
+
+              type PaymentSchedule =
+                | 'halfyearly'
+                | 'monthly'
+                | 'quarterly'
+                | 'weekly'
+                | 'yearly';
+            }
+
+            type SetupFutureUsage = 'none' | 'off_session';
           }
 
           interface RevolutPay {

package/types/Checkout/SessionsResource.d.ts

@@ -34,6 +34,8 @@ declare module 'stripe' {
          */
         cancel_url?: string;
 
+        checkout_items?: Array<SessionCreateParams.CheckoutItem>;
+
         /**
          * A unique string to reference the Checkout Session. This can be a
          * customer ID, a cart ID, or similar, and can be used to reconcile the
@@ -164,7 +166,7 @@ declare module 'stripe' {
         optional_items?: Array<SessionCreateParams.OptionalItem>;
 
         /**
-         * Where the user is coming from. This informs the optimizations that are applied to the session. For example, a session originating from a mobile app may behave more like a native app, depending on the platform. This parameter is currently not allowed if `ui_mode` is `custom`.
+         * Where the user is coming from. This informs the optimizations that are applied to the session.
          */
         origin_context?: SessionCreateParams.OriginContext;
 
@@ -301,7 +303,7 @@ declare module 'stripe' {
       namespace SessionCreateParams {
         interface AdaptivePricing {
           /**
-           * Set to `true` to enable [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
+           * If set to `true`, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
            */
           enabled?: boolean;
         }
@@ -363,6 +365,54 @@ declare module 'stripe' {
 
         type BillingAddressCollection = 'auto' | 'required';
 
+        interface CheckoutItem {
+          type: CheckoutItem.Type;
+
+          rate_card_subscription_item?: CheckoutItem.RateCardSubscriptionItem;
+
+          pricing_plan_subscription_item?: CheckoutItem.PricingPlanSubscriptionItem;
+        }
+
+        namespace CheckoutItem {
+          interface PricingPlanSubscriptionItem {
+            pricing_plan: string;
+
+            pricing_plan_version?: string;
+
+            metadata?: Stripe.MetadataParam;
+
+            component_configurations?: {
+              [key: string]: PricingPlanSubscriptionItem.ComponentConfigurations;
+            };
+          }
+
+          namespace PricingPlanSubscriptionItem {
+            interface ComponentConfigurations {
+              type: 'license_fee_component';
+
+              license_fee_component?: ComponentConfigurations.LicenseFeeComponent;
+            }
+
+            namespace ComponentConfigurations {
+              interface LicenseFeeComponent {
+                quantity: number;
+              }
+            }
+          }
+
+          interface RateCardSubscriptionItem {
+            rate_card: string;
+
+            metadata?: Stripe.MetadataParam;
+
+            rate_card_version?: string;
+          }
+
+          type Type =
+            | 'rate_card_subscription_item'
+            | 'pricing_plan_subscription_item';
+        }
+
         interface ConsentCollection {
           /**
            * Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
@@ -603,12 +653,55 @@ declare module 'stripe' {
            */
           coupon?: string;
 
+          /**
+           * Data used to generate a new [Coupon](https://stripe.com/docs/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
+           */
+          coupon_data?: Discount.CouponData;
+
           /**
            * The ID of a promotion code to apply to this Session.
            */
           promotion_code?: string;
         }
 
+        namespace Discount {
+          interface CouponData {
+            /**
+             * A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
+             */
+            amount_off?: number;
+
+            /**
+             * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
+             */
+            currency?: string;
+
+            /**
+             * Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
+             */
+            duration?: CouponData.Duration;
+
+            /**
+             * 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>;
+
+            /**
+             * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+             */
+            name?: string;
+
+            /**
+             * A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
+             */
+            percent_off?: number;
+          }
+
+          namespace CouponData {
+            type Duration = 'forever' | 'once' | 'repeating';
+          }
+        }
+
         interface InvoiceCreation {
           /**
            * Set to `true` to enable invoice creation.
@@ -2164,11 +2257,21 @@ declare module 'stripe' {
           }
 
           interface Pix {
+            /**
+             * Determines if the amount includes the IOF tax. Defaults to `never`.
+             */
+            amount_includes_iof?: Pix.AmountIncludesIof;
+
             /**
              * The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
              */
             expires_after_seconds?: number;
 
+            /**
+             * Additional fields for mandate creation.
+             */
+            mandate_options?: Pix.MandateOptions;
+
             /**
              * Indicates that you intend to make future payments with this PaymentIntent's payment method.
              *
@@ -2178,7 +2281,68 @@ declare module 'stripe' {
              *
              * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
              */
-            setup_future_usage?: 'none';
+            setup_future_usage?: Pix.SetupFutureUsage;
+          }
+
+          namespace Pix {
+            type AmountIncludesIof = 'always' | 'never';
+
+            interface MandateOptions {
+              /**
+               * Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
+               */
+              amount?: number;
+
+              /**
+               * Determines if the amount includes the IOF tax. Defaults to `never`.
+               */
+              amount_includes_iof?: MandateOptions.AmountIncludesIof;
+
+              /**
+               * Type of amount. Defaults to `maximum`.
+               */
+              amount_type?: MandateOptions.AmountType;
+
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
+               */
+              currency?: string;
+
+              /**
+               * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+               */
+              end_date?: string;
+
+              /**
+               * Schedule at which the future payments will be charged. Defaults to `weekly`.
+               */
+              payment_schedule?: MandateOptions.PaymentSchedule;
+
+              /**
+               * Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
+               */
+              reference?: string;
+
+              /**
+               * Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
+               */
+              start_date?: string;
+            }
+
+            namespace MandateOptions {
+              type AmountIncludesIof = 'always' | 'never';
+
+              type AmountType = 'fixed' | 'maximum';
+
+              type PaymentSchedule =
+                | 'halfyearly'
+                | 'monthly'
+                | 'quarterly'
+                | 'weekly'
+                | 'yearly';
+            }
+
+            type SetupFutureUsage = 'none' | 'off_session';
           }
 
           interface RevolutPay {

package/types/CreditNotesResource.d.ts

@@ -158,7 +158,7 @@ declare module 'stripe' {
         amount_refunded?: number;
 
         /**
-         * ID of an existing refund to link this credit note to.
+         * ID of an existing refund to link this credit note to. Required when `type` is `refund`.
          */
         refund?: string;
       }
@@ -385,7 +385,7 @@ declare module 'stripe' {
         amount_refunded?: number;
 
         /**
-         * ID of an existing refund to link this credit note to.
+         * ID of an existing refund to link this credit note to. Required when `type` is `refund`.
          */
         refund?: string;
       }
@@ -554,7 +554,7 @@ declare module 'stripe' {
         amount_refunded?: number;
 
         /**
-         * ID of an existing refund to link this credit note to.
+         * ID of an existing refund to link this credit note to. Required when `type` is `refund`.
          */
         refund?: string;
       }

package/types/Disputes.d.ts

@@ -89,7 +89,7 @@ declare module 'stripe' {
       smart_disputes?: Dispute.SmartDisputes;
 
       /**
-       * Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`.
+       * The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.
        */
       status: Dispute.Status;
     }
@@ -479,7 +479,12 @@ declare module 'stripe' {
         }
 
         namespace Card {
-          type CaseType = 'chargeback' | 'compliance' | 'inquiry';
+          type CaseType =
+            | 'block'
+            | 'chargeback'
+            | 'compliance'
+            | 'inquiry'
+            | 'resolution';
         }
 
         interface Klarna {