stripe 17.4.0-beta.1 → 17.4.0-beta.3

package/types/PaymentAttemptRecordsResource.d.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface PaymentAttemptRecordRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface PaymentAttemptRecordListParams {
+      /**
+       * The ID of the Payment Record.
+       */
+      payment_record: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    class PaymentAttemptRecordsResource {
+      /**
+       * Retrieves a Payment Attempt Record with the given ID
+       */
+      retrieve(
+        id: string,
+        params?: PaymentAttemptRecordRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentAttemptRecord>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.PaymentAttemptRecord>>;
+
+      /**
+       * List all the Payment Attempt Records attached to the specified Payment Record.
+       */
+      list(
+        params: PaymentAttemptRecordListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.PaymentAttemptRecord>;
+    }
+  }
+}

package/types/PaymentIntents.d.ts

@@ -156,7 +156,7 @@ declare module 'stripe' {
       payment_method: string | Stripe.PaymentMethod | null;
 
       /**
-       * Information about the payment method configuration used for this PaymentIntent.
+       * Information about the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent.
        */
       payment_method_configuration_details: PaymentIntent.PaymentMethodConfigurationDetails | null;
 
@@ -808,11 +808,25 @@ declare module 'stripe' {
 
           namespace FinancialAddress {
             interface Aba {
+              account_holder_address: Stripe.Address;
+
+              /**
+               * The account holder name
+               */
+              account_holder_name: string;
+
               /**
                * The ABA account number
                */
               account_number: string;
 
+              /**
+               * The account type
+               */
+              account_type: string;
+
+              bank_address: Stripe.Address;
+
               /**
                * The bank name
                */
@@ -825,11 +839,15 @@ declare module 'stripe' {
             }
 
             interface Iban {
+              account_holder_address: Stripe.Address;
+
               /**
                * The name of the person or business that owns the bank account
                */
               account_holder_name: string;
 
+              bank_address: Stripe.Address;
+
               /**
                * The BIC/SWIFT code of the account.
                */
@@ -847,6 +865,8 @@ declare module 'stripe' {
             }
 
             interface SortCode {
+              account_holder_address: Stripe.Address;
+
               /**
                * The name of the person or business that owns the bank account
                */
@@ -857,6 +877,8 @@ declare module 'stripe' {
                */
               account_number: string;
 
+              bank_address: Stripe.Address;
+
               /**
                * The six-digit sort code
                */
@@ -864,6 +886,15 @@ declare module 'stripe' {
             }
 
             interface Spei {
+              account_holder_address: Stripe.Address;
+
+              /**
+               * The account holder name
+               */
+              account_holder_name: string;
+
+              bank_address: Stripe.Address;
+
               /**
                * The three-digit bank code
                */
@@ -891,11 +922,25 @@ declare module 'stripe' {
               | 'zengin';
 
             interface Swift {
+              account_holder_address: Stripe.Address;
+
+              /**
+               * The account holder name
+               */
+              account_holder_name: string;
+
               /**
                * The account number
                */
               account_number: string;
 
+              /**
+               * The account type
+               */
+              account_type: string;
+
+              bank_address: Stripe.Address;
+
               /**
                * The bank name
                */
@@ -916,6 +961,8 @@ declare module 'stripe' {
               | 'zengin';
 
             interface Zengin {
+              account_holder_address: Stripe.Address;
+
               /**
                * The account holder name
                */
@@ -931,6 +978,8 @@ declare module 'stripe' {
                */
               account_type: string | null;
 
+              bank_address: Stripe.Address;
+
               /**
                * The bank code of the account
                */
@@ -2145,6 +2194,7 @@ declare module 'stripe' {
             | 'girocard'
             | 'interac'
             | 'jcb'
+            | 'link'
             | 'mastercard'
             | 'unionpay'
             | 'unknown'
@@ -2992,7 +3042,7 @@ declare module 'stripe' {
 
         interface Swish {
           /**
-           * The order ID displayed in the Swish app after the payment is authorized.
+           * A reference for this payment to be displayed in the Swish app.
            */
           reference: string | null;
 

package/types/PaymentIntentsResource.d.ts

@@ -112,7 +112,7 @@ declare module 'stripe' {
       payment_method?: string;
 
       /**
-       * The ID of the payment method configuration to use with this PaymentIntent.
+       * The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.
        */
       payment_method_configuration?: string;
 
@@ -129,7 +129,7 @@ declare module 'stripe' {
       payment_method_options?: PaymentIntentCreateParams.PaymentMethodOptions;
 
       /**
-       * The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to ["card"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
+       * The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
        */
       payment_method_types?: Array<string>;
 
@@ -2468,6 +2468,7 @@ declare module 'stripe' {
             | 'girocard'
             | 'interac'
             | 'jcb'
+            | 'link'
             | 'mastercard'
             | 'unionpay'
             | 'unknown'
@@ -3569,7 +3570,7 @@ declare module 'stripe' {
 
         interface Swish {
           /**
-           * The order ID displayed in the Swish app after the payment is authorized.
+           * A reference for this payment to be displayed in the Swish app.
            */
           reference?: Stripe.Emptyable<string>;
 
@@ -3920,7 +3921,7 @@ declare module 'stripe' {
       payment_method?: string;
 
       /**
-       * The ID of the payment method configuration to use with this PaymentIntent.
+       * The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent.
        */
       payment_method_configuration?: string;
 
@@ -6223,6 +6224,7 @@ declare module 'stripe' {
             | 'girocard'
             | 'interac'
             | 'jcb'
+            | 'link'
             | 'mastercard'
             | 'unionpay'
             | 'unknown'
@@ -7324,7 +7326,7 @@ declare module 'stripe' {
 
         interface Swish {
           /**
-           * The order ID displayed in the Swish app after the payment is authorized.
+           * A reference for this payment to be displayed in the Swish app.
            */
           reference?: Stripe.Emptyable<string>;
 
@@ -10733,6 +10735,7 @@ declare module 'stripe' {
             | 'girocard'
             | 'interac'
             | 'jcb'
+            | 'link'
             | 'mastercard'
             | 'unionpay'
             | 'unknown'
@@ -11834,7 +11837,7 @@ declare module 'stripe' {
 
         interface Swish {
           /**
-           * The order ID displayed in the Swish app after the payment is authorized.
+           * A reference for this payment to be displayed in the Swish app.
            */
           reference?: Stripe.Emptyable<string>;
 

package/types/PaymentLinks.d.ts

@@ -865,7 +865,7 @@ declare module 'stripe' {
         shipping_rate: string | Stripe.ShippingRate;
       }
 
-      type SubmitType = 'auto' | 'book' | 'donate' | 'pay';
+      type SubmitType = 'auto' | 'book' | 'donate' | 'pay' | 'subscribe';
 
       interface SubscriptionData {
         /**

package/types/PaymentLinksResource.d.ts

@@ -665,7 +665,7 @@ declare module 'stripe' {
       interface ShippingAddressCollection {
         /**
          * An array of two-letter ISO country codes representing which countries Checkout should provide as options for
-         * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.
+         * shipping locations.
          */
         allowed_countries: Array<ShippingAddressCollection.AllowedCountry>;
       }
@@ -918,7 +918,7 @@ declare module 'stripe' {
         shipping_rate?: string;
       }
 
-      type SubmitType = 'auto' | 'book' | 'donate' | 'pay';
+      type SubmitType = 'auto' | 'book' | 'donate' | 'pay' | 'subscribe';
 
       interface SubscriptionData {
         /**
@@ -1134,6 +1134,11 @@ declare module 'stripe' {
         PaymentLinkUpdateParams.ShippingAddressCollection
       >;
 
+      /**
+       * Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`).
+       */
+      submit_type?: PaymentLinkUpdateParams.SubmitType;
+
       /**
        * When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
        */
@@ -1589,7 +1594,7 @@ declare module 'stripe' {
       interface ShippingAddressCollection {
         /**
          * An array of two-letter ISO country codes representing which countries Checkout should provide as options for
-         * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.
+         * shipping locations.
          */
         allowed_countries: Array<ShippingAddressCollection.AllowedCountry>;
       }
@@ -1835,6 +1840,8 @@ declare module 'stripe' {
           | 'ZZ';
       }
 
+      type SubmitType = 'auto' | 'book' | 'donate' | 'pay' | 'subscribe';
+
       interface SubscriptionData {
         /**
          * All invoices will be billed using the specified settings.

package/types/PaymentMethods.d.ts

@@ -271,7 +271,7 @@ declare module 'stripe' {
 
       interface Card {
         /**
-         * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
+         * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
          */
         brand: string;
 
@@ -406,7 +406,7 @@ declare module 'stripe' {
               amount_authorized: number | null;
 
               /**
-               * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
+               * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
                */
               brand: string | null;
 
@@ -488,7 +488,7 @@ declare module 'stripe' {
               last4: string | null;
 
               /**
-               * Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
+               * Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
                */
               network: string | null;
 
@@ -731,7 +731,7 @@ declare module 'stripe' {
 
       interface CardPresent {
         /**
-         * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
+         * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
          */
         brand: string | null;
 

package/types/PaymentRecords.d.ts

@@ -0,0 +1,259 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe.
+     * For example, you can create a Payment Record to model a payment made on a different payment processor,
+     * in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or
+     * more Payment Attempt Records, which represent individual attempts made on a payment network.
+     */
+    interface PaymentRecord {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'payment_record';
+
+      /**
+       * A representation of an amount of money, consisting of an amount and a currency.
+       */
+      amount_canceled: PaymentRecord.AmountCanceled;
+
+      /**
+       * A representation of an amount of money, consisting of an amount and a currency.
+       */
+      amount_failed: PaymentRecord.AmountFailed;
+
+      /**
+       * A representation of an amount of money, consisting of an amount and a currency.
+       */
+      amount_guaranteed: PaymentRecord.AmountGuaranteed;
+
+      /**
+       * A representation of an amount of money, consisting of an amount and a currency.
+       */
+      amount_refunded: PaymentRecord.AmountRefunded;
+
+      /**
+       * A representation of an amount of money, consisting of an amount and a currency.
+       */
+      amount_requested: PaymentRecord.AmountRequested;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * Customer information for this payment.
+       */
+      customer_details: PaymentRecord.CustomerDetails | null;
+
+      /**
+       * Indicates whether the customer was present in your checkout flow during this payment.
+       */
+      customer_presence: PaymentRecord.CustomerPresence | null;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description: string | null;
+
+      /**
+       * ID of the latest Payment Attempt Record attached to this Payment Record.
+       */
+      latest_payment_attempt_record: string;
+
+      /**
+       * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+       */
+      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.
+       */
+      metadata: Stripe.Metadata | null;
+
+      /**
+       * Information about the Payment Method debited for this payment.
+       */
+      payment_method_details: PaymentRecord.PaymentMethodDetails | null;
+
+      /**
+       * An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
+       */
+      payment_reference: string | null;
+
+      /**
+       * Shipping information for this payment.
+       */
+      shipping_details: PaymentRecord.ShippingDetails | null;
+    }
+
+    namespace PaymentRecord {
+      interface AmountCanceled {
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
+         */
+        value: number;
+      }
+
+      interface AmountFailed {
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
+         */
+        value: number;
+      }
+
+      interface AmountGuaranteed {
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
+         */
+        value: number;
+      }
+
+      interface AmountRefunded {
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
+         */
+        value: number;
+      }
+
+      interface AmountRequested {
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
+        currency: string;
+
+        /**
+         * A positive integer representing the amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) e.g., 100 cents for $1.00 or 100 for ¥100, a zero-decimal currency).
+         */
+        value: number;
+      }
+
+      interface CustomerDetails {
+        /**
+         * ID of the Stripe Customer associated with this payment.
+         */
+        customer: string | null;
+
+        /**
+         * The customer's email address.
+         */
+        email: string | null;
+
+        /**
+         * The customer's name.
+         */
+        name: string | null;
+
+        /**
+         * The customer's phone number.
+         */
+        phone: string | null;
+      }
+
+      type CustomerPresence = 'off_session' | 'on_session';
+
+      interface PaymentMethodDetails {
+        /**
+         * The billing details associated with the method of payment.
+         */
+        billing_details: PaymentMethodDetails.BillingDetails | null;
+
+        /**
+         * Information about the custom (user-defined) payment method used to make this payment.
+         */
+        custom: PaymentMethodDetails.Custom | null;
+
+        /**
+         * ID of the Stripe PaymentMethod used to make this payment.
+         */
+        payment_method: string | null;
+
+        /**
+         * The type of Payment Method used for this payment attempt.
+         */
+        type: 'custom';
+      }
+
+      namespace PaymentMethodDetails {
+        interface BillingDetails {
+          /**
+           * A representation of a physical address.
+           */
+          address: Stripe.Address;
+
+          /**
+           * The billing email associated with the method of payment.
+           */
+          email: string | null;
+
+          /**
+           * The billing name associated with the method of payment.
+           */
+          name: string | null;
+
+          /**
+           * The billing phone number associated with the method of payment.
+           */
+          phone: string | null;
+        }
+
+        interface Custom {
+          /**
+           * Display name for the custom (user-defined) payment method type used to make this payment.
+           */
+          display_name: string;
+
+          /**
+           * The custom payment method type associated with this payment.
+           */
+          type: string | null;
+        }
+      }
+
+      interface ShippingDetails {
+        /**
+         * A representation of a physical address.
+         */
+        address: Stripe.Address;
+
+        /**
+         * The shipping recipient's name.
+         */
+        name: string | null;
+
+        /**
+         * The shipping recipient's phone number.
+         */
+        phone: string | null;
+      }
+    }
+  }
+}