stripe 17.1.0 → 17.2.0-beta.2

package/types/Tax/RegistrationsResource.d.ts

@@ -62,6 +62,11 @@ declare module 'stripe' {
            */
           bh?: CountryOptions.Bh;
 
+          /**
+           * Options for the registration in BY.
+           */
+          by?: CountryOptions.By;
+
           /**
            * Options for the registration in CA.
            */
@@ -82,6 +87,11 @@ declare module 'stripe' {
            */
           co?: CountryOptions.Co;
 
+          /**
+           * Options for the registration in CR.
+           */
+          cr?: CountryOptions.Cr;
+
           /**
            * Options for the registration in CY.
            */
@@ -102,6 +112,11 @@ declare module 'stripe' {
            */
           dk?: CountryOptions.Dk;
 
+          /**
+           * Options for the registration in EC.
+           */
+          ec?: CountryOptions.Ec;
+
           /**
            * Options for the registration in EE.
            */
@@ -207,6 +222,16 @@ declare module 'stripe' {
            */
           lv?: CountryOptions.Lv;
 
+          /**
+           * Options for the registration in MA.
+           */
+          ma?: CountryOptions.Ma;
+
+          /**
+           * Options for the registration in MD.
+           */
+          md?: CountryOptions.Md;
+
           /**
            * Options for the registration in MT.
            */
@@ -262,6 +287,16 @@ declare module 'stripe' {
            */
           ro?: CountryOptions.Ro;
 
+          /**
+           * Options for the registration in RS.
+           */
+          rs?: CountryOptions.Rs;
+
+          /**
+           * Options for the registration in RU.
+           */
+          ru?: CountryOptions.Ru;
+
           /**
            * Options for the registration in SA.
            */
@@ -297,11 +332,21 @@ declare module 'stripe' {
            */
           tr?: CountryOptions.Tr;
 
+          /**
+           * Options for the registration in TZ.
+           */
+          tz?: CountryOptions.Tz;
+
           /**
            * Options for the registration in US.
            */
           us?: CountryOptions.Us;
 
+          /**
+           * Options for the registration in UZ.
+           */
+          uz?: CountryOptions.Uz;
+
           /**
            * Options for the registration in VN.
            */
@@ -416,6 +461,13 @@ declare module 'stripe' {
             type: 'standard';
           }
 
+          interface By {
+            /**
+             * Type of registration to be created in `country`.
+             */
+            type: 'simplified';
+          }
+
           interface Ca {
             /**
              * Options for the provincial tax registration.
@@ -460,6 +512,13 @@ declare module 'stripe' {
             type: 'simplified';
           }
 
+          interface Cr {
+            /**
+             * Type of registration to be created in `country`.
+             */
+            type: 'simplified';
+          }
+
           interface Cy {
             /**
              * Options for the standard registration.
@@ -568,6 +627,13 @@ declare module 'stripe' {
             type Type = 'ioss' | 'oss_non_union' | 'oss_union' | 'standard';
           }
 
+          interface Ec {
+            /**
+             * Type of registration to be created in `country`.
+             */
+            type: 'simplified';
+          }
+
           interface Ee {
             /**
              * Options for the standard registration.
@@ -955,6 +1021,20 @@ declare module 'stripe' {
             type Type = 'ioss' | 'oss_non_union' | 'oss_union' | 'standard';
           }
 
+          interface Ma {
+            /**
+             * Type of registration to be created in `country`.
+             */
+            type: 'simplified';
+          }
+
+          interface Md {
+            /**
+             * Type of registration to be created in `country`.
+             */
+            type: 'simplified';
+          }
+
           interface Mt {
             /**
              * Options for the standard registration.
@@ -1132,6 +1212,20 @@ declare module 'stripe' {
             type Type = 'ioss' | 'oss_non_union' | 'oss_union' | 'standard';
           }
 
+          interface Rs {
+            /**
+             * Type of registration to be created in `country`.
+             */
+            type: 'standard';
+          }
+
+          interface Ru {
+            /**
+             * Type of registration to be created in `country`.
+             */
+            type: 'simplified';
+          }
+
           interface Sa {
             /**
              * Type of registration to be created in `country`.
@@ -1241,6 +1335,13 @@ declare module 'stripe' {
             type: 'simplified';
           }
 
+          interface Tz {
+            /**
+             * Type of registration to be created in `country`.
+             */
+            type: 'simplified';
+          }
+
           interface Us {
             /**
              * Options for the local amusement tax registration.
@@ -1315,9 +1416,17 @@ declare module 'stripe' {
               | 'local_amusement_tax'
               | 'local_lease_tax'
               | 'state_communications_tax'
+              | 'state_retail_delivery_fee'
               | 'state_sales_tax';
           }
 
+          interface Uz {
+            /**
+             * Type of registration to be created in `country`.
+             */
+            type: 'simplified';
+          }
+
           interface Vn {
             /**
              * Type of registration to be created in `country`.

package/types/Tax/Transactions.d.ts

@@ -125,7 +125,7 @@ declare module 'stripe' {
 
           interface TaxId {
             /**
-             * 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`, 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`, `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: TaxId.Type;
 
@@ -147,6 +147,7 @@ declare module 'stripe' {
               | 'bo_tin'
               | 'br_cnpj'
               | 'br_cpf'
+              | 'by_tin'
               | 'ca_bn'
               | 'ca_gst_hst'
               | 'ca_pst_bc'
@@ -182,6 +183,8 @@ declare module 'stripe' {
               | 'kr_brn'
               | 'kz_bin'
               | 'li_uid'
+              | 'ma_vat'
+              | 'md_vat'
               | 'mx_rfc'
               | 'my_frp'
               | 'my_itn'
@@ -205,10 +208,13 @@ declare module 'stripe' {
               | 'th_vat'
               | 'tr_tin'
               | 'tw_vat'
+              | 'tz_vat'
               | 'ua_vat'
               | 'unknown'
               | 'us_ein'
               | 'uy_ruc'
+              | 'uz_tin'
+              | 'uz_vat'
               | 've_rif'
               | 'vn_tin'
               | 'za_vat';
@@ -364,6 +370,7 @@ declare module 'stripe' {
                 | 'lease_tax'
                 | 'pst'
                 | 'qst'
+                | 'retail_delivery_fee'
                 | 'rst'
                 | 'sales_tax'
                 | 'vat';

package/types/TaxIds.d.ts

@@ -70,7 +70,7 @@ declare module 'stripe' {
       owner: TaxId.Owner | null;
 
       /**
-       * Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`
+       * Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`
        */
       type: TaxId.Type;
 
@@ -123,6 +123,7 @@ declare module 'stripe' {
         | 'bo_tin'
         | 'br_cnpj'
         | 'br_cpf'
+        | 'by_tin'
         | 'ca_bn'
         | 'ca_gst_hst'
         | 'ca_pst_bc'
@@ -158,6 +159,8 @@ declare module 'stripe' {
         | 'kr_brn'
         | 'kz_bin'
         | 'li_uid'
+        | 'ma_vat'
+        | 'md_vat'
         | 'mx_rfc'
         | 'my_frp'
         | 'my_itn'
@@ -181,10 +184,13 @@ declare module 'stripe' {
         | 'th_vat'
         | 'tr_tin'
         | 'tw_vat'
+        | 'tz_vat'
         | 'ua_vat'
         | 'unknown'
         | 'us_ein'
         | 'uy_ruc'
+        | 'uz_tin'
+        | 'uz_vat'
         | 've_rif'
         | 'vn_tin'
         | 'za_vat';

package/types/TaxIdsResource.d.ts

@@ -4,7 +4,7 @@ declare module 'stripe' {
   namespace Stripe {
     interface TaxIdCreateParams {
       /**
-       * Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`
+       * Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `ma_vat`, `md_vat`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, or `za_vat`
        */
       type: TaxIdCreateParams.Type;
 
@@ -57,6 +57,7 @@ declare module 'stripe' {
         | 'bo_tin'
         | 'br_cnpj'
         | 'br_cpf'
+        | 'by_tin'
         | 'ca_bn'
         | 'ca_gst_hst'
         | 'ca_pst_bc'
@@ -92,6 +93,8 @@ declare module 'stripe' {
         | 'kr_brn'
         | 'kz_bin'
         | 'li_uid'
+        | 'ma_vat'
+        | 'md_vat'
         | 'mx_rfc'
         | 'my_frp'
         | 'my_itn'
@@ -115,9 +118,12 @@ declare module 'stripe' {
         | 'th_vat'
         | 'tr_tin'
         | 'tw_vat'
+        | 'tz_vat'
         | 'ua_vat'
         | 'us_ein'
         | 'uy_ruc'
+        | 'uz_tin'
+        | 'uz_vat'
         | 've_rif'
         | 'vn_tin'
         | 'za_vat';

package/types/TaxRates.d.ts

@@ -50,6 +50,11 @@ declare module 'stripe' {
        */
       effective_percentage: number | null;
 
+      /**
+       * The amount of the tax rate when the `rate_type` is `flat_amount`. Tax rates with `rate_type` `percentage` can vary based on the transaction, resulting in this field being `null`. This field exposes the amount and currency of the flat tax rate.
+       */
+      flat_amount?: TaxRate.FlatAmount | null;
+
       /**
        * This specifies if the tax rate is inclusive or exclusive.
        */
@@ -80,6 +85,11 @@ declare module 'stripe' {
        */
       percentage: number;
 
+      /**
+       * Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.
+       */
+      rate_type?: TaxRate.RateType | null;
+
       /**
        * [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
        */
@@ -92,6 +102,18 @@ declare module 'stripe' {
     }
 
     namespace TaxRate {
+      interface FlatAmount {
+        /**
+         * Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
+         */
+        amount: number;
+
+        /**
+         * Three-letter ISO currency code, in lowercase.
+         */
+        currency: string;
+      }
+
       type JurisdictionLevel =
         | 'city'
         | 'country'
@@ -100,6 +122,8 @@ declare module 'stripe' {
         | 'multiple'
         | 'state';
 
+      type RateType = 'flat_amount' | 'percentage';
+
       type TaxType =
         | 'amusement_tax'
         | 'communications_tax'
@@ -110,6 +134,7 @@ declare module 'stripe' {
         | 'lease_tax'
         | 'pst'
         | 'qst'
+        | 'retail_delivery_fee'
         | 'rst'
         | 'sales_tax'
         | 'vat';

package/types/TaxRatesResource.d.ts

@@ -70,6 +70,7 @@ declare module 'stripe' {
         | 'lease_tax'
         | 'pst'
         | 'qst'
+        | 'retail_delivery_fee'
         | 'rst'
         | 'sales_tax'
         | 'vat';
@@ -140,6 +141,7 @@ declare module 'stripe' {
         | 'lease_tax'
         | 'pst'
         | 'qst'
+        | 'retail_delivery_fee'
         | 'rst'
         | 'sales_tax'
         | 'vat';

package/types/Terminal/ReaderCollectedData.d.ts

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Terminal {
+      /**
+       * Returns data collected by Terminal readers. This data is only stored for 24 hours.
+       */
+      interface ReaderCollectedData {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'terminal.reader_collected_data';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * The magstripe data collected by the reader.
+         */
+        magstripe: ReaderCollectedData.Magstripe | null;
+
+        /**
+         * The type of data collected by the reader.
+         */
+        type: 'magstripe';
+      }
+
+      namespace ReaderCollectedData {
+        interface Magstripe {
+          /**
+           * The raw magstripe data collected by the reader.
+           */
+          data: string | null;
+        }
+      }
+    }
+  }
+}

package/types/Terminal/ReaderCollectedDataResource.d.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Terminal {
+      interface ReaderCollectedDataRetrieveParams {
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      class ReaderCollectedDataResource {
+        /**
+         * Retrieve data collected using Reader hardware.
+         */
+        retrieve(
+          id: string,
+          params?: ReaderCollectedDataRetrieveParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.ReaderCollectedData>>;
+        retrieve(
+          id: string,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Terminal.ReaderCollectedData>>;
+      }
+    }
+  }
+}