stripe 17.2.1 → 17.3.0-beta.1

package/types/PaymentMethodsResource.d.ts

@@ -28,6 +28,11 @@ declare module 'stripe' {
        */
       allow_redisplay?: PaymentMethodCreateParams.AllowRedisplay;
 
+      /**
+       * If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
+       */
+      alma?: PaymentMethodCreateParams.Alma;
+
       /**
        * If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
        */
@@ -103,6 +108,11 @@ declare module 'stripe' {
        */
       giropay?: PaymentMethodCreateParams.Giropay;
 
+      /**
+       * If this is a Gopay PaymentMethod, this hash contains details about the Gopay payment method.
+       */
+      gopay?: PaymentMethodCreateParams.Gopay;
+
       /**
        * If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
        */
@@ -118,6 +128,11 @@ declare module 'stripe' {
        */
       interac_present?: PaymentMethodCreateParams.InteracPresent;
 
+      /**
+       * If this is a `kakao_pay` PaymentMethod, this hash contains details about the Kakao Pay payment method.
+       */
+      kakao_pay?: PaymentMethodCreateParams.KakaoPay;
+
       /**
        * If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
        */
@@ -128,11 +143,21 @@ declare module 'stripe' {
        */
       konbini?: PaymentMethodCreateParams.Konbini;
 
+      /**
+       * If this is a `kr_card` PaymentMethod, this hash contains details about the Korean Card payment method.
+       */
+      kr_card?: PaymentMethodCreateParams.KrCard;
+
       /**
        * If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
        */
       link?: PaymentMethodCreateParams.Link;
 
+      /**
+       * If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
+       */
+      mb_way?: PaymentMethodCreateParams.MbWay;
+
       /**
        * 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`.
        */
@@ -148,6 +173,11 @@ declare module 'stripe' {
        */
       multibanco?: PaymentMethodCreateParams.Multibanco;
 
+      /**
+       * If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
+       */
+      naver_pay?: PaymentMethodCreateParams.NaverPay;
+
       /**
        * If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
        */
@@ -158,6 +188,11 @@ declare module 'stripe' {
        */
       p24?: PaymentMethodCreateParams.P24;
 
+      /**
+       * If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method.
+       */
+      payco?: PaymentMethodCreateParams.Payco;
+
       /**
        * The PaymentMethod to share.
        */
@@ -173,6 +208,11 @@ declare module 'stripe' {
        */
       paypal?: PaymentMethodCreateParams.Paypal;
 
+      /**
+       * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+       */
+      payto?: PaymentMethodCreateParams.Payto;
+
       /**
        * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
        */
@@ -183,21 +223,41 @@ declare module 'stripe' {
        */
       promptpay?: PaymentMethodCreateParams.Promptpay;
 
+      /**
+       * If this is a `qris` PaymentMethod, this hash contains details about the QRIS payment method.
+       */
+      qris?: PaymentMethodCreateParams.Qris;
+
       /**
        * Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
        */
       radar_options?: PaymentMethodCreateParams.RadarOptions;
 
+      /**
+       * If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
+       */
+      rechnung?: PaymentMethodCreateParams.Rechnung;
+
       /**
        * If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
        */
       revolut_pay?: PaymentMethodCreateParams.RevolutPay;
 
+      /**
+       * If this is a `samsung_pay` PaymentMethod, this hash contains details about the SamsungPay payment method.
+       */
+      samsung_pay?: PaymentMethodCreateParams.SamsungPay;
+
       /**
        * If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
        */
       sepa_debit?: PaymentMethodCreateParams.SepaDebit;
 
+      /**
+       * If this is a Shopeepay PaymentMethod, this hash contains details about the Shopeepay payment method.
+       */
+      shopeepay?: PaymentMethodCreateParams.Shopeepay;
+
       /**
        * If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
        */
@@ -260,6 +320,8 @@ declare module 'stripe' {
 
       type AllowRedisplay = 'always' | 'limited' | 'unspecified';
 
+      interface Alma {}
+
       interface AmazonPay {}
 
       interface AuBecsDebit {
@@ -449,11 +511,13 @@ declare module 'stripe' {
 
       interface Giropay {}
 
+      interface Gopay {}
+
       interface Grabpay {}
 
       interface Ideal {
         /**
-         * The customer's bank.
+         * The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
          */
         bank?: Ideal.Bank;
       }
@@ -480,6 +544,8 @@ declare module 'stripe' {
 
       interface InteracPresent {}
 
+      interface KakaoPay {}
+
       interface Klarna {
         /**
          * Customer's date of birth
@@ -508,12 +574,27 @@ declare module 'stripe' {
 
       interface Konbini {}
 
+      interface KrCard {}
+
       interface Link {}
 
+      interface MbWay {}
+
       interface Mobilepay {}
 
       interface Multibanco {}
 
+      interface NaverPay {
+        /**
+         * Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
+         */
+        funding?: NaverPay.Funding;
+      }
+
+      namespace NaverPay {
+        type Funding = 'card' | 'points';
+      }
+
       interface Oxxo {}
 
       interface P24 {
@@ -553,14 +634,35 @@ declare module 'stripe' {
           | 'volkswagen_bank';
       }
 
+      interface Payco {}
+
       interface Paynow {}
 
       interface Paypal {}
 
+      interface Payto {
+        /**
+         * The account number for the bank account.
+         */
+        account_number?: string;
+
+        /**
+         * Bank-State-Branch number of the bank account.
+         */
+        bsb_number?: string;
+
+        /**
+         * The PayID alias for the bank account.
+         */
+        pay_id?: string;
+      }
+
       interface Pix {}
 
       interface Promptpay {}
 
+      interface Qris {}
+
       interface RadarOptions {
         /**
          * A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
@@ -568,8 +670,36 @@ declare module 'stripe' {
         session?: string;
       }
 
+      interface Rechnung {
+        /**
+         * Customer's date of birth
+         */
+        dob: Rechnung.Dob;
+      }
+
+      namespace Rechnung {
+        interface Dob {
+          /**
+           * The day of birth, between 1 and 31.
+           */
+          day: number;
+
+          /**
+           * The month of birth, between 1 and 12.
+           */
+          month: number;
+
+          /**
+           * The four-digit year of birth.
+           */
+          year: number;
+        }
+      }
+
       interface RevolutPay {}
 
+      interface SamsungPay {}
+
       interface SepaDebit {
         /**
          * IBAN of the bank account.
@@ -577,6 +707,8 @@ declare module 'stripe' {
         iban: string;
       }
 
+      interface Shopeepay {}
+
       interface Sofort {
         /**
          * Two-letter ISO code representing the country the bank account is located in.
@@ -597,6 +729,7 @@ declare module 'stripe' {
         | 'affirm'
         | 'afterpay_clearpay'
         | 'alipay'
+        | 'alma'
         | 'amazon_pay'
         | 'au_becs_debit'
         | 'bacs_debit'
@@ -609,21 +742,32 @@ declare module 'stripe' {
         | 'eps'
         | 'fpx'
         | 'giropay'
+        | 'gopay'
         | 'grabpay'
         | 'ideal'
+        | 'kakao_pay'
         | 'klarna'
         | 'konbini'
+        | 'kr_card'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
+        | 'naver_pay'
         | 'oxxo'
         | 'p24'
+        | 'payco'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'qris'
+        | 'rechnung'
         | 'revolut_pay'
+        | 'samsung_pay'
         | 'sepa_debit'
+        | 'shopeepay'
         | 'sofort'
         | 'swish'
         | 'twint'
@@ -707,6 +851,16 @@ declare module 'stripe' {
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
+      /**
+       * If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method.
+       */
+      naver_pay?: PaymentMethodUpdateParams.NaverPay;
+
+      /**
+       * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+       */
+      payto?: PaymentMethodUpdateParams.Payto;
+
       /**
        * If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
        */
@@ -770,6 +924,34 @@ declare module 'stripe' {
 
       interface Link {}
 
+      interface NaverPay {
+        /**
+         * Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`.
+         */
+        funding?: NaverPay.Funding;
+      }
+
+      namespace NaverPay {
+        type Funding = 'card' | 'points';
+      }
+
+      interface Payto {
+        /**
+         * The account number for the bank account.
+         */
+        account_number?: string;
+
+        /**
+         * Bank-State-Branch number of the bank account.
+         */
+        bsb_number?: string;
+
+        /**
+         * The PayID alias for the bank account.
+         */
+        pay_id?: string;
+      }
+
       interface UsBankAccount {
         /**
          * Bank account holder type.
@@ -812,6 +994,7 @@ declare module 'stripe' {
         | 'affirm'
         | 'afterpay_clearpay'
         | 'alipay'
+        | 'alma'
         | 'amazon_pay'
         | 'au_becs_debit'
         | 'bacs_debit'
@@ -824,21 +1007,32 @@ declare module 'stripe' {
         | 'eps'
         | 'fpx'
         | 'giropay'
+        | 'gopay'
         | 'grabpay'
         | 'ideal'
+        | 'kakao_pay'
         | 'klarna'
         | 'konbini'
+        | 'kr_card'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
+        | 'naver_pay'
         | 'oxxo'
         | 'p24'
+        | 'payco'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'qris'
+        | 'rechnung'
         | 'revolut_pay'
+        | 'samsung_pay'
         | 'sepa_debit'
+        | 'shopeepay'
         | 'sofort'
         | 'swish'
         | 'twint'

package/types/Persons.d.ts

@@ -102,7 +102,7 @@ declare module 'stripe' {
       future_requirements?: Person.FutureRequirements | null;
 
       /**
-       * The person's gender (International regulations require either "male" or "female").
+       * The person's gender.
        */
       gender?: string | null;
 

package/types/Prices.d.ts

@@ -93,6 +93,11 @@ declare module 'stripe' {
        */
       metadata: Stripe.Metadata;
 
+      /**
+       * Subscriptions using this price will be migrated to use the new referenced price.
+       */
+      migrate_to?: Price.MigrateTo | null;
+
       /**
        * A brief description of the price, hidden from customers.
        */
@@ -239,6 +244,23 @@ declare module 'stripe' {
         preset: number | null;
       }
 
+      interface MigrateTo {
+        /**
+         * The behavior controlling at what point in the subscription lifecycle to migrate the price
+         */
+        behavior: 'at_cycle_end';
+
+        /**
+         * The unix timestamp after at which subscriptions will start to migrate to the new price.
+         */
+        effective_after: number;
+
+        /**
+         * The id of the price being migrated to
+         */
+        price: string;
+      }
+
       interface Recurring {
         /**
          * Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.

package/types/PricesResource.d.ts

@@ -372,6 +372,11 @@ declare module 'stripe' {
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
+      /**
+       * If specified, subscriptions using this price will be updated to use the new referenced price.
+       */
+      migrate_to?: Stripe.Emptyable<PriceUpdateParams.MigrateTo>;
+
       /**
        * A brief description of the price, hidden from customers.
        */
@@ -469,6 +474,23 @@ declare module 'stripe' {
         }
       }
 
+      interface MigrateTo {
+        /**
+         * The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
+         */
+        behavior: 'at_cycle_end';
+
+        /**
+         * The time after which subscriptions should start using the new price.
+         */
+        effective_after?: number;
+
+        /**
+         * The ID of the price object.
+         */
+        price: string;
+      }
+
       type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
     }
 

package/types/Products.d.ts

@@ -98,6 +98,11 @@ declare module 'stripe' {
        */
       package_dimensions: Product.PackageDimensions | null;
 
+      /**
+       * Provisioning configuration for this product.
+       */
+      provisioning?: Product.Provisioning | null;
+
       /**
        * Whether this product is shipped (i.e., physical goods).
        */
@@ -164,6 +169,40 @@ declare module 'stripe' {
         width: number;
       }
 
+      interface Provisioning {
+        gift_card: Provisioning.GiftCard | null;
+
+        /**
+         * The type of provisioning, only `gift_card` currently supported.
+         */
+        type: 'gift_card';
+      }
+
+      namespace Provisioning {
+        interface GiftCard {
+          fixed_amount: GiftCard.FixedAmount | null;
+
+          /**
+           * The specific type of gift_card provisioning, only `fixed_amount` currently supported.
+           */
+          type: 'fixed_amount';
+        }
+
+        namespace GiftCard {
+          interface FixedAmount {
+            /**
+             * The initial amount with which the provisioned gift card will be created.
+             */
+            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;
+          }
+        }
+      }
+
       type Type = 'good' | 'service';
     }
   }

package/types/ProductsResource.d.ts

@@ -53,6 +53,11 @@ declare module 'stripe' {
        */
       package_dimensions?: ProductCreateParams.PackageDimensions;
 
+      /**
+       * Provisioning configuration for this product.
+       */
+      provisioning?: ProductCreateParams.Provisioning;
+
       /**
        * Whether this product is shipped (i.e., physical goods).
        */
@@ -278,6 +283,37 @@ declare module 'stripe' {
         width: number;
       }
 
+      interface Provisioning {
+        gift_card?: Provisioning.GiftCard;
+
+        /**
+         * The type of provisioning, only `gift_card` currently supported.
+         */
+        type: 'gift_card';
+      }
+
+      namespace Provisioning {
+        interface GiftCard {
+          fixed_amount?: GiftCard.FixedAmount;
+
+          /**
+           * The specific type of gift_card provisioning, only `fixed_amount` currently supported.
+           */
+          type: 'fixed_amount';
+        }
+
+        namespace GiftCard {
+          interface FixedAmount {
+            /**
+             * The initial amount with which the provisioned gift card will be created.
+             */
+            amount: number;
+
+            currency: string;
+          }
+        }
+      }
+
       type Type = 'good' | 'service';
     }