stripe 17.1.0 → 17.2.0-beta.2

package/types/Coupons.d.ts

@@ -113,7 +113,7 @@ declare module 'stripe' {
         amount_off: number;
       }
 
-      type Duration = 'forever' | 'once' | 'repeating';
+      type Duration = 'forever' | 'once' | 'repeating' | 'variable';
     }
 
     /**

package/types/CouponsResource.d.ts

@@ -86,7 +86,7 @@ declare module 'stripe' {
         amount_off: number;
       }
 
-      type Duration = 'forever' | 'once' | 'repeating';
+      type Duration = 'forever' | 'once' | 'repeating' | 'variable';
     }
 
     interface CouponRetrieveParams {

package/types/CreditNotes.d.ts

@@ -106,6 +106,10 @@ declare module 'stripe' {
        */
       pdf: string;
 
+      post_payment_amount?: number;
+
+      pre_payment_amount?: number;
+
       pretax_credit_amounts?: Array<CreditNote.PretaxCreditAmount>;
 
       /**
@@ -118,6 +122,11 @@ declare module 'stripe' {
        */
       refund: string | Stripe.Refund | null;
 
+      /**
+       * Refunds related to this credit note.
+       */
+      refunds?: Array<CreditNote.Refund>;
+
       /**
        * The details of the cost of shipping, including the ShippingRate applied to the invoice.
        */
