stripe 18.4.0-beta.1 → 18.4.0

package/types/Events.d.ts

@@ -21,59 +21,6 @@ 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.
@@ -93,27 +40,15 @@ 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'
@@ -154,15 +89,11 @@ 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'
@@ -178,11 +109,8 @@ 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'
@@ -197,9 +125,7 @@ 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'
@@ -223,15 +149,10 @@ 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'
@@ -267,26 +188,15 @@ 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'
@@ -315,10 +225,8 @@ 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'
@@ -378,35 +286,23 @@ declare module 'stripe' {
     }
 
     /**
-     * Events are our way of letting you know when something interesting happens in
-     * your account. When an interesting event occurs, we create a new `Event`
-     * object. For example, when a charge succeeds, we create a `charge.succeeded`
-     * event, and when an invoice payment attempt fails, we create an
-     * `invoice.payment_failed` event. Certain API requests might create multiple
-     * events. For example, if you create a new subscription for a
-     * customer, you receive both a `customer.subscription.created` event and a
-     * `charge.succeeded` event.
+     * Snapshot events allow you to track and react to activity in your Stripe integration. When
+     * the state of another API resource changes, Stripe creates an `Event` object that contains
+     * all the relevant information associated with that action, including the affected API
+     * resource. For example, a successful payment triggers a `charge.succeeded` event, which
+     * contains the `Charge` in the event's data property. Some actions trigger multiple events.
+     * For example, if you create a new subscription for a customer, it triggers both a
+     * `customer.subscription.created` event and a `charge.succeeded` event.
      *
-     * Events occur when the state of another API resource changes. The event's data
-     * field embeds the resource's state at the time of the change. For
-     * example, a `charge.succeeded` event contains a charge, and an
-     * `invoice.payment_failed` event contains an invoice.
+     * Configure an event destination in your account to listen for events that represent actions
+     * your integration needs to respond to. Additionally, you can retrieve an individual event or
+     * a list of events from the API.
      *
-     * As with other API resources, you can use endpoints to retrieve an
-     * [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)
-     * from the API. We also have a separate
-     * [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the
-     * `Event` objects directly to an endpoint on your server. You can manage
-     * webhooks in your
-     * [account settings](https://dashboard.stripe.com/account/webhooks). Learn how
-     * to [listen for events](https://docs.stripe.com/webhooks)
-     * so that your integration can automatically trigger reactions.
+     * [Connect](https://docs.stripe.com/connect) platforms can also receive event notifications
+     * that occur in their connected accounts. These events include an account attribute that
+     * identifies the relevant connected account.
      *
-     * When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications
-     * that occur in connected accounts. For these events, there's an
-     * additional `account` attribute in the received `Event` object.
-     *
-     * We only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)
+     * You can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event)
      * for 30 days.
      */
     interface EventBase {
@@ -452,11 +348,6 @@ 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/FinancialConnections/Accounts.d.ts

@@ -47,16 +47,6 @@ 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.
          */
@@ -113,7 +103,7 @@ declare module 'stripe' {
         /**
          * The list of data refresh subscriptions requested on this account.
          */
-        subscriptions: Array<Account.Subscription> | null;
+        subscriptions: Array<'transactions'> | null;
 
         /**
          * The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
@@ -140,8 +130,6 @@ declare module 'stripe' {
            */
           customer?: string | Stripe.Customer;
 
-          customer_account?: string;
-
           /**
            * Type of account holder that this account belongs to.
            */
@@ -232,27 +220,6 @@ 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.
@@ -290,8 +257,6 @@ declare module 'stripe' {
           | 'other'
           | 'savings';
 
-        type Subscription = 'balance' | 'inferred_balances' | 'transactions';
-
         type SupportedPaymentMethodType = 'link' | 'us_bank_account';
 
         interface TransactionRefresh {

package/types/FinancialConnections/AccountsResource.d.ts

@@ -38,11 +38,6 @@ declare module 'stripe' {
            * The ID of the Stripe customer whose accounts will be retrieved.
            */
           customer?: string;
-
-          /**
-           * The Account ID of the Stripe customer whose accounts will be retrieved.
-           */
-          customer_account?: string;
         }
       }
 
@@ -53,13 +48,6 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
-      interface AccountListInferredBalancesParams extends PaginationParams {
-        /**
-         * Specifies which fields in the response should be expanded.
-         */
-        expand?: Array<string>;
-      }
-
       interface AccountListOwnersParams extends PaginationParams {
         /**
          * The ID of the ownership object to fetch owners from.
@@ -85,18 +73,14 @@ declare module 'stripe' {
       }
 
       namespace AccountRefreshParams {
-        type Feature =
-          | 'balance'
-          | 'inferred_balances'
-          | 'ownership'
-          | 'transactions';
+        type Feature = 'balance' | 'ownership' | 'transactions';
       }
 
       interface AccountSubscribeParams {
         /**
          * The list of account features to which you would like to subscribe.
          */
-        features: Array<AccountSubscribeParams.Feature>;
+        features: Array<'transactions'>;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -104,15 +88,11 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
-      namespace AccountSubscribeParams {
-        type Feature = 'balance' | 'inferred_balances' | 'transactions';
-      }
-
       interface AccountUnsubscribeParams {
         /**
          * The list of account features from which you would like to unsubscribe.
          */
-        features: Array<AccountUnsubscribeParams.Feature>;
+        features: Array<'transactions'>;
 
         /**
          * Specifies which fields in the response should be expanded.
@@ -120,10 +100,6 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
-      namespace AccountUnsubscribeParams {
-        type Feature = 'balance' | 'inferred_balances' | 'transactions';
-      }
-
       class AccountsResource {
         /**
          * Retrieves the details of an Financial Connections Account.
@@ -162,19 +138,6 @@ declare module 'stripe' {
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.FinancialConnections.Account>>;
 
-        /**
-         * Lists the recorded inferred balances for a Financial Connections Account.
-         */
-        listInferredBalances(
-          id: string,
-          params?: AccountListInferredBalancesParams,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.FinancialConnections.AccountInferredBalance>;
-        listInferredBalances(
-          id: string,
-          options?: RequestOptions
-        ): ApiListPromise<Stripe.FinancialConnections.AccountInferredBalance>;
-
         /**
          * Lists all owners for a given Account
          */

package/types/FinancialConnections/Sessions.d.ts

@@ -34,15 +34,11 @@ declare module 'stripe' {
 
         filters?: Session.Filters;
 
-        limits?: Session.Limits;
-
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
         livemode: boolean;
 
-        manual_entry?: Session.ManualEntry;
-
         /**
          * Permissions requested for accounts collected during this session.
          */
@@ -57,13 +53,6 @@ declare module 'stripe' {
          * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
          */
         return_url?: string;
-
-        /**
-         * The current state of the session.
-         */
-        status?: Session.Status;
-
-        status_details?: Session.StatusDetails;
       }
 
       namespace Session {
@@ -78,8 +67,6 @@ declare module 'stripe' {
            */
           customer?: string | Stripe.Customer;
 
-          customer_account?: string;
-
           /**
            * Type of account holder that this account belongs to.
            */
@@ -100,11 +87,6 @@ declare module 'stripe' {
            * List of countries from which to filter accounts.
            */
           countries: Array<string> | null;
-
-          /**
-           * Stripe ID of the institution with which the customer should be directed to log in.
-           */
-          institution?: string;
         }
 
         namespace Filters {
@@ -116,45 +98,13 @@ declare module 'stripe' {
             | 'savings';
         }
 
-        interface Limits {
-          /**
-           * The number of accounts that can be linked in this Session.
-           */
-          accounts: number;
-        }
-
-        interface ManualEntry {}
-
         type Permission =
           | 'balances'
           | 'ownership'
           | 'payment_method'
           | 'transactions';
 
-        type Prefetch =
-          | 'balances'
-          | 'inferred_balances'
-          | 'ownership'
-          | 'transactions';
-
-        type Status = 'cancelled' | 'failed' | 'pending' | 'succeeded';
-
-        interface StatusDetails {
-          cancelled?: StatusDetails.Cancelled;
-        }
-
-        namespace StatusDetails {
-          interface Cancelled {
-            /**
-             * The reason for the Session being cancelled.
-             */
-            reason: Cancelled.Reason;
-          }
-
-          namespace Cancelled {
-            type Reason = 'custom_manual_entry' | 'other';
-          }
-        }
+        type Prefetch = 'balances' | 'ownership' | 'transactions';
       }
     }
   }

package/types/FinancialConnections/SessionsResource.d.ts

@@ -26,16 +26,6 @@ declare module 'stripe' {
          */
         filters?: SessionCreateParams.Filters;
 
-        /**
-         * Settings for configuring Session-specific limits.
-         */
-        limits?: SessionCreateParams.Limits;
-
-        /**
-         * Customize manual entry behavior
-         */
-        manual_entry?: SessionCreateParams.ManualEntry;
-
         /**
          * List of data features that you would like to retrieve upon account creation.
          */
@@ -59,11 +49,6 @@ declare module 'stripe' {
            */
           customer?: string;
 
-          /**
-           * The ID of the Stripe customer Account whose accounts will be retrieved. Should only be present if `type` is `customer`.
-           */
-          customer_account?: string;
-
           /**
            * Type of account holder to collect accounts for.
            */
@@ -84,11 +69,6 @@ declare module 'stripe' {
            * List of countries from which to collect accounts.
            */
           countries?: Array<string>;
-
-          /**
-           * Stripe ID of the institution with which the customer should be directed to log in.
-           */
-          institution?: string;
         }
 
         namespace Filters {
@@ -100,35 +80,13 @@ declare module 'stripe' {
             | 'savings';
         }
 
-        interface Limits {
-          /**
-           * The number of accounts that can be linked in this Session.
-           */
-          accounts: number;
-        }
-
-        interface ManualEntry {
-          /**
-           * Whether manual entry will be handled by Stripe during the Session.
-           */
-          mode?: ManualEntry.Mode;
-        }
-
-        namespace ManualEntry {
-          type Mode = 'automatic' | 'custom';
-        }
-
         type Permission =
           | 'balances'
           | 'ownership'
           | 'payment_method'
           | 'transactions';
 
-        type Prefetch =
-          | 'balances'
-          | 'inferred_balances'
-          | 'ownership'
-          | 'transactions';
+        type Prefetch = 'balances' | 'ownership' | 'transactions';
       }
 
       interface SessionRetrieveParams {

package/types/Identity/VerificationSessions.d.ts

@@ -85,11 +85,6 @@ declare module 'stripe' {
          */
         related_customer: string | null;
 
-        /**
-         * Token referencing a Customer Account resource.
-         */
-        related_customer_account?: string | null;
-
         related_person?: VerificationSession.RelatedPerson;
 
         /**
@@ -255,12 +250,12 @@ declare module 'stripe' {
           /**
            * Token referencing the associated Account of the related Person resource.
            */
-          account?: string;
+          account: string;
 
           /**
            * Token referencing the related Person resource.
            */
-          person?: string;
+          person: string;
         }
 
         type Status = 'canceled' | 'processing' | 'requires_input' | 'verified';

package/types/Identity/VerificationSessionsResource.d.ts

@@ -34,11 +34,6 @@ declare module 'stripe' {
          */
         related_customer?: string;
 
-        /**
-         * Token referencing a Customer Account resource.
-         */
-        related_customer_account?: string;
-
         /**
          * Tokens referencing a Person resource and it's associated account.
          */
@@ -226,8 +221,6 @@ declare module 'stripe' {
 
         related_customer?: string;
 
-        related_customer_account?: string;
-
         /**
          * Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
          */

package/types/InvoiceItems.d.ts

@@ -58,11 +58,6 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
-      /**
-       * The ID of the account who will be billed when this invoice item is billed.
-       */
-      customer_account?: string | null;
-
       /**
        * Time at which the object was created. Measured in seconds since the Unix epoch.
        */
@@ -98,11 +93,6 @@ declare module 'stripe' {
        */
       livemode: boolean;
 
-      /**
-       * The margins which apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
-       */
-      margins?: Array<string | Stripe.Margin> | null;
-
       /**
        * 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.
        */