stripe 19.3.0 → 19.4.0-alpha.1

package/types/V2/Reporting/Reports.d.ts

@@ -0,0 +1,120 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Reporting {
+        /**
+         * The Report resource represents a customizable report template that provides insights into various aspects of your Stripe integration.
+         */
+        interface Report {
+          /**
+           * The unique identifier of the `Report` object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.reporting.report';
+
+          /**
+           * 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 human-readable name of the `Report`.
+           */
+          name: string;
+
+          /**
+           * Specification of the parameters that the `Report` accepts. It details each parameter's
+           * name, description, whether it is required, and any validations performed.
+           */
+          parameters: {
+            [key: string]: Report.Parameters;
+          };
+        }
+
+        namespace Report {
+          interface Parameters {
+            /**
+             * For array parameters, provides details about the array elements.
+             */
+            array_details?: Parameters.ArrayDetails;
+
+            /**
+             * Explains the purpose and usage of the parameter.
+             */
+            description: string;
+
+            /**
+             * For enum parameters, provides the list of allowed values.
+             */
+            enum_details?: Parameters.EnumDetails;
+
+            /**
+             * Indicates whether the parameter must be provided.
+             */
+            required: boolean;
+
+            /**
+             * For timestamp parameters, specifies the allowed date range.
+             */
+            timestamp_details?: Parameters.TimestampDetails;
+
+            /**
+             * The data type of the parameter.
+             */
+            type: Parameters.Type;
+          }
+
+          namespace Parameters {
+            interface ArrayDetails {
+              /**
+               * Data type of the elements in the array.
+               */
+              element_type: 'enum';
+
+              /**
+               * Details about enum elements in the array.
+               */
+              enum_details?: ArrayDetails.EnumDetails;
+            }
+
+            namespace ArrayDetails {
+              interface EnumDetails {
+                /**
+                 * Allowed values of the enum.
+                 */
+                allowed_values: Array<string>;
+              }
+            }
+
+            interface EnumDetails {
+              /**
+               * Allowed values of the enum.
+               */
+              allowed_values: Array<string>;
+            }
+
+            interface TimestampDetails {
+              /**
+               * Maximum permitted timestamp which can be requested.
+               */
+              max: string;
+
+              /**
+               * Minimum permitted timestamp which can be requested.
+               */
+              min: string;
+            }
+
+            type Type = 'array' | 'enum' | 'string' | 'timestamp';
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Reporting/ReportsResource.d.ts

@@ -0,0 +1,30 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Reporting {
+        interface ReportRetrieveParams {}
+      }
+
+      namespace Reporting {
+        class ReportsResource {
+          /**
+           * Retrieves metadata about a specific `Report` template, including its name, description,
+           * and the parameters it accepts. It's useful for understanding the capabilities and
+           * requirements of a particular `Report` before requesting a `ReportRun`.
+           */
+          retrieve(
+            id: string,
+            params?: ReportRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Reporting.Report>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Reporting.Report>>;
+        }
+      }
+    }
+  }
+}

package/types/V2/Tax/AutomaticRules.d.ts

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Tax {
+        /**
+         * An AutomaticRule holds automatic Tax configuration for a BillableItem.
+         */
+        interface AutomaticRule {
+          /**
+           * The ID of the AutomaticRule object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.tax.automatic_rule';
+
+          /**
+           * The ID of the BillableItem.
+           */
+          billable_item: string;
+
+          /**
+           * The time at which the AutomaticRule object was created.
+           */
+          created: string;
+
+          /**
+           * 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 status of the AutomaticRule object.
+           */
+          status: AutomaticRule.Status;
+
+          /**
+           * A TaxCode object that will be used for automatic tax calculations.
+           */
+          tax_code: string;
+        }
+
+        namespace AutomaticRule {
+          type Status = 'active' | 'inactive';
+        }
+      }
+    }
+  }
+}

package/types/V2/Tax/AutomaticRulesResource.d.ts