@@ -211,6 +220,18 @@ declare module 'stripe' {
         | 'order_change'
         | 'product_unsatisfactory';
 
+      interface Refund {
+        /**
+         * Amount of the refund that applies to this credit note, in cents (or local equivalent).
+         */
+        amount_refunded: number;
+
+        /**
+         * ID of the refund.
+         */
+        refund: string | Stripe.Refund;
+      }
+
       interface ShippingCost {
         /**
          * Total shipping cost before any taxes are applied.

package/types/CreditNotesResource.d.ts

@@ -68,6 +68,11 @@ declare module 'stripe' {
        */
       refund_amount?: number;
 
+      /**
+       * Refunds to link to this credit note.
+       */
+      refunds?: Array<CreditNoteCreateParams.Refund>;
+
       /**
        * When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
        */
@@ -151,6 +156,18 @@ declare module 'stripe' {
         | 'order_change'
         | 'product_unsatisfactory';
 
+      interface Refund {
+        /**
+         * Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
+         */
+        amount_refunded?: number;
+
+        /**
+         * ID of an existing refund to link this credit note to.
+         */
+        refund?: string;
+      }
+
       interface ShippingCost {
         /**
          * The ID of the shipping rate to use for this order.
@@ -278,6 +295,11 @@ declare module 'stripe' {
        */
       refund_amount?: number;
 
+      /**
+       * Refunds to link to this credit note.
+       */
+      refunds?: Array<CreditNoteListPreviewLineItemsParams.Refund>;
+
       /**
        * When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
        */
@@ -361,6 +383,18 @@ declare module 'stripe' {
         | 'order_change'
         | 'product_unsatisfactory';
 
+      interface Refund {
+        /**
+         * Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
+         */
+        amount_refunded?: number;
+
+        /**
+         * ID of an existing refund to link this credit note to.
+         */
+        refund?: string;
+      }
+
       interface ShippingCost {
         /**
          * The ID of the shipping rate to use for this order.
@@ -435,6 +469,11 @@ declare module 'stripe' {
        */
       refund_amount?: number;
 
+      /**
+       * Refunds to link to this credit note.
+       */
+      refunds?: Array<CreditNotePreviewParams.Refund>;
+
       /**
        * When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
        */
@@ -518,6 +557,18 @@ declare module 'stripe' {
         | 'order_change'
         | 'product_unsatisfactory';
 
+      interface Refund {
+        /**
+         * Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.
+         */
+        amount_refunded?: number;
+
+        /**
+         * ID of an existing refund to link this credit note to.
+         */
+        refund?: string;
+      }
+
       interface ShippingCost {
         /**
          * The ID of the shipping rate to use for this order.

package/types/CustomersResource.d.ts

@@ -220,7 +220,7 @@ declare module 'stripe' {
 
       interface TaxIdDatum {
         /**
-         * 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: TaxIdDatum.Type;
 
@@ -242,6 +242,7 @@ declare module 'stripe' {
           | 'bo_tin'
           | 'br_cnpj'
           | 'br_cpf'
+          | 'by_tin'
           | 'ca_bn'
           | 'ca_gst_hst'
           | 'ca_pst_bc'
@@ -277,6 +278,8 @@ declare module 'stripe' {
           | 'kr_brn'
           | 'kz_bin'
           | 'li_uid'
+          | 'ma_vat'
+          | 'md_vat'
           | 'mx_rfc'
           | 'my_frp'
           | 'my_itn'
@@ -300,9 +303,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';
@@ -663,7 +669,7 @@ declare module 'stripe' {
 
     interface CustomerCreateTaxIdParams {
       /**
-       * 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: CustomerCreateTaxIdParams.Type;
 
@@ -690,6 +696,7 @@ declare module 'stripe' {
         | 'bo_tin'
         | 'br_cnpj'
         | 'br_cpf'
+        | 'by_tin'
         | 'ca_bn'
         | 'ca_gst_hst'
         | 'ca_pst_bc'
@@ -725,6 +732,8 @@ declare module 'stripe' {
         | 'kr_brn'
         | 'kz_bin'
         | 'li_uid'
+        | 'ma_vat'
+        | 'md_vat'
         | 'mx_rfc'
         | 'my_frp'
         | 'my_itn'
@@ -748,9 +757,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';
@@ -821,18 +833,26 @@ declare module 'stripe' {
         | 'giropay'
         | 'grabpay'
         | 'ideal'
+        | 'kakao_pay'
         | 'klarna'
         | 'konbini'
+        | 'kr_card'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
+        | 'naver_pay'
         | 'oxxo'
         | 'p24'
+        | 'payco'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'rechnung'
         | 'revolut_pay'
+        | 'samsung_pay'
         | 'sepa_debit'
         | 'sofort'
         | 'swish'

package/types/Disputes.d.ts

@@ -45,6 +45,11 @@ declare module 'stripe' {
        */
       currency: string;
 
+      /**
+       * List of eligibility types that are included in `enhanced_evidence`.
+       */
+      enhanced_eligibility_types?: Array<'visa_compelling_evidence_3'>;
+
       evidence: Dispute.Evidence;
 
       evidence_details: Dispute.EvidenceDetails;
@@ -154,6 +159,8 @@ declare module 'stripe' {
          */
         duplicate_charge_id: string | null;
 
+        enhanced_evidence?: Evidence.EnhancedEvidence;
+
         /**
          * A description of the product or service that was sold.
          */
@@ -225,12 +232,126 @@ declare module 'stripe' {
         uncategorized_text: string | null;
       }
 
+      namespace Evidence {
+        interface EnhancedEvidence {
+          visa_compelling_evidence_3?: EnhancedEvidence.VisaCompellingEvidence3;
+        }
+
+        namespace EnhancedEvidence {
+          interface VisaCompellingEvidence3 {
+            /**
+             * Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.
+             */
+            disputed_transaction: VisaCompellingEvidence3.DisputedTransaction | null;
+
+            /**
+             * List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.
+             */
+            prior_undisputed_transactions: Array<
+              VisaCompellingEvidence3.PriorUndisputedTransaction
+            >;
+          }
+
+          namespace VisaCompellingEvidence3 {
+            interface DisputedTransaction {
+              /**
+               * User Account ID used to log into business platform. Must be recognizable by the user.
+               */
+              customer_account_id: string | null;
+
+              /**
+               * Unique identifier of the cardholder's device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
+               */
+              customer_device_fingerprint: string | null;
+
+              /**
+               * Unique identifier of the cardholder's device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
+               */
+              customer_device_id: string | null;
+
+              /**
+               * The email address of the customer.
+               */
+              customer_email_address: string | null;
+
+              /**
+               * The IP address that the customer used when making the purchase.
+               */
+              customer_purchase_ip: string | null;
+
+              /**
+               * Categorization of disputed payment.
+               */
+              merchandise_or_services: DisputedTransaction.MerchandiseOrServices | null;
+
+              /**
+               * A description of the product or service that was sold.
+               */
+              product_description: string | null;
+
+              /**
+               * The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
+               */
+              shipping_address: Stripe.Address | null;
+            }
+
+            namespace DisputedTransaction {
+              type MerchandiseOrServices = 'merchandise' | 'services';
+            }
+
+            interface PriorUndisputedTransaction {
+              /**
+               * Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.
+               */
+              charge: string;
+
+              /**
+               * User Account ID used to log into business platform. Must be recognizable by the user.
+               */
+              customer_account_id: string | null;
+
+              /**
+               * Unique identifier of the cardholder's device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
+               */
+              customer_device_fingerprint: string | null;
+
+              /**
+               * Unique identifier of the cardholder's device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
+               */
+              customer_device_id: string | null;
+
+              /**
+               * The email address of the customer.
+               */
+              customer_email_address: string | null;
+
+              /**
+               * The IP address that the customer used when making the purchase.
+               */
+              customer_purchase_ip: string | null;
+
+              /**
+               * A description of the product or service that was sold.
+               */
+              product_description: string | null;
+
+              /**
+               * The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
+               */
+              shipping_address: Stripe.Address | null;
+            }
+          }
+        }
+      }
+
       interface EvidenceDetails {
         /**
          * Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute.
          */
         due_by: number | null;
 
+        enhanced_eligibility?: EvidenceDetails.EnhancedEligibility;
+
         /**
          * Whether evidence has been staged for this dispute.
          */
@@ -247,6 +368,37 @@ declare module 'stripe' {
         submission_count: number;
       }
 
+      namespace EvidenceDetails {
+        interface EnhancedEligibility {
+          visa_compelling_evidence_3?: EnhancedEligibility.VisaCompellingEvidence3;
+        }
+
+        namespace EnhancedEligibility {
+          interface VisaCompellingEvidence3 {
+            /**
+             * List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.
+             */
+            required_actions: Array<VisaCompellingEvidence3.RequiredAction>;
+
+            /**
+             * Visa Compelling Evidence 3.0 eligibility status.
+             */
+            status: VisaCompellingEvidence3.Status;
+          }
+
+          namespace VisaCompellingEvidence3 {
+            type RequiredAction =
+              | 'missing_customer_identifiers'
+              | 'missing_disputed_transaction_description'
+              | 'missing_merchandise_or_services'
+              | 'missing_prior_undisputed_transaction_description'
+              | 'missing_prior_undisputed_transactions';
+
+            type Status = 'not_qualified' | 'qualified' | 'requires_action';
+          }
+        }
+      }
+
       interface PaymentMethodDetails {
         amazon_pay?: PaymentMethodDetails.AmazonPay;
 

package/types/DisputesResource.d.ts

@@ -98,6 +98,11 @@ declare module 'stripe' {
          */
         duplicate_charge_id?: string;
 
+        /**
+         * Additional evidence for qualifying evidence programs.
+         */
+        enhanced_evidence?: Stripe.Emptyable<Evidence.EnhancedEvidence>;
+
         /**
          * A description of the product or service that was sold. Has a maximum character count of 20,000.
          */
@@ -168,6 +173,121 @@ declare module 'stripe' {
          */
         uncategorized_text?: string;
       }
+
+      namespace Evidence {
+        interface EnhancedEvidence {
+          /**
+           * Evidence provided for Visa Compelling Evidence 3.0 evidence submission.
+           */
+          visa_compelling_evidence_3?: EnhancedEvidence.VisaCompellingEvidence3;
+        }
+
+        namespace EnhancedEvidence {
+          interface VisaCompellingEvidence3 {
+            /**
+             * Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.
+             */
+            disputed_transaction?: VisaCompellingEvidence3.DisputedTransaction;
+
+            /**
+             * List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.
+             */
+            prior_undisputed_transactions?: Array<
+              VisaCompellingEvidence3.PriorUndisputedTransaction
+            >;
+          }
+
+          namespace VisaCompellingEvidence3 {
+            interface DisputedTransaction {
+              /**
+               * User Account ID used to log into business platform. Must be recognizable by the user.
+               */
+              customer_account_id?: Stripe.Emptyable<string>;
+
+              /**
+               * Unique identifier of the cardholder's device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
+               */
+              customer_device_fingerprint?: Stripe.Emptyable<string>;
+
+              /**
+               * Unique identifier of the cardholder's device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
+               */
+              customer_device_id?: Stripe.Emptyable<string>;
+
+              /**
+               * The email address of the customer.
+               */
+              customer_email_address?: Stripe.Emptyable<string>;
+
+              /**
+               * The IP address that the customer used when making the purchase.
+               */
+              customer_purchase_ip?: Stripe.Emptyable<string>;
+
+              /**
+               * Categorization of disputed payment.
+               */
+              merchandise_or_services?: DisputedTransaction.MerchandiseOrServices;
+
+              /**
+               * A description of the product or service that was sold.
+               */
+              product_description?: Stripe.Emptyable<string>;
+
+              /**
+               * The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
+               */
+              shipping_address?: Stripe.AddressParam;
+            }
+
+            namespace DisputedTransaction {
+              type MerchandiseOrServices = 'merchandise' | 'services';
+            }
+
+            interface PriorUndisputedTransaction {
+              /**
+               * Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.
+               */
+              charge: string;
+
+              /**
+               * User Account ID used to log into business platform. Must be recognizable by the user.
+               */
+              customer_account_id?: Stripe.Emptyable<string>;
+
+              /**
+               * Unique identifier of the cardholder's device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.
+               */
+              customer_device_fingerprint?: Stripe.Emptyable<string>;
+
+              /**
+               * Unique identifier of the cardholder's device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.
+               */
+              customer_device_id?: Stripe.Emptyable<string>;
+
+              /**
+               * The email address of the customer.
+               */
+              customer_email_address?: Stripe.Emptyable<string>;
+
+              /**
+               * The IP address that the customer used when making the purchase.
+               */
+              customer_purchase_ip?: Stripe.Emptyable<string>;
+
+              /**
+               * A description of the product or service that was sold.
+               */
+              product_description?: Stripe.Emptyable<string>;
+
+              /**
+               * The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.
+               */
+              shipping_address?: Stripe.AddressParam;
+            }
+          }
+        }
+      }
     }
 
     interface DisputeListParams extends PaginationParams {