stripe 20.2.0-alpha.1 → 20.2.0-alpha.2

package/types/Tax/Registrations.d.ts

@@ -1598,9 +1598,60 @@ declare module 'stripe' {
              * Type of registration in the US.
              */
             type: Us.Type;
+
+            admissions_tax?: Us.AdmissionsTax;
+
+            attendance_tax?: Us.AttendanceTax;
+
+            entertainment_tax?: Us.EntertainmentTax;
+
+            gross_receipts_tax?: Us.GrossReceiptsTax;
+
+            hospitality_tax?: Us.HospitalityTax;
+
+            luxury_tax?: Us.LuxuryTax;
+
+            resort_tax?: Us.ResortTax;
+
+            tourism_tax?: Us.TourismTax;
           }
 
           namespace Us {
+            interface AdmissionsTax {
+              /**
+               * A [jurisdiction code](https://docs.stripe.com/tax/registering?type=admissions_tax#registration-types) representing the local jurisdiction.
+               */
+              jurisdiction: string;
+            }
+
+            interface AttendanceTax {
+              /**
+               * A [jurisdiction code](https://docs.stripe.com/tax/registering?type=attendance_tax#registration-types) representing the local jurisdiction.
+               */
+              jurisdiction: string;
+            }
+
+            interface EntertainmentTax {
+              /**
+               * A [jurisdiction code](https://docs.stripe.com/tax/registering?type=entertainment_tax#registration-types) representing the local jurisdiction.
+               */
+              jurisdiction: string;
+            }
+
+            interface GrossReceiptsTax {
+              /**
+               * A [jurisdiction code](https://docs.stripe.com/tax/registering?type=gross_receipts_tax#registration-types) representing the local jurisdiction.
+               */
+              jurisdiction: string;
+            }
+
+            interface HospitalityTax {
+              /**
+               * A [jurisdiction code](https://docs.stripe.com/tax/registering?type=hospitality_tax#registration-types) representing the local jurisdiction.
+               */
+              jurisdiction: string;
+            }
+
             interface LocalAmusementTax {
               /**
                * A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.
@@ -1615,6 +1666,20 @@ declare module 'stripe' {
               jurisdiction: string;
             }
 
+            interface LuxuryTax {
+              /**
+               * A [jurisdiction code](https://docs.stripe.com/tax/registering?type=luxury_tax#registration-types) representing the local jurisdiction.
+               */
+              jurisdiction: string;
+            }
+
+            interface ResortTax {
+              /**
+               * A [jurisdiction code](https://docs.stripe.com/tax/registering?type=resort_tax#registration-types) representing the local jurisdiction.
+               */
+              jurisdiction: string;
+            }
+
             interface StateSalesTax {
               /**
                * Elections for the state sales tax registration.
@@ -1643,12 +1708,27 @@ declare module 'stripe' {
               }
             }
 
+            interface TourismTax {
+              /**
+               * A [jurisdiction code](https://docs.stripe.com/tax/registering?type=tourism_tax#registration-types) representing the local jurisdiction.
+               */
+              jurisdiction: string;
+            }
+
             type Type =
+              | 'admissions_tax'
+              | 'attendance_tax'
+              | 'entertainment_tax'
+              | 'gross_receipts_tax'
+              | 'hospitality_tax'
               | 'local_amusement_tax'
               | 'local_lease_tax'
+              | 'luxury_tax'
+              | 'resort_tax'
               | 'state_communications_tax'
               | 'state_retail_delivery_fee'
-              | 'state_sales_tax';
+              | 'state_sales_tax'
+              | 'tourism_tax';
           }
 
           interface Uy {

package/types/Tax/RegistrationsResource.d.ts

@@ -2379,11 +2379,19 @@ declare module 'stripe' {
             }
 
             type Type =
+              | 'admissions_tax'
+              | 'attendance_tax'
+              | 'entertainment_tax'
+              | 'gross_receipts_tax'
+              | 'hospitality_tax'
               | 'local_amusement_tax'
               | 'local_lease_tax'
+              | 'luxury_tax'
+              | 'resort_tax'
               | 'state_communications_tax'
               | 'state_retail_delivery_fee'
-              | 'state_sales_tax';
+              | 'state_sales_tax'
+              | 'tourism_tax';
           }
 
           interface Uy {

package/types/Tax/Transactions.d.ts

@@ -353,7 +353,7 @@ declare module 'stripe' {
               type Level = 'city' | 'country' | 'county' | 'district' | 'state';
             }
 
-            type Sourcing = 'destination' | 'origin';
+            type Sourcing = 'destination' | 'origin' | 'performance';
 
             type TaxabilityReason =
               | 'customer_exempt'
@@ -391,19 +391,27 @@ declare module 'stripe' {
 
             namespace TaxRateDetails {
               type TaxType =
+                | 'admissions_tax'
                 | 'amusement_tax'
+                | 'attendance_tax'
                 | 'communications_tax'
+                | 'entertainment_tax'
+                | 'gross_receipts_tax'
                 | 'gst'
+                | 'hospitality_tax'
                 | 'hst'
                 | 'igst'
                 | 'jct'
                 | 'lease_tax'
+                | 'luxury_tax'
                 | 'pst'
                 | 'qst'
+                | 'resort_tax'
                 | 'retail_delivery_fee'
                 | 'rst'
                 | 'sales_tax'
                 | 'service_tax'
+                | 'tourism_tax'
                 | 'vat';
             }
           }

package/types/TaxCodes.d.ts

@@ -25,6 +25,24 @@ declare module 'stripe' {
        * A short name for the tax code.
        */
       name: string;
+
+      /**
+       * An object that describes more information about the tax location required for this tax code. Some [tax codes](https://docs.stripe.com/tax/tax-for-tickets/integration-guide#types-of-products) require a tax location of type `performance` to calculate tax correctly.
+       */
+      requirements?: TaxCode.Requirements | null;
+    }
+
+    namespace TaxCode {
+      interface Requirements {
+        /**
+         * Describes whether a performance location is required for a successful tax calculation with a tax code.
+         */
+        performance_location?: Requirements.PerformanceLocation;
+      }
+
+      namespace Requirements {
+        type PerformanceLocation = 'optional' | 'required';
+      }
     }
   }
 }

