stripe 17.3.0 → 17.4.0-beta.1

package/types/PaymentMethods.d.ts

@@ -73,8 +73,12 @@ declare module 'stripe' {
 
       giropay?: PaymentMethod.Giropay;
 
+      gopay?: PaymentMethod.Gopay;
+
       grabpay?: PaymentMethod.Grabpay;
 
+      id_bank_transfer?: PaymentMethod.IdBankTransfer;
+
       ideal?: PaymentMethod.Ideal;
 
       interac_present?: PaymentMethod.InteracPresent;
@@ -94,6 +98,8 @@ declare module 'stripe' {
        */
       livemode: boolean;
 
+      mb_way?: PaymentMethod.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.
        */
@@ -115,21 +121,29 @@ declare module 'stripe' {
 
       paypal?: PaymentMethod.Paypal;
 
+      payto?: PaymentMethod.Payto;
+
       pix?: PaymentMethod.Pix;
 
       promptpay?: PaymentMethod.Promptpay;
 
+      qris?: PaymentMethod.Qris;
+
       /**
        * Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
        */
       radar_options?: PaymentMethod.RadarOptions;
 
+      rechnung?: PaymentMethod.Rechnung;
+
       revolut_pay?: PaymentMethod.RevolutPay;
 
       samsung_pay?: PaymentMethod.SamsungPay;
 
       sepa_debit?: PaymentMethod.SepaDebit;
 
+      shopeepay?: PaymentMethod.Shopeepay;
+
       sofort?: PaymentMethod.Sofort;
 
       swish?: PaymentMethod.Swish;
@@ -940,8 +954,24 @@ declare module 'stripe' {
 
       interface Giropay {}
 
+      interface Gopay {}
+
       interface Grabpay {}
 
+      interface IdBankTransfer {
+        bank: IdBankTransfer.Bank | null;
+
+        bank_code: string | null;
+
+        bank_name: string | null;
+
+        display_name: string | null;
+      }
+
+      namespace IdBankTransfer {
+        type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+      }
+
       interface Ideal {
         /**
          * The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
@@ -1169,6 +1199,8 @@ declare module 'stripe' {
         persistent_token?: string;
       }
 
+      interface MbWay {}
+
       interface Mobilepay {}
 
       interface Multibanco {}
@@ -1228,6 +1260,11 @@ declare module 'stripe' {
       interface Paynow {}
 
       interface Paypal {
+        /**
+         * Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
+         */
+        fingerprint?: string | null;
+
         /**
          * Owner's email. Values are provided by PayPal directly
          * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
@@ -1238,12 +1275,37 @@ declare module 'stripe' {
          * PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
          */
         payer_id: string | null;
+
+        /**
+         * Owner's verified email. Values are verified or provided by PayPal directly
+         * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+         */
+        verified_email?: string | null;
+      }
+
+      interface Payto {
+        /**
+         * Bank-State-Branch number of the bank account.
+         */
+        bsb_number: string | null;
+
+        /**
+         * Last four digits of the bank account number.
+         */
+        last4: string | null;
+
+        /**
+         * The PayID alias for the bank account.
+         */
+        pay_id: string | null;
       }
 
       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.
@@ -1251,6 +1313,29 @@ declare module 'stripe' {
         session?: string;
       }
 
+      interface Rechnung {
+        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 {}
@@ -1301,6 +1386,8 @@ declare module 'stripe' {
         }
       }
 
+      interface Shopeepay {}
+
       interface Sofort {
         /**
          * Two-letter ISO code representing the country the bank account is located in.
@@ -1331,7 +1418,9 @@ declare module 'stripe' {
         | 'eps'
         | 'fpx'
         | 'giropay'
+        | 'gopay'
         | 'grabpay'
+        | 'id_bank_transfer'
         | 'ideal'
         | 'interac_present'
         | 'kakao_pay'
@@ -1339,6 +1428,7 @@ declare module 'stripe' {
         | 'konbini'
         | 'kr_card'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
         | 'naver_pay'
@@ -1347,11 +1437,15 @@ declare module 'stripe' {
         | 'payco'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'qris'
+        | 'rechnung'
         | 'revolut_pay'
         | 'samsung_pay'
         | 'sepa_debit'
+        | 'shopeepay'
         | 'sofort'
         | 'swish'
         | 'twint'
@@ -1365,6 +1459,11 @@ declare module 'stripe' {
          */
         account_holder_type: UsBankAccount.AccountHolderType | null;
 
+        /**
+         * Account number of the bank account.
+         */
+        account_number?: string | null;
+
         /**
          * Account type: checkings or savings. Defaults to checking if omitted.
          */

package/types/PaymentMethodsResource.d.ts

@@ -108,11 +108,21 @@ 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.
        */
       grabpay?: PaymentMethodCreateParams.Grabpay;
 
+      /**
+       * If this is an `IdBankTransfer` PaymentMethod, this hash contains details about the IdBankTransfer payment method.
+       */
+      id_bank_transfer?: PaymentMethodCreateParams.IdBankTransfer;
+
       /**
        * If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
        */
@@ -148,6 +158,11 @@ declare module 'stripe' {
        */
       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`.
        */
@@ -198,6 +213,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.
        */
@@ -208,11 +228,21 @@ 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.
        */
@@ -228,6 +258,11 @@ declare module 'stripe' {
        */
       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.
        */
@@ -481,8 +516,21 @@ declare module 'stripe' {
 
       interface Giropay {}
 
+      interface Gopay {}
+
       interface Grabpay {}
 
+      interface IdBankTransfer {
+        /**
+         * Bank where the account is held.
+         */
+        bank?: IdBankTransfer.Bank;
+      }
+
+      namespace IdBankTransfer {
+        type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
+      }
+
       interface Ideal {
         /**
          * The customer's bank. Only use this parameter for existing customers. Don't use it for new customers.
@@ -546,6 +594,8 @@ declare module 'stripe' {
 
       interface Link {}
 
+      interface MbWay {}
+
       interface Mobilepay {}
 
       interface Multibanco {}
@@ -606,10 +656,29 @@ declare module 'stripe' {
 
       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.
@@ -617,6 +686,32 @@ 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 {}
@@ -628,6 +723,8 @@ declare module 'stripe' {
         iban: string;
       }
 
+      interface Shopeepay {}
+
       interface Sofort {
         /**
          * Two-letter ISO code representing the country the bank account is located in.
@@ -661,13 +758,16 @@ declare module 'stripe' {
         | 'eps'
         | 'fpx'
         | 'giropay'
+        | 'gopay'
         | 'grabpay'
+        | 'id_bank_transfer'
         | 'ideal'
         | 'kakao_pay'
         | 'klarna'
         | 'konbini'
         | 'kr_card'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
         | 'naver_pay'
@@ -676,11 +776,15 @@ declare module 'stripe' {
         | 'payco'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'qris'
+        | 'rechnung'
         | 'revolut_pay'
         | 'samsung_pay'
         | 'sepa_debit'
+        | 'shopeepay'
         | 'sofort'
         | 'swish'
         | 'twint'
@@ -769,6 +873,11 @@ declare module 'stripe' {
        */
       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.
        */
@@ -843,6 +952,23 @@ declare module 'stripe' {
         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.
@@ -898,13 +1024,16 @@ declare module 'stripe' {
         | 'eps'
         | 'fpx'
         | 'giropay'
+        | 'gopay'
         | 'grabpay'
+        | 'id_bank_transfer'
         | 'ideal'
         | 'kakao_pay'
         | 'klarna'
         | 'konbini'
         | 'kr_card'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
         | 'naver_pay'
@@ -913,11 +1042,15 @@ declare module 'stripe' {
         | 'payco'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'qris'
+        | 'rechnung'
         | 'revolut_pay'
         | 'samsung_pay'
         | 'sepa_debit'
+        | 'shopeepay'
         | 'sofort'
         | 'swish'
         | 'twint'

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';
     }