stripe 20.1.0-alpha.4 → 20.1.0

package/types/Events.d.ts

@@ -5,7 +5,7 @@ declare module 'stripe' {
     namespace Event {
       interface Data {
         /**
-         * Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.
+         * Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://api.stripe.com#invoice_object) as the value of the object key.
          */
         object: Data.Object;
 
@@ -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,8 +40,6 @@ 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'
@@ -105,16 +50,6 @@ declare module 'stripe' {
         | 'billing_portal.configuration.updated'
         | 'billing_portal.session.created'
         | 'capability.updated'
-        | 'capital.financing_offer.accepted'
-        | 'capital.financing_offer.accepted_other_offer'
-        | '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'
@@ -155,15 +90,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'
@@ -180,12 +111,9 @@ 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.account.upcoming_account_number_expiry'
-        | 'financial_connections.session.updated'
-        | 'fx_quote.expired'
         | 'identity.verification_session.canceled'
         | 'identity.verification_session.created'
         | 'identity.verification_session.processing'
@@ -200,7 +128,6 @@ declare module 'stripe' {
         | 'invoice.overdue'
         | 'invoice.overpaid'
         | 'invoice.paid'
-        | 'invoice.payment.overpaid'
         | 'invoice.payment_action_required'
         | 'invoice.payment_attempt_required'
         | 'invoice.payment_failed'
@@ -226,15 +153,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'
@@ -270,26 +192,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'
@@ -318,10 +229,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'
@@ -443,11 +352,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/ExchangeRates.d.ts

@@ -11,13 +11,13 @@ declare module 'stripe' {
      * rate (for example, to dynamically price an item for a user with a default
      * payment in a foreign currency).
      *
-     * Please refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details.
+     * Please refer to our [Exchange Rates API](https://docs.stripe.com/fx-rates) guide for more details.
      *
      * *[Note: this integration path is supported but no longer recommended]* Additionally,
      * you can guarantee that a charge is made with an exchange rate that you expect is
      * current. To do so, you must pass in the exchange_rate to charges endpoints. If the
      * value is no longer up to date, the charge won't go through. Please refer to our
-     * [Using with charges](https://stripe.com/docs/exchange-rates) guide for more details.
+     * [Using with charges](https://docs.stripe.com/exchange-rates) guide for more details.
      *
      * -----
      *

package/types/FeeRefunds.d.ts

@@ -7,7 +7,7 @@ declare module 'stripe' {
      * has previously been created but not yet refunded. Funds will be refunded to
      * the Stripe account from which the fee was originally collected.
      *
-     * Related guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)
+     * Related guide: [Refunding application fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee)
      */
     interface FeeRefund {
       /**
@@ -46,7 +46,7 @@ declare module 'stripe' {
       fee: string | Stripe.ApplicationFee;
 
       /**
-       * 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.
+       * Set of [key-value pairs](https://docs.stripe.com/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.Metadata | null;
     }

package/types/FileLinks.d.ts

@@ -44,7 +44,7 @@ declare module 'stripe' {
       livemode: boolean;
 
       /**
-       * 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.
+       * Set of [key-value pairs](https://docs.stripe.com/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.Metadata;
 

package/types/FileLinksResource.d.ts

@@ -19,7 +19,7 @@ declare module 'stripe' {
       expires_at?: number;
 
       /**
-       * 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`.
+       * Set of [key-value pairs](https://docs.stripe.com/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>;
     }
@@ -43,7 +43,7 @@ declare module 'stripe' {
       expires_at?: Stripe.Emptyable<'now' | number>;
 
       /**
-       * 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`.
+       * Set of [key-value pairs](https://docs.stripe.com/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>;
     }

package/types/Files.d.ts

@@ -4,12 +4,12 @@ declare module 'stripe' {
   namespace Stripe {
     /**
      * This object represents files hosted on Stripe's servers. You can upload
-     * files with the [create file](https://stripe.com/docs/api#create_file) request
+     * files with the [create file](https://api.stripe.com#create_file) request
      * (for example, when uploading dispute evidence). Stripe also
      * creates files independently (for example, the results of a [Sigma scheduled
      * query](https://docs.stripe.com/api#scheduled_queries)).
      *
-     * Related guide: [File upload guide](https://stripe.com/docs/file-upload)
+     * Related guide: [File upload guide](https://docs.stripe.com/file-upload)
      */
     interface File {
       /**
@@ -38,12 +38,12 @@ declare module 'stripe' {
       filename: string | null;
 
       /**
-       * A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.
+       * A list of [file links](https://api.stripe.com#file_links) that point at this file.
        */
       links?: ApiList<Stripe.FileLink> | null;
 
       /**
-       * The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
+       * The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file.
        */
       purpose: File.Purpose;
 

package/types/FilesResource.d.ts

@@ -9,7 +9,7 @@ declare module 'stripe' {
       file: FileData;
 
       /**
-       * The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
+       * The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file.
        */
       purpose: FileCreateParams.Purpose;
 
@@ -19,7 +19,7 @@ declare module 'stripe' {
       expand?: Array<string>;
 
       /**
-       * Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.
+       * Optional parameters that automatically create a [file link](https://api.stripe.com#file_links) for the newly created file.
        */
       file_link_data?: FileCreateParams.FileLinkData;
     }
@@ -37,7 +37,7 @@ declare module 'stripe' {
         expires_at?: number;
 
         /**
-         * 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`.
+         * Set of [key-value pairs](https://docs.stripe.com/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>;
       }

package/types/FinancialConnections/Accounts.d.ts

@@ -52,16 +52,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.
          */
@@ -118,10 +108,10 @@ 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.
+         * The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account.
          */
         supported_payment_method_types: Array<
           Account.SupportedPaymentMethodType
@@ -136,12 +126,12 @@ declare module 'stripe' {
       namespace Account {
         interface AccountHolder {
           /**
-           * The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.
+           * The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`.
            */
           account?: string | Stripe.Account;
 
           /**
-           * ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
+           * The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`.
            */
           customer?: string | Stripe.Customer;
 
@@ -265,27 +255,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.
@@ -323,8 +292,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

@@ -30,17 +30,17 @@ declare module 'stripe' {
       namespace AccountListParams {
         interface AccountHolder {
           /**
-           * The ID of the Stripe account whose accounts will be retrieved.
+           * The ID of the Stripe account whose accounts you will retrieve.
            */
           account?: string;
 
           /**
-           * The ID of the Stripe customer whose accounts will be retrieved.
+           * The ID of the Stripe customer whose accounts you will retrieve.
            */
           customer?: string;
 
           /**
-           * The Account ID of the Stripe customer whose accounts will be retrieved.
+           * The ID of the Account representing a customer whose accounts you will retrieve.
            */
           customer_account?: string;
         }
@@ -53,13 +53,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 +78,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 +93,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 +105,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 +143,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,24 +53,17 @@ 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 {
         interface AccountHolder {
           /**
-           * The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`.
+           * The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`.
            */
           account?: string | Stripe.Account;
 
           /**
-           * ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`.
+           * The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`.
            */
           customer?: string | Stripe.Customer;
 
@@ -100,11 +89,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 +100,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';
       }
     }
   }