package/types/TestHelpers/SharedPayment/GrantedTokensResource.d.ts

@@ -54,7 +54,7 @@ declare module 'stripe' {
       }
 
       namespace SharedPayment {
-        interface GrantedTokenUpdateParams {
+        interface GrantedTokenRevokeParams {
           /**
            * Specifies which fields in the response should be expanded.
            */
@@ -75,9 +75,13 @@ declare module 'stripe' {
           /**
            * Revokes a test SharedPaymentGrantedToken object. This endpoint is only available in test mode and allows sellers to revoke SharedPaymentGrantedTokens for testing their integration
            */
-          update(
+          revoke(
+            id: string,
+            params?: GrantedTokenRevokeParams,
+            options?: RequestOptions
+          ): Promise<Stripe.Response<Stripe.SharedPayment.GrantedToken>>;
+          revoke(
             id: string,
-            params?: GrantedTokenUpdateParams,
             options?: RequestOptions
           ): Promise<Stripe.Response<Stripe.SharedPayment.GrantedToken>>;
         }

package/types/V2/Core/AccountLinksResource.d.ts

@@ -140,6 +140,7 @@ declare module 'stripe' {
         class AccountLinksResource {
           /**
            * Creates an AccountLink object that includes a single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information.
+           * @throws Stripe.RateLimitError
            */
           create(
             params: AccountLinkCreateParams,

package/types/V2/Core/AccountTokensResource.d.ts

@@ -1376,6 +1376,7 @@ declare module 'stripe' {
         class AccountTokensResource {
           /**
            * Creates an Account Token.
+           * @throws Stripe.RateLimitError
            */
           create(
             params?: AccountTokenCreateParams,
@@ -1387,6 +1388,7 @@ declare module 'stripe' {
 
           /**
            * Retrieves an Account Token.
+           * @throws Stripe.RateLimitError
            */
           retrieve(
             id: string,

package/types/V2/Core/Accounts/PersonTokensResource.d.ts

@@ -521,6 +521,7 @@ declare module 'stripe' {
           class PersonTokensResource {
             /**
              * Creates a Person Token associated with an Account.
+             * @throws Stripe.RateLimitError
              */
             create(
               id: string,
@@ -534,6 +535,7 @@ declare module 'stripe' {
 
             /**
              * Retrieves a Person Token associated with an Account.
+             * @throws Stripe.RateLimitError
              */
             retrieve(
               accountId: string,

package/types/V2/Core/Accounts/PersonsResource.d.ts

@@ -1184,6 +1184,7 @@ declare module 'stripe' {
           class PersonsResource {
             /**
              * Create a Person. Adds an individual to an Account's identity. You can set relationship attributes and identity information at creation.
+             * @throws Stripe.RateLimitError
              */
             create(
               id: string,
@@ -1197,6 +1198,7 @@ declare module 'stripe' {
 
             /**
              * Retrieves a Person associated with an Account.
+             * @throws Stripe.RateLimitError
              */
             retrieve(
               accountId: string,
@@ -1212,6 +1214,7 @@ declare module 'stripe' {
 
             /**
              * Updates a Person associated with an Account.
+             * @throws Stripe.RateLimitError
              */
             update(
               accountId: string,
@@ -1222,6 +1225,7 @@ declare module 'stripe' {
 
             /**
              * Returns a paginated list of Persons associated with an Account.
+             * @throws Stripe.RateLimitError
              */
             list(
               id: string,
@@ -1235,6 +1239,7 @@ declare module 'stripe' {
 
             /**
              * Delete a Person associated with an Account.
+             * @throws Stripe.RateLimitError
              */
             del(
               accountId: string,

package/types/V2/Core/AccountsResource.d.ts

@@ -7141,6 +7141,7 @@ declare module 'stripe' {
 
           /**
            * An Account is a representation of a company, individual or other entity that a user interacts with. Accounts contain identifying information about the entity, and configurations that store the features an account has access to. An account can be configured as any or all of the following configurations: Customer, Merchant and/or Recipient.
+           * @throws Stripe.RateLimitError
            */
           create(
             params?: AccountCreateParams,
@@ -7152,6 +7153,7 @@ declare module 'stripe' {
 
           /**
            * Retrieves the details of an Account.
+           * @throws Stripe.RateLimitError
            */
           retrieve(
             id: string,
@@ -7165,6 +7167,7 @@ declare module 'stripe' {
 
           /**
            * Updates the details of an Account.
+           * @throws Stripe.RateLimitError
            */
           update(
             id: string,
@@ -7174,6 +7177,7 @@ declare module 'stripe' {
 
           /**
            * Returns a list of Accounts.
+           * @throws Stripe.RateLimitError
            */
           list(
             params?: AccountListParams,
@@ -7185,6 +7189,7 @@ declare module 'stripe' {
 
           /**
            * Removes access to the Account and its associated resources. Closed Accounts can no longer be operated on, but limited information can still be retrieved through the API in order to be able to track their history.
+           * @throws Stripe.RateLimitError
            */
           close(
             id: string,

package/types/V2/Core/EventTypes.d.ts

@@ -56,6 +56,7 @@ declare module 'stripe' {
       | Stripe.Events.V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEvent
       | Stripe.Events.V2CoreAccountIncludingConfigurationStorerUpdatedEvent
       | Stripe.Events.V2CoreAccountIncludingDefaultsUpdatedEvent
+      | Stripe.Events.V2CoreAccountIncludingFutureRequirementsUpdatedEvent
       | Stripe.Events.V2CoreAccountIncludingIdentityUpdatedEvent
       | Stripe.Events.V2CoreAccountIncludingRequirementsUpdatedEvent
       | Stripe.Events.V2CoreAccountLinkReturnedEvent
@@ -211,6 +212,7 @@ declare module 'stripe' {
       | Stripe.Events.V2CoreAccountIncludingConfigurationStorerCapabilityStatusUpdatedEventNotification
       | Stripe.Events.V2CoreAccountIncludingConfigurationStorerUpdatedEventNotification
       | Stripe.Events.V2CoreAccountIncludingDefaultsUpdatedEventNotification
+      | Stripe.Events.V2CoreAccountIncludingFutureRequirementsUpdatedEventNotification
       | Stripe.Events.V2CoreAccountIncludingIdentityUpdatedEventNotification
       | Stripe.Events.V2CoreAccountIncludingRequirementsUpdatedEventNotification
       | Stripe.Events.V2CoreAccountLinkReturnedEventNotification
@@ -1899,6 +1901,29 @@ declare module 'stripe' {
       fetchEvent(): Promise<V2CoreAccountIncludingDefaultsUpdatedEvent>;
     }
 
+    /**
+     * Occurs when an Account's future requirements are updated.
+     */
+    export interface V2CoreAccountIncludingFutureRequirementsUpdatedEvent
+      extends V2.Core.EventBase {
+      type: 'v2.core.account[future_requirements].updated';
+      // Object containing the reference to API resource relevant to the event.
+      related_object: V2.Core.Events.RelatedObject;
+      // Retrieves the object associated with the event.
+      fetchRelatedObject(): Promise<V2.Core.Account>;
+    }
+    export interface V2CoreAccountIncludingFutureRequirementsUpdatedEventNotification
+      extends V2.Core.EventNotificationBase {
+      type: 'v2.core.account[future_requirements].updated';
+      // Object containing the reference to API resource relevant to the event.
+      related_object: V2.Core.Events.RelatedObject;
+      // Retrieves the object associated with the event.
+      fetchRelatedObject(): Promise<V2.Core.Account>;
+      fetchEvent(): Promise<
+        V2CoreAccountIncludingFutureRequirementsUpdatedEvent
+      >;
+    }
+
     /**
      * Occurs when an Identity is updated.
      */

package/types/V2/Iam/ApiKeysResource.d.ts

@@ -145,7 +145,7 @@ declare module 'stripe' {
       namespace Iam {
         class ApiKeysResource {
           /**
-           * Create an API key.
+           * Create an API key. To create a secret key in livemode, a public key for encryption must be provided.
            */
           create(
             params: ApiKeyCreateParams,
@@ -153,7 +153,7 @@ declare module 'stripe' {
           ): Promise<Stripe.Response<Stripe.V2.Iam.ApiKey>>;
 
           /**
-           * Retrieve an API key.
+           * Retrieve an API key. For livemode secret keys, secret tokens are only returned on creation, and never returned here.
            */
           retrieve(
             id: string,
@@ -166,7 +166,7 @@ declare module 'stripe' {
           ): Promise<Stripe.Response<Stripe.V2.Iam.ApiKey>>;
 
           /**
-           * Update an API key.
+           * Update an API key. Only parameters that are specified in the request will be updated.
            */
           update(
             id: string,
@@ -184,7 +184,7 @@ declare module 'stripe' {
           list(options?: RequestOptions): ApiListPromise<Stripe.V2.Iam.ApiKey>;
 
           /**
-           * Expire an API key.
+           * Expire an API key. The specified key becomes invalid immediately.
            */
           expire(
             id: string,
@@ -197,7 +197,7 @@ declare module 'stripe' {
           ): Promise<Stripe.Response<Stripe.V2.Iam.ApiKey>>;
 
           /**
-           * Rotate an API key.
+           * Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.
            */
           rotate(
             id: string,

package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts

@@ -75,14 +75,14 @@ declare module 'stripe' {
 
           interface DeliveryOptions {
             /**
-             * Open Enum. Method for bank account.
+             * Open Enum. Speed of the payout.
              */
-            bank_account?: DeliveryOptions.BankAccount;
+            speed?: DeliveryOptions.Speed;
 
             /**
-             * Open Enum. Speed of the payout.
+             * Open Enum. Method for bank account.
              */
-            speed?: DeliveryOptions.Speed;
+            bank_account?: DeliveryOptions.BankAccount;
           }
 
           namespace DeliveryOptions {

package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts

@@ -41,14 +41,14 @@ declare module 'stripe' {
 
           interface DeliveryOptions {
             /**
-             * Open Enum. Method for bank account.
+             * Open Enum. Speed of the payout.
              */
-            bank_account?: DeliveryOptions.BankAccount;
+            speed?: DeliveryOptions.Speed;
 
             /**
-             * Open Enum. Speed of the payout.
+             * Open Enum. Method for bank account.
              */
-            speed?: DeliveryOptions.Speed;
+            bank_account?: DeliveryOptions.BankAccount;
           }
 
           namespace DeliveryOptions {

package/types/V2/MoneyManagement/OutboundPayments.d.ts

@@ -117,6 +117,11 @@ declare module 'stripe' {
            * A unique identifier that can be used to track this OutboundPayment with recipient bank. Banks might call this a “reference number” or something similar.
            */
           trace_id: OutboundPayment.TraceId;
+
+          /**
+           * Information to track this OutboundPayment with the recipient bank.
+           */
+          tracking_details?: OutboundPayment.TrackingDetails;
         }
 
         namespace OutboundPayment {
@@ -133,20 +138,46 @@ declare module 'stripe' {
           }
 
           interface DeliveryOptions {
+            /**
+             * Open Enum. Speed of the payout.
+             */
+            speed?: DeliveryOptions.Speed;
+
             /**
              * Open Enum. Method for bank account.
              */
             bank_account?: DeliveryOptions.BankAccount;
 
             /**
-             * Open Enum. Speed of the payout.
+             * Delivery options for paper check.
              */
-            speed?: DeliveryOptions.Speed;
+            paper_check?: DeliveryOptions.PaperCheck;
           }
 
           namespace DeliveryOptions {
             type BankAccount = 'automatic' | 'local' | 'wire';
 
+            interface PaperCheck {
+              /**
+               * Memo printed on the memo field of the check.
+               */
+              memo?: string;
+
+              /**
+               * Open Enum. Shipping speed of the paper check.
+               */
+              shipping_speed: PaperCheck.ShippingSpeed;
+
+              /**
+               * Signature for the paper check.
+               */
+              signature: string;
+            }
+
+            namespace PaperCheck {
+              type ShippingSpeed = 'priority' | 'standard';
+            }
+
             type Speed = 'instant' | 'next_business_day' | 'standard';
           }
 
@@ -323,6 +354,95 @@ declare module 'stripe' {
           namespace TraceId {
             type Status = 'pending' | 'supported' | 'unsupported';
           }
+
+          interface TrackingDetails {
+            /**
+             * Paper check tracking details.
+             */
+            paper_check?: TrackingDetails.PaperCheck;
+          }
+
+          namespace TrackingDetails {
+            interface PaperCheck {
+              /**
+               * Open Enum. Carrier of the paper check.
+               */
+              carrier: PaperCheck.Carrier;
+
+              /**
+               * Check number.
+               */
+              check_number: string;
+
+              /**
+               * Postal code of the latest tracking update.
+               */
+              current_postal_code: string;
+
+              /**
+               * Mailing address of the paper check.
+               */
+              mailing_address: PaperCheck.MailingAddress;
+
+              /**
+               * Tracking number for the check.
+               */
+              tracking_number: string;
+
+              /**
+               * Open Enum. Tracking status of the paper check.
+               */
+              tracking_status: PaperCheck.TrackingStatus;
+
+              /**
+               * When the tracking details were last updated.
+               */
+              updated_at: string;
+            }
+
+            namespace PaperCheck {
+              type Carrier = 'fedex' | 'usps';
+
+              interface MailingAddress {
+                /**
+                 * City, district, suburb, town, or village.
+                 */
+                city?: string;
+
+                /**
+                 * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+                 */
+                country?: string;
+
+                /**
+                 * Address line 1 (e.g., street, PO Box, or company name).
+                 */
+                line1?: string;
+
+                /**
+                 * Address line 2 (e.g., apartment, suite, unit, or building).
+                 */
+                line2?: string;
+
+                /**
+                 * ZIP or postal code.
+                 */
+                postal_code?: string;
+
+                /**
+                 * State, county, province, or region.
+                 */
+                state?: string;
+
+                /**
+                 * Town or district.
+                 */
+                town?: string;
+              }
+
+              type TrackingStatus = 'delivered' | 'in_transit' | 'mailed';
+            }
+          }
         }
       }
     }

package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts

@@ -65,20 +65,46 @@ declare module 'stripe' {
           }
 
           interface DeliveryOptions {
+            /**
+             * Open Enum. Speed of the payout.
+             */
+            speed?: DeliveryOptions.Speed;
+
             /**
              * Open Enum. Method for bank account.
              */
             bank_account?: DeliveryOptions.BankAccount;
 
             /**
-             * Open Enum. Speed of the payout.
+             * Delivery options for paper check.
              */
-            speed?: DeliveryOptions.Speed;
+            paper_check?: DeliveryOptions.PaperCheck;
           }
 
           namespace DeliveryOptions {
             type BankAccount = 'automatic' | 'local' | 'wire';
 
+            interface PaperCheck {
+              /**
+               * Memo printed on the memo field of the check.
+               */
+              memo?: string;
+
+              /**
+               * Open Enum. Shipping speed of the paper check. Defaults to standard.
+               */
+              shipping_speed?: PaperCheck.ShippingSpeed;
+
+              /**
+               * Signature for the paper check.
+               */
+              signature: string;
+            }
+
+            namespace PaperCheck {
+              type ShippingSpeed = 'priority' | 'standard';
+            }
+
             type Speed = 'instant' | 'next_business_day' | 'standard';
           }