stripe 9.0.0 → 9.3.0

package/types/2020-08-27/Apps/Secrets.d.ts

@@ -0,0 +1,241 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace Apps {
+      /**
+       * The Secret object.
+       */
+      interface Secret {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'apps.secret';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * If true, indicates that this secret has been deleted
+         */
+        deleted?: boolean;
+
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
+        /**
+         * A name for the secret that's unique within the scope.
+         */
+        name: string;
+
+        /**
+         * The plaintext secret value to be stored.
+         */
+        payload: string | null;
+
+        scope: Secret.Scope;
+      }
+
+      namespace Secret {
+        interface Scope {
+          /**
+           * The secret scope type.
+           */
+          type: Scope.Type;
+
+          /**
+           * The user ID, if type is set to "user"
+           */
+          user?: string;
+        }
+
+        namespace Scope {
+          type Type = 'account' | 'user';
+        }
+      }
+
+      interface SecretCreateParams {
+        /**
+         * A name for the secret that's unique within the scope.
+         */
+        name: string;
+
+        /**
+         * The plaintext secret value to be stored.
+         */
+        payload: string;
+
+        /**
+         * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+         */
+        scope: SecretCreateParams.Scope;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace SecretCreateParams {
+        interface Scope {
+          /**
+           * The secret scope type.
+           */
+          type: Scope.Type;
+
+          /**
+           * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+           */
+          user?: string;
+        }
+
+        namespace Scope {
+          type Type = 'account' | 'user';
+        }
+      }
+
+      interface SecretListParams extends PaginationParams {
+        /**
+         * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+         */
+        scope: SecretListParams.Scope;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace SecretListParams {
+        interface Scope {
+          /**
+           * The secret scope type.
+           */
+          type: Scope.Type;
+
+          /**
+           * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+           */
+          user?: string;
+        }
+
+        namespace Scope {
+          type Type = 'account' | 'user';
+        }
+      }
+
+      interface SecretDeleteWhereParams {
+        /**
+         * A name for the secret that's unique within the scope.
+         */
+        name: string;
+
+        /**
+         * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+         */
+        scope: SecretDeleteWhereParams.Scope;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace SecretDeleteWhereParams {
+        interface Scope {
+          /**
+           * The secret scope type.
+           */
+          type: Scope.Type;
+
+          /**
+           * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+           */
+          user?: string;
+        }
+
+        namespace Scope {
+          type Type = 'account' | 'user';
+        }
+      }
+
+      interface SecretFindParams {
+        /**
+         * A name for the secret that's unique within the scope.
+         */
+        name: string;
+
+        /**
+         * Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+         */
+        scope: SecretFindParams.Scope;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
+      namespace SecretFindParams {
+        interface Scope {
+          /**
+           * The secret scope type.
+           */
+          type: Scope.Type;
+
+          /**
+           * The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+           */
+          user?: string;
+        }
+
+        namespace Scope {
+          type Type = 'account' | 'user';
+        }
+      }
+
+      class SecretsResource {
+        /**
+         * Create or replace a secret in the secret store.
+         */
+        create(
+          params: SecretCreateParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Apps.Secret>>;
+
+        /**
+         * List all secrets stored on the given scope.
+         */
+        list(
+          params: SecretListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.Apps.Secret>;
+
+        /**
+         * Deletes a secret from the secret store by name and scope.
+         */
+        deleteWhere(
+          params: SecretDeleteWhereParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Apps.Secret>>;
+
+        /**
+         * Finds a secret in the secret store by name and scope.
+         */
+        find(
+          params: SecretFindParams,
+          options?: RequestOptions
+        ): Promise<Stripe.Response<Stripe.Apps.Secret>>;
+      }
+    }
+  }
+}

package/types/2020-08-27/BillingPortal/Configurations.d.ts

@@ -322,7 +322,7 @@ declare module 'stripe' {
             /**
              * The types of customer updates that are supported. When empty, customers are not updateable.
              */
-            allowed_updates: Stripe.Emptyable<
+            allowed_updates?: Stripe.Emptyable<
               Array<CustomerUpdate.AllowedUpdate>
             >;
 

package/types/2020-08-27/BillingPortal/Sessions.d.ts

@@ -50,7 +50,7 @@ declare module 'stripe' {
         /**
          * The URL to redirect customers to when they click on the portal's link to return to your website.
          */
-        return_url: string;
+        return_url: string | null;
 
         /**
          * The short-lived URL of the session that gives customers access to the customer portal.

package/types/2020-08-27/Charges.d.ts

@@ -388,6 +388,8 @@ declare module 'stripe' {
 
         acss_debit?: PaymentMethodDetails.AcssDebit;
 
+        affirm?: PaymentMethodDetails.Affirm;
+
         afterpay_clearpay?: PaymentMethodDetails.AfterpayClearpay;
 
         alipay?: PaymentMethodDetails.Alipay;
@@ -422,6 +424,8 @@ declare module 'stripe' {
 
         konbini?: PaymentMethodDetails.Konbini;
 
+        link?: PaymentMethodDetails.Link;
+
         multibanco?: PaymentMethodDetails.Multibanco;
 
         oxxo?: PaymentMethodDetails.Oxxo;
@@ -543,6 +547,8 @@ declare module 'stripe' {
           transit_number: string | null;
         }
 
+        interface Affirm {}
+
         interface AfterpayClearpay {
           /**
            * Order identifier shown to the merchant in Afterpay's online portal.
@@ -1469,6 +1475,8 @@ declare module 'stripe' {
           }
         }
 
+        interface Link {}
+
         interface Multibanco {
           /**
            * Entity number associated with this Multibanco payment.

package/types/2020-08-27/Checkout/Sessions.d.ts

@@ -449,14 +449,34 @@ declare module 'stripe' {
         interface PaymentMethodOptions {
           acss_debit?: PaymentMethodOptions.AcssDebit;
 
+          afterpay_clearpay?: PaymentMethodOptions.AfterpayClearpay;
+
           alipay?: PaymentMethodOptions.Alipay;
 
+          au_becs_debit?: PaymentMethodOptions.AuBecsDebit;
+
+          bacs_debit?: PaymentMethodOptions.BacsDebit;
+
           boleto?: PaymentMethodOptions.Boleto;
 
+          eps?: PaymentMethodOptions.Eps;
+
+          fpx?: PaymentMethodOptions.Fpx;
+
+          giropay?: PaymentMethodOptions.Giropay;
+
+          grabpay?: PaymentMethodOptions.Grabpay;
+
+          klarna?: PaymentMethodOptions.Klarna;
+
           konbini?: PaymentMethodOptions.Konbini;
 
           oxxo?: PaymentMethodOptions.Oxxo;
 
+          paynow?: PaymentMethodOptions.Paynow;
+
+          sepa_debit?: PaymentMethodOptions.SepaDebit;
+
           us_bank_account?: PaymentMethodOptions.UsBankAccount;
         }
 
@@ -511,8 +531,14 @@ declare module 'stripe' {
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
           }
 
+          interface AfterpayClearpay {}
+
           interface Alipay {}
 
+          interface AuBecsDebit {}
+
+          interface BacsDebit {}
+
           interface Boleto {
             /**
              * The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
@@ -520,6 +546,16 @@ declare module 'stripe' {
             expires_after_days: number;
           }
 
+          interface Eps {}
+
+          interface Fpx {}
+
+          interface Giropay {}
+
+          interface Grabpay {}
+
+          interface Klarna {}
+
           interface Konbini {
             /**
              * The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
@@ -534,6 +570,10 @@ declare module 'stripe' {
             expires_after_days: number;
           }
 
+          interface Paynow {}
+
+          interface SepaDebit {}
+
           interface UsBankAccount {
             financial_connections?: UsBankAccount.FinancialConnections;
 
@@ -913,9 +953,8 @@ declare module 'stripe' {
               amount: number;
 
               /**
-               * A discount represents the actual application of a coupon to a particular
-               * customer. It contains information about when the discount began and when it
-               * will end.
+               * A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
+               * It contains information about when the discount began, when it will end, and what it is applied to.
                *
                * Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).
                */
@@ -1079,6 +1118,8 @@ declare module 'stripe' {
         /**
          * A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
          *
+         * Do not include this attribute if you prefer to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
+         *
          * Read more about the supported payment methods and their requirements in our [payment
          * method details guide](https://stripe.com/docs/payments/checkout/payment-methods).
          *
@@ -2157,6 +2198,13 @@ declare module 'stripe' {
            */
           default_tax_rates?: Array<string>;
 
+          /**
+           * The subscription's description, meant to be displayable to the customer.
+           * Use this field to optionally store an explanation of the subscription
+           * for rendering in Stripe hosted surfaces.
+           */
+          description?: string;
+
           /**
            * A list of items, each with an attached plan, that the customer is subscribing to. Prefer using `line_items`.
            */

package/types/2020-08-27/Customers.d.ts

@@ -810,6 +810,7 @@ declare module 'stripe' {
     namespace CustomerListPaymentMethodsParams {
       type Type =
         | 'acss_debit'
+        | 'affirm'
         | 'afterpay_clearpay'
         | 'alipay'
         | 'au_becs_debit'
@@ -826,6 +827,7 @@ declare module 'stripe' {
         | 'ideal'
         | 'klarna'
         | 'konbini'
+        | 'link'
         | 'oxxo'
         | 'p24'
         | 'paynow'
@@ -835,6 +837,13 @@ declare module 'stripe' {
         | 'wechat_pay';
     }
 
+    interface CustomerRetrievePaymentMethodParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
     interface CustomerSearchParams {
       /**
        * The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers).
@@ -948,6 +957,21 @@ declare module 'stripe' {
         options?: RequestOptions
       ): ApiListPromise<Stripe.PaymentMethod>;
 
+      /**
+       * Retrieves a PaymentMethod object.
+       */
+      retrievePaymentMethod(
+        customerId: string,
+        id: string,
+        params?: CustomerRetrievePaymentMethodParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentMethod>>;
+      retrievePaymentMethod(
+        customerId: string,
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentMethod>>;
+
       /**
        * Search for customers you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
        * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating

package/types/2020-08-27/Discounts.d.ts

@@ -23,8 +23,8 @@ declare module 'stripe' {
 
       /**
        * A coupon contains information about a percent-off or amount-off discount you
-       * might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or
-       * [orders](https://stripe.com/docs/api#create_order_legacy-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge).
+       * might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
+       * [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
        */
       coupon: Stripe.Coupon;
 
@@ -87,8 +87,8 @@ declare module 'stripe' {
 
       /**
        * A coupon contains information about a percent-off or amount-off discount you
-       * might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or
-       * [orders](https://stripe.com/docs/api#create_order_legacy-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge).
+       * might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
+       * [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
        */
       coupon: Stripe.Coupon;
 

package/types/2020-08-27/FinancialConnections/Accounts.d.ts

@@ -247,6 +247,37 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      interface AccountListParams extends PaginationParams {
+        /**
+         * If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
+         */
+        account_holder?: AccountListParams.AccountHolder;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+
+        /**
+         * If present, only return accounts that were collected as part of the given session.
+         */
+        session?: string;
+      }
+
+      namespace AccountListParams {
+        interface AccountHolder {
+          /**
+           * The ID of the Stripe account whose accounts will be retrieved.
+           */
+          account?: string;
+
+          /**
+           * The ID of the Stripe customer whose accounts will be retrieved.
+           */
+          customer?: string;
+        }
+      }
+
       interface AccountDisconnectParams {
         /**
          * Specifies which fields in the response should be expanded.
@@ -254,6 +285,18 @@ declare module 'stripe' {
         expand?: Array<string>;
       }
 
+      interface AccountListOwnersParams extends PaginationParams {
+        /**
+         * The ID of the ownership object to fetch owners from.
+         */
+        ownership: string;
+
+        /**
+         * Specifies which fields in the response should be expanded.
+         */
+        expand?: Array<string>;
+      }
+
       interface AccountRefreshParams {
         /**
          * The list of account features that you would like to refresh. Either: `balance` or `ownership`.
@@ -284,6 +327,17 @@ declare module 'stripe' {
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.FinancialConnections.Account>>;
 
+        /**
+         * Returns a list of Financial Connections Account objects.
+         */
+        list(
+          params?: AccountListParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.FinancialConnections.Account>;
+        list(
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.FinancialConnections.Account>;
+
         /**
          * Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
          */
@@ -297,6 +351,15 @@ declare module 'stripe' {
           options?: RequestOptions
         ): Promise<Stripe.Response<Stripe.FinancialConnections.Account>>;
 
+        /**
+         * Lists all owners for a given Account
+         */
+        listOwners(
+          id: string,
+          params: AccountListOwnersParams,
+          options?: RequestOptions
+        ): ApiListPromise<Stripe.FinancialConnections.AccountOwner>;
+
         /**
          * Refreshes the data associated with a Financial Connections Account.
          */

package/types/2020-08-27/Invoices.d.ts

@@ -745,6 +745,7 @@ declare module 'stripe' {
           | 'grabpay'
           | 'ideal'
           | 'konbini'
+          | 'link'
           | 'paynow'
           | 'sepa_credit_transfer'
           | 'sepa_debit'
@@ -1193,6 +1194,7 @@ declare module 'stripe' {
           | 'grabpay'
           | 'ideal'
           | 'konbini'
+          | 'link'
           | 'paynow'
           | 'sepa_credit_transfer'
           | 'sepa_debit'
@@ -1533,6 +1535,7 @@ declare module 'stripe' {
           | 'grabpay'
           | 'ideal'
           | 'konbini'
+          | 'link'
           | 'paynow'
           | 'sepa_credit_transfer'
           | 'sepa_debit'

package/types/2020-08-27/Issuing/Authorizations.d.ts

@@ -104,6 +104,11 @@ declare module 'stripe' {
          */
         transactions: Array<Stripe.Issuing.Transaction>;
 
+        /**
+         * [Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts).
+         */
+        treasury?: Authorization.Treasury | null;
+
         verification_data: Authorization.VerificationData;
 
         /**
@@ -278,6 +283,23 @@ declare module 'stripe' {
 
         type Status = 'closed' | 'pending' | 'reversed';
 
+        interface Treasury {
+          /**
+           * The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization
+           */
+          received_credits: Array<string>;
+
+          /**
+           * The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization
+           */
+          received_debits: Array<string>;
+
+          /**
+           * The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization
+           */
+          transaction: string | null;
+        }
+
         interface VerificationData {
           /**
            * Whether the cardholder provided an address first line and if it matched the cardholder's `billing.address.line1`.

package/types/2020-08-27/Issuing/Cards.d.ts

@@ -59,6 +59,11 @@ declare module 'stripe' {
          */
         exp_year: number;
 
+        /**
+         * The financial account this card is attached to.
+         */
+        financial_account?: string | null;
+
         /**
          * The last 4 digits of the card number.
          */
@@ -1180,6 +1185,8 @@ declare module 'stripe' {
          */
         expand?: Array<string>;
 
+        financial_account?: 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`.
          */