@@ -0,0 +1,102 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Tax {
+        interface AutomaticRuleCreateParams {
+          /**
+           * The BillableItem ID to set automatic Tax configuration for.
+           */
+          billable_item: string;
+
+          /**
+           * The TaxCode object to be used for automatic tax calculations.
+           */
+          tax_code: string;
+        }
+      }
+
+      namespace Tax {
+        interface AutomaticRuleRetrieveParams {}
+      }
+
+      namespace Tax {
+        interface AutomaticRuleUpdateParams {
+          /**
+           * The TaxCode object to be used for automatic tax calculations.
+           */
+          tax_code: string;
+        }
+      }
+
+      namespace Tax {
+        interface AutomaticRuleDeactivateParams {}
+      }
+
+      namespace Tax {
+        interface AutomaticRuleFindParams {
+          /**
+           * The BillableItem ID to search by.
+           */
+          billable_item: string;
+        }
+      }
+
+      namespace Tax {
+        class AutomaticRulesResource {
+          /**
+           * Creates an AutomaticRule object.
+           */
+          create(
+            params: AutomaticRuleCreateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+
+          /**
+           * Retrieves an AutomaticRule object by ID.
+           */
+          retrieve(
+            id: string,
+            params?: AutomaticRuleRetrieveParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+          retrieve(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+
+          /**
+           * Updates the automatic Tax configuration for an AutomaticRule object.
+           */
+          update(
+            id: string,
+            params: AutomaticRuleUpdateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+
+          /**
+           * Deactivates an AutomaticRule object. Deactivated AutomaticRule objects are ignored in future tax calculations.
+           */
+          deactivate(
+            id: string,
+            params?: AutomaticRuleDeactivateParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+          deactivate(
+            id: string,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+
+          /**
+           * Finds an AutomaticRule object by BillableItem ID.
+           */
+          find(
+            params: AutomaticRuleFindParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.V2.Tax.AutomaticRule>>;
+        }
+      }
+    }
+  }
+}

package/types/V2/TestHelpers/FinancialAddressesResource.d.ts

@@ -0,0 +1,73 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace TestHelpers {
+        interface FinancialAddressCreditParams {
+          /**
+           * Object containing the amount value and currency to credit.
+           */
+          amount: Amount;
+
+          /**
+           * Open Enum. The network to use in simulating the funds flow. This will be the reflected in the resulting ReceivedCredit.
+           */
+          network: FinancialAddressCreditParams.Network;
+
+          /**
+           * String explaining funds flow. Use this field to populate the statement descriptor of the ReceivedCredit created as an eventual result of this simulation.
+           */
+          statement_descriptor?: string;
+        }
+
+        namespace FinancialAddressCreditParams {
+          type Network =
+            | 'ach'
+            | 'fps'
+            | 'rtp'
+            | 'sepa_credit_transfer'
+            | 'wire';
+        }
+      }
+
+      namespace TestHelpers {
+        interface FinancialAddressGenerateMicrodepositsParams {}
+      }
+
+      namespace TestHelpers {
+        class FinancialAddressesResource {
+          /**
+           * Simulate crediting a FinancialAddress in a Sandbox environment. This can be used to add virtual funds and increase your balance for testing.
+           * @throws Stripe.FeatureNotEnabledError
+           */
+          credit(
+            id: string,
+            params: FinancialAddressCreditParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.FinancialAddressCreditSimulation>
+          >;
+
+          /**
+           * Generates microdeposits for a FinancialAddress in a Sandbox environment.
+           * @throws Stripe.FeatureNotEnabledError
+           */
+          generateMicrodeposits(
+            id: string,
+            params?: FinancialAddressGenerateMicrodepositsParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.FinancialAddressGeneratedMicrodeposits>
+          >;
+          generateMicrodeposits(
+            id: string,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.FinancialAddressGeneratedMicrodeposits>
+          >;
+        }
+      }
+    }
+  }
+}

package/types/V2/TestHelpers/MoneyManagementResource.d.ts

@@ -0,0 +1,49 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace TestHelpers {
+        interface MoneyManagementRecipientVerificationsParams {
+          /**
+           * Expected match level of the RecipientVerification to be created: `match`, `close_match`, `no_match`, `unavailable`.
+           * For `close_match`, the simulated response appends "close_match" to the provided name in match_result_details.matched_name.
+           */
+          match_result: MoneyManagementRecipientVerificationsParams.MatchResult;
+
+          /**
+           * ID of the payout method.
+           */
+          payout_method: string;
+
+          /**
+           * ID of the recipient account. Required if the recipient distinct from the sender. Leave empty if the recipient and sender are the same entity (i.e. for me-to-me payouts).
+           */
+          recipient?: string;
+        }
+
+        namespace MoneyManagementRecipientVerificationsParams {
+          type MatchResult =
+            | 'close_match'
+            | 'match'
+            | 'no_match'
+            | 'unavailable';
+        }
+      }
+
+      namespace TestHelpers {
+        class MoneyManagementResource {
+          /**
+           * Creates a RecipientVerification with a specified match result for testing purposes in a Sandbox environment.
+           */
+          recipientVerifications(
+            params: MoneyManagementRecipientVerificationsParams,
+            options?: RequestOptions
+          ): Promise<
+            Stripe.Response<Stripe.V2.MoneyManagement.RecipientVerification>
+          >;
+        }
+      }
+    }
+  }
+}

package/types/WebhookEndpointsResource.d.ts

@@ -167,6 +167,8 @@ declare module 'stripe' {
         | 'account.external_account.deleted'
         | 'account.external_account.updated'
         | 'account.updated'
+        | 'account_notice.created'
+        | 'account_notice.updated'
         | 'application_fee.created'
         | 'application_fee.refund.updated'
         | 'application_fee.refunded'
@@ -177,6 +179,15 @@ declare module 'stripe' {
         | 'billing_portal.configuration.updated'
         | 'billing_portal.session.created'
         | 'capability.updated'
+        | 'capital.financing_offer.accepted'
+        | 'capital.financing_offer.canceled'
+        | 'capital.financing_offer.created'
+        | 'capital.financing_offer.expired'
+        | 'capital.financing_offer.fully_repaid'
+        | 'capital.financing_offer.paid_out'
+        | 'capital.financing_offer.rejected'
+        | 'capital.financing_offer.replacement_created'
+        | 'capital.financing_transaction.created'
         | 'cash_balance.funds_available'
         | 'charge.captured'
         | 'charge.dispute.closed'
@@ -217,11 +228,15 @@ declare module 'stripe' {
         | 'customer.source.deleted'
         | 'customer.source.expiring'
         | 'customer.source.updated'
+        | 'customer.subscription.collection_paused'
+        | 'customer.subscription.collection_resumed'
         | 'customer.subscription.created'
+        | 'customer.subscription.custom_event'
         | 'customer.subscription.deleted'
         | 'customer.subscription.paused'
         | 'customer.subscription.pending_update_applied'
         | 'customer.subscription.pending_update_expired'
+        | 'customer.subscription.price_migration_failed'
         | 'customer.subscription.resumed'
         | 'customer.subscription.trial_will_end'
         | 'customer.subscription.updated'
@@ -237,8 +252,11 @@ declare module 'stripe' {
         | 'financial_connections.account.disconnected'
         | 'financial_connections.account.reactivated'
         | 'financial_connections.account.refreshed_balance'
+        | 'financial_connections.account.refreshed_inferred_balances'
         | 'financial_connections.account.refreshed_ownership'
         | 'financial_connections.account.refreshed_transactions'
+        | 'financial_connections.session.updated'
+        | 'fx_quote.expired'
         | 'identity.verification_session.canceled'
         | 'identity.verification_session.created'
         | 'identity.verification_session.processing'
@@ -253,6 +271,7 @@ declare module 'stripe' {
         | 'invoice.overdue'
         | 'invoice.overpaid'
         | 'invoice.paid'
+        | 'invoice.payment.overpaid'
         | 'invoice.payment_action_required'
         | 'invoice.payment_attempt_required'
         | 'invoice.payment_failed'
@@ -278,10 +297,15 @@ declare module 'stripe' {
         | 'issuing_dispute.funds_rescinded'
         | 'issuing_dispute.submitted'
         | 'issuing_dispute.updated'
+        | 'issuing_dispute_settlement_detail.created'
+        | 'issuing_dispute_settlement_detail.updated'
+        | 'issuing_fraud_liability_debit.created'
         | 'issuing_personalization_design.activated'
         | 'issuing_personalization_design.deactivated'
         | 'issuing_personalization_design.rejected'
         | 'issuing_personalization_design.updated'
+        | 'issuing_settlement.created'
+        | 'issuing_settlement.updated'
         | 'issuing_token.created'
         | 'issuing_token.updated'
         | 'issuing_transaction.created'
@@ -317,15 +341,26 @@ declare module 'stripe' {
         | 'price.created'
         | 'price.deleted'
         | 'price.updated'
+        | 'privacy.redaction_job.canceled'
+        | 'privacy.redaction_job.created'
+        | 'privacy.redaction_job.ready'
+        | 'privacy.redaction_job.succeeded'
+        | 'privacy.redaction_job.validation_error'
         | 'product.created'
         | 'product.deleted'
         | 'product.updated'
         | 'promotion_code.created'
         | 'promotion_code.updated'
+        | 'quote.accept_failed'
         | 'quote.accepted'
+        | 'quote.accepting'
         | 'quote.canceled'
         | 'quote.created'
+        | 'quote.draft'
         | 'quote.finalized'
+        | 'quote.reestimate_failed'
+        | 'quote.reestimated'
+        | 'quote.stale'
         | 'radar.early_fraud_warning.created'
         | 'radar.early_fraud_warning.updated'
         | 'refund.created'
@@ -354,8 +389,10 @@ declare module 'stripe' {
         | 'subscription_schedule.completed'
         | 'subscription_schedule.created'
         | 'subscription_schedule.expiring'
+        | 'subscription_schedule.price_migration_failed'
         | 'subscription_schedule.released'
         | 'subscription_schedule.updated'
+        | 'tax.form.updated'
         | 'tax.settings.updated'
         | 'tax_rate.created'
         | 'tax_rate.updated'
@@ -462,6 +499,8 @@ declare module 'stripe' {
         | 'account.external_account.deleted'
         | 'account.external_account.updated'
         | 'account.updated'
+        | 'account_notice.created'
+        | 'account_notice.updated'
         | 'application_fee.created'
         | 'application_fee.refund.updated'
         | 'application_fee.refunded'
@@ -472,6 +511,15 @@ declare module 'stripe' {
         | 'billing_portal.configuration.updated'
         | 'billing_portal.session.created'
         | 'capability.updated'
+        | 'capital.financing_offer.accepted'
+        | 'capital.financing_offer.canceled'
+        | 'capital.financing_offer.created'
+        | 'capital.financing_offer.expired'
+        | 'capital.financing_offer.fully_repaid'
+        | 'capital.financing_offer.paid_out'
+        | 'capital.financing_offer.rejected'
+        | 'capital.financing_offer.replacement_created'
+        | 'capital.financing_transaction.created'
         | 'cash_balance.funds_available'
         | 'charge.captured'
         | 'charge.dispute.closed'
@@ -512,11 +560,15 @@ declare module 'stripe' {
         | 'customer.source.deleted'
         | 'customer.source.expiring'
         | 'customer.source.updated'
+        | 'customer.subscription.collection_paused'
+        | 'customer.subscription.collection_resumed'
         | 'customer.subscription.created'
+        | 'customer.subscription.custom_event'
         | 'customer.subscription.deleted'
         | 'customer.subscription.paused'
         | 'customer.subscription.pending_update_applied'
         | 'customer.subscription.pending_update_expired'
+        | 'customer.subscription.price_migration_failed'
         | 'customer.subscription.resumed'
         | 'customer.subscription.trial_will_end'
         | 'customer.subscription.updated'
@@ -532,8 +584,11 @@ declare module 'stripe' {
         | 'financial_connections.account.disconnected'
         | 'financial_connections.account.reactivated'
         | 'financial_connections.account.refreshed_balance'
+        | 'financial_connections.account.refreshed_inferred_balances'
         | 'financial_connections.account.refreshed_ownership'
         | 'financial_connections.account.refreshed_transactions'
+        | 'financial_connections.session.updated'
+        | 'fx_quote.expired'
         | 'identity.verification_session.canceled'
         | 'identity.verification_session.created'
         | 'identity.verification_session.processing'
@@ -548,6 +603,7 @@ declare module 'stripe' {
         | 'invoice.overdue'
         | 'invoice.overpaid'
         | 'invoice.paid'
+        | 'invoice.payment.overpaid'
         | 'invoice.payment_action_required'
         | 'invoice.payment_attempt_required'
         | 'invoice.payment_failed'
@@ -573,10 +629,15 @@ declare module 'stripe' {
         | 'issuing_dispute.funds_rescinded'
         | 'issuing_dispute.submitted'
         | 'issuing_dispute.updated'
+        | 'issuing_dispute_settlement_detail.created'
+        | 'issuing_dispute_settlement_detail.updated'
+        | 'issuing_fraud_liability_debit.created'
         | 'issuing_personalization_design.activated'
         | 'issuing_personalization_design.deactivated'
         | 'issuing_personalization_design.rejected'
         | 'issuing_personalization_design.updated'
+        | 'issuing_settlement.created'
+        | 'issuing_settlement.updated'
         | 'issuing_token.created'
         | 'issuing_token.updated'
         | 'issuing_transaction.created'
@@ -612,15 +673,26 @@ declare module 'stripe' {
         | 'price.created'
         | 'price.deleted'
         | 'price.updated'
+        | 'privacy.redaction_job.canceled'
+        | 'privacy.redaction_job.created'
+        | 'privacy.redaction_job.ready'
+        | 'privacy.redaction_job.succeeded'
+        | 'privacy.redaction_job.validation_error'
         | 'product.created'
         | 'product.deleted'
         | 'product.updated'
         | 'promotion_code.created'
         | 'promotion_code.updated'
+        | 'quote.accept_failed'
         | 'quote.accepted'
+        | 'quote.accepting'
         | 'quote.canceled'
         | 'quote.created'
+        | 'quote.draft'
         | 'quote.finalized'
+        | 'quote.reestimate_failed'
+        | 'quote.reestimated'
+        | 'quote.stale'
         | 'radar.early_fraud_warning.created'
         | 'radar.early_fraud_warning.updated'
         | 'refund.created'
@@ -649,8 +721,10 @@ declare module 'stripe' {
         | 'subscription_schedule.completed'
         | 'subscription_schedule.created'
         | 'subscription_schedule.expiring'
+        | 'subscription_schedule.price_migration_failed'
         | 'subscription_schedule.released'
         | 'subscription_schedule.updated'
+        | 'tax.form.updated'
         | 'tax.settings.updated'
         | 'tax_rate.created'
         | 'tax_rate.updated'

package/types/Webhooks.d.ts

@@ -2,6 +2,8 @@
 
 declare module 'stripe' {
   namespace Stripe {
+    export type WebhookEvent = Record<string, unknown>;
+
     export class Webhooks {
       /**
        * Constructs and verifies the signature of an Event from the provided details.

package/types/apiVersion.d.ts

@@ -1,4 +1,3 @@
 // File generated from our OpenAPI spec
 
-export const ApiVersion = '2025-10-29.clover';
-export const ApiMajorVersion = 'clover';
+export const ApiVersion = '2025-09-30.preview';