stripe 18.2.1 → 18.3.0-beta.2

package/types/Events.d.ts

@@ -21,6 +21,59 @@ declare module 'stripe' {
         interface PreviousAttributes {}
       }
 
+      interface Reason {
+        automation_action?: Reason.AutomationAction;
+
+        request?: Reason.Request;
+
+        /**
+         * The type of the reason for the event.
+         */
+        type: Reason.Type;
+      }
+
+      namespace Reason {
+        interface AutomationAction {
+          stripe_send_webhook_custom_event?: AutomationAction.StripeSendWebhookCustomEvent;
+
+          /**
+           * The trigger name of the automation that triggered this action.
+           *  Please visit [Revenue and retention automations](https://docs.stripe.com/billing/automations#choose-a-trigger) for all possible trigger names.
+           */
+          trigger: string;
+
+          /**
+           * The type of the `automation_action`.
+           */
+          type: 'stripe_send_webhook_custom_event';
+        }
+
+        namespace AutomationAction {
+          interface StripeSendWebhookCustomEvent {
+            /**
+             * Set of key-value pairs attached to the action when creating an Automation.
+             */
+            custom_data: {
+              [key: string]: string;
+            } | null;
+          }
+        }
+
+        interface Request {
+          /**
+           * ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
+           */
+          id: string | null;
+
+          /**
+           * The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.
+           */
+          idempotency_key: string | null;
+        }
+
+        type Type = 'automation_action' | 'request';
+      }
+
       interface Request {
         /**
          * ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
@@ -40,15 +93,27 @@ 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'
         | 'balance.available'
+        | 'balance_settings.updated'
         | 'billing.alert.triggered'
         | 'billing_portal.configuration.created'
         | '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'
@@ -89,11 +154,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'
@@ -109,8 +178,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'
@@ -125,7 +197,9 @@ declare module 'stripe' {
         | 'invoice.overdue'
         | 'invoice.overpaid'
         | 'invoice.paid'
+        | 'invoice.payment.overpaid'
         | 'invoice.payment_action_required'
+        | 'invoice.payment_attempt_required'
         | 'invoice.payment_failed'
         | 'invoice.payment_succeeded'
         | 'invoice.sent'
@@ -149,10 +223,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'
@@ -188,15 +267,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'
@@ -225,13 +315,16 @@ 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'
         | 'terminal.reader.action_failed'
         | 'terminal.reader.action_succeeded'
+        | 'terminal.reader.action_updated'
         | 'test_helpers.test_clock.advancing'
         | 'test_helpers.test_clock.created'
         | 'test_helpers.test_clock.deleted'
@@ -359,6 +452,11 @@ declare module 'stripe' {
        */
       pending_webhooks: number;
 
+      /**
+       * Information about the action that causes the event. Only present when the event is triggered by an API request or an [Automation](https://docs.stripe.com/billing/automations) action.
+       */
+      reason?: Event.Reason | null;
+
       /**
        * Information on the API request that triggers the event.
        */

package/types/ExternalAccountsResource.d.ts

@@ -0,0 +1,304 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface ExternalAccountCreateParams {
+      /**
+       * Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's external account details (with the options shown below).
+       */
+      external_account:
+        | string
+        | ExternalAccountCreateParams.Card
+        | ExternalAccountCreateParams.BankAccount
+        | ExternalAccountCreateParams.CardToken;
+
+      /**
+       * When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.
+       */
+      default_for_currency?: boolean;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * 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`.
+       */
+      metadata?: Stripe.MetadataParam;
+    }
+
+    namespace ExternalAccountCreateParams {
+      interface BankAccount {
+        object: 'bank_account';
+
+        /**
+         * The name of the person or business that owns the bank account.This field is required when attaching the bank account to a `Customer` object.
+         */
+        account_holder_name?: string;
+
+        /**
+         * The type of entity that holds the account. It can be `company` or `individual`. This field is required when attaching the bank account to a `Customer` object.
+         */
+        account_holder_type?: BankAccount.AccountHolderType;
+
+        /**
+         * The account number for the bank account, in string form. Must be a checking account.
+         */
+        account_number: string;
+
+        /**
+         * The country in which the bank account is located.
+         */
+        country: string;
+
+        /**
+         * The currency the bank account is in. This must be a country/currency pairing that [Stripe supports.](docs/payouts)
+         */
+        currency?: string;
+
+        /**
+         * The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for `account_number`, this field is not required.
+         */
+        routing_number?: string;
+      }
+
+      namespace BankAccount {
+        type AccountHolderType = 'company' | 'individual';
+      }
+
+      interface Card {
+        object: 'card';
+
+        address_city?: string;
+
+        address_country?: string;
+
+        address_line1?: string;
+
+        address_line2?: string;
+
+        address_state?: string;
+
+        address_zip?: string;
+
+        currency?: string;
+
+        cvc?: string;
+
+        exp_month: number;
+
+        exp_year: number;
+
+        name?: string;
+
+        number: string;
+
+        /**
+         * 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.
+         */
+        metadata?: Stripe.MetadataParam;
+      }
+
+      interface CardToken {
+        object: 'card';
+
+        currency?: string;
+
+        token: string;
+      }
+    }
+
+    interface ExternalAccountRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface ExternalAccountUpdateParams {
+      /**
+       * The name of the person or business that owns the bank account.
+       */
+      account_holder_name?: string;
+
+      /**
+       * The type of entity that holds the account. This can be either `individual` or `company`.
+       */
+      account_holder_type?: Stripe.Emptyable<
+        ExternalAccountUpdateParams.AccountHolderType
+      >;
+
+      /**
+       * The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
+       */
+      account_type?: ExternalAccountUpdateParams.AccountType;
+
+      /**
+       * City/District/Suburb/Town/Village.
+       */
+      address_city?: string;
+
+      /**
+       * Billing address country, if provided when creating card.
+       */
+      address_country?: string;
+
+      /**
+       * Address line 1 (Street address/PO Box/Company name).
+       */
+      address_line1?: string;
+
+      /**
+       * Address line 2 (Apartment/Suite/Unit/Building).
+       */
+      address_line2?: string;
+
+      /**
+       * State/County/Province/Region.
+       */
+      address_state?: string;
+
+      /**
+       * ZIP or postal code.
+       */
+      address_zip?: string;
+
+      /**
+       * When set to true, this becomes the default external account for its currency.
+       */
+      default_for_currency?: boolean;
+
+      /**
+       * Documents that may be submitted to satisfy various informational requests.
+       */
+      documents?: ExternalAccountUpdateParams.Documents;
+
+      /**
+       * Two digit number representing the card's expiration month.
+       */
+      exp_month?: string;
+
+      /**
+       * Four digit number representing the card's expiration year.
+       */
+      exp_year?: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * 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`.
+       */
+      metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
+
+      /**
+       * Cardholder name.
+       */
+      name?: string;
+    }
+
+    namespace ExternalAccountUpdateParams {
+      type AccountHolderType = 'company' | 'individual';
+
+      type AccountType = 'checking' | 'futsu' | 'savings' | 'toza';
+
+      interface Documents {
+        /**
+         * One or more documents that support the [Bank account ownership verification](https://support.stripe.com/questions/bank-account-ownership-verification) requirement. Must be a document associated with the bank account that displays the last 4 digits of the account number, either a statement or a check.
+         */
+        bank_account_ownership_verification?: Documents.BankAccountOwnershipVerification;
+      }
+
+      namespace Documents {
+        interface BankAccountOwnershipVerification {
+          /**
+           * One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.
+           */
+          files?: Array<string>;
+        }
+      }
+    }
+
+    interface ExternalAccountListParams extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Filter external accounts according to a particular object type.
+       */
+      object?: ExternalAccountListParams.Object;
+    }
+
+    namespace ExternalAccountListParams {
+      type Object = 'bank_account' | 'card';
+    }
+
+    interface ExternalAccountDeleteParams {}
+
+    class ExternalAccountsResource {
+      /**
+       * Create an external account for a given connected account.
+       */
+      create(
+        params: ExternalAccountCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
+
+      /**
+       * Retrieve a specified external account for a given account.
+       */
+      retrieve(
+        id: string,
+        params?: ExternalAccountRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
+
+      /**
+       * Updates the metadata, account holder name, account holder type of a bank account belonging to
+       * a connected account and optionally sets it as the default for its currency. Other bank account
+       * details are not editable by design.
+       *
+       * You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
+       *
+       * You can re-enable a disabled bank account by performing an update call without providing any
+       * arguments or changes.
+       */
+      update(
+        id: string,
+        params?: ExternalAccountUpdateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.ExternalAccount>>;
+
+      /**
+       * List external accounts for an account.
+       */
+      list(
+        params?: ExternalAccountListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.ExternalAccount>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.ExternalAccount>;
+
+      /**
+       * Delete a specified external account for a given account.
+       */
+      del(
+        id: string,
+        params?: ExternalAccountDeleteParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.DeletedExternalAccount>>;
+      del(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.DeletedExternalAccount>>;
+    }
+  }
+}

package/types/FinancialConnections/AccountInferredBalances.d.ts

@@ -0,0 +1,38 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      /**
+       * A historical balance for the account on a particular day. It may be sourced from a balance snapshot provided by a financial institution, or inferred using transactions data.
+       */
+      interface AccountInferredBalance {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'financial_connections.account_inferred_balance';
+
+        /**
+         * The time for which this balance was calculated, measured in seconds since the Unix epoch. If the balance was computed by Stripe and not provided directly by a financial institution, it will always be 23:59:59 UTC.
+         */
+        as_of: number;
+
+        /**
+         * The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.
+         *
+         * Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
+         *
+         * Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.
+         */
+        current: {
+          [key: string]: number;
+        };
+      }
+    }
+  }
+}

package/types/FinancialConnections/Accounts.d.ts

@@ -47,6 +47,16 @@ declare module 'stripe' {
          */
         display_name: string | null;
 
+        /**
+         * The state of the most recent attempt to refresh the account's inferred balance history.
+         */
+        inferred_balances_refresh?: Account.InferredBalancesRefresh | null;
+
+        /**
+         * The ID of the Financial Connections Institution this account belongs to. Note that this relationship may sometimes change in rare circumstances (e.g. institution mergers).
+         */
+        institution?: string | Stripe.FinancialConnections.Institution | null;
+
         /**
          * The name of the institution that holds this account.
          */
@@ -103,7 +113,7 @@ declare module 'stripe' {
         /**
          * The list of data refresh subscriptions requested on this account.
          */
-        subscriptions: Array<'transactions'> | null;
+        subscriptions: Array<Account.Subscription> | null;
 
         /**
          * The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
@@ -130,6 +140,8 @@ declare module 'stripe' {
            */
           customer?: string | Stripe.Customer;
 
+          customer_account?: string;
+
           /**
            * Type of account holder that this account belongs to.
            */
@@ -220,6 +232,27 @@ declare module 'stripe' {
 
         type Category = 'cash' | 'credit' | 'investment' | 'other';
 
+        interface InferredBalancesRefresh {
+          /**
+           * The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
+           */
+          last_attempted_at: number;
+
+          /**
+           * Time at which the next inferred balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.
+           */
+          next_refresh_available_at: number | null;
+
+          /**
+           * The status of the last refresh attempt.
+           */
+          status: InferredBalancesRefresh.Status;
+        }
+
+        namespace InferredBalancesRefresh {
+          type Status = 'failed' | 'pending' | 'succeeded';
+        }
+
         interface OwnershipRefresh {
           /**
            * The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch.
@@ -257,6 +290,8 @@ declare module 'stripe' {
           | 'other'
           | 'savings';
 
+        type Subscription = 'balance' | 'inferred_balances' | 'transactions';
+
         type SupportedPaymentMethodType = 'link' | 'us_bank_account';
 
         interface TransactionRefresh {