stripe 20.1.0-beta.1 → 20.1.0

package/types/Charges.d.ts

@@ -4,7 +4,7 @@ declare module 'stripe' {
   namespace Stripe {
     /**
      * The `Charge` object represents a single attempt to move money into your Stripe account.
-     * PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://stripe.com/docs/connect/account-debits) may also create Charges.
+     * PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges.
      * Some legacy payment flows create Charges directly, which is not recommended for new integrations.
      */
     interface Charge {
@@ -19,7 +19,7 @@ declare module 'stripe' {
       object: 'charge';
 
       /**
-       * Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
+       * Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
        */
       amount: number;
 
@@ -39,12 +39,12 @@ declare module 'stripe' {
       application: string | Stripe.Application | null;
 
       /**
-       * The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
+       * The application fee (if any) for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details.
        */
       application_fee: string | Stripe.ApplicationFee | null;
 
       /**
-       * The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details.
+       * The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details.
        */
       application_fee_amount: number | null;
 
@@ -101,7 +101,7 @@ declare module 'stripe' {
       failure_balance_transaction: string | Stripe.BalanceTransaction | null;
 
       /**
-       * Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes).
+       * Error code explaining reason for charge failure if available (see [the errors section](https://docs.stripe.com/error-codes) for a list of codes).
        */
       failure_code: string | null;
 
@@ -123,17 +123,17 @@ 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;
 
       /**
-       * The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
+       * The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.
        */
       on_behalf_of: string | Stripe.Account | null;
 
       /**
-       * Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details.
+       * Details about whether the payment was accepted, and why. See [understanding declines](https://docs.stripe.com/declines) for details.
        */
       outcome: Charge.Outcome | null;
 
@@ -160,7 +160,7 @@ declare module 'stripe' {
       presentment_details?: Charge.PresentmentDetails;
 
       /**
-       * Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.
+       * Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information.
        */
       radar_options?: Charge.RadarOptions;
 
@@ -232,12 +232,12 @@ declare module 'stripe' {
       transfer?: string | Stripe.Transfer;
 
       /**
-       * An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details.
+       * An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details.
        */
       transfer_data: Charge.TransferData | null;
 
       /**
-       * A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details.
+       * A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details.
        */
       transfer_group: string | null;
     }
@@ -314,7 +314,7 @@ declare module 'stripe' {
 
       interface Outcome {
         /**
-         * An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines).
+         * An enumerated value providing a more detailed explanation on [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines).
          */
         advice_code: Outcome.AdviceCode | null;
 
@@ -329,12 +329,12 @@ declare module 'stripe' {
         network_decline_code: string | null;
 
         /**
-         * Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
+         * Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://docs.stripe.com/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.
          */
         network_status: string | null;
 
         /**
-         * An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details.
+         * An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://docs.stripe.com/declines) for more details.
          */
         reason: string | null;
 
@@ -359,7 +359,7 @@ declare module 'stripe' {
         seller_message: string | null;
 
         /**
-         * Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details.
+         * Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://docs.stripe.com/declines) and [Radar reviews](https://docs.stripe.com/radar/reviews) for details.
          */
         type: string;
       }
@@ -433,12 +433,8 @@ declare module 'stripe' {
 
         giropay?: PaymentMethodDetails.Giropay;
 
-        gopay?: PaymentMethodDetails.Gopay;
-
         grabpay?: PaymentMethodDetails.Grabpay;
 
-        id_bank_transfer?: PaymentMethodDetails.IdBankTransfer;
-
         ideal?: PaymentMethodDetails.Ideal;
 
         interac_present?: PaymentMethodDetails.InteracPresent;
@@ -475,18 +471,12 @@ declare module 'stripe' {
 
         paypal?: PaymentMethodDetails.Paypal;
 
-        paypay?: PaymentMethodDetails.Paypay;
-
         payto?: PaymentMethodDetails.Payto;
 
         pix?: PaymentMethodDetails.Pix;
 
         promptpay?: PaymentMethodDetails.Promptpay;
 
-        qris?: PaymentMethodDetails.Qris;
-
-        rechnung?: PaymentMethodDetails.Rechnung;
-
         revolut_pay?: PaymentMethodDetails.RevolutPay;
 
         samsung_pay?: PaymentMethodDetails.SamsungPay;
@@ -497,20 +487,16 @@ declare module 'stripe' {
 
         sepa_debit?: PaymentMethodDetails.SepaDebit;
 
-        shopeepay?: PaymentMethodDetails.Shopeepay;
-
         sofort?: PaymentMethodDetails.Sofort;
 
         stripe_account?: PaymentMethodDetails.StripeAccount;
 
-        stripe_balance?: PaymentMethodDetails.StripeBalance;
-
         swish?: PaymentMethodDetails.Swish;
 
         twint?: PaymentMethodDetails.Twint;
 
         /**
-         * The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
+         * The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types.
          * An additional hash is included on `payment_method_details` with a name matching this value.
          * It contains information specific to the payment method.
          */
@@ -590,6 +576,11 @@ declare module 'stripe' {
            */
           bank_name: string | null;
 
+          /**
+           * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+           */
+          expected_debit_date?: string;
+
           /**
            * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
            */
@@ -618,12 +609,12 @@ declare module 'stripe' {
 
         interface Affirm {
           /**
-           * ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
+           * ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to.
            */
           location?: string;
 
           /**
-           * ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
+           * ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on.
            */
           reader?: string;
 
@@ -706,11 +697,6 @@ declare module 'stripe' {
                */
               brand: string | null;
 
-              /**
-               * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
-               */
-              brand_product?: string | null;
-
               /**
                * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
                */
@@ -745,6 +731,11 @@ declare module 'stripe' {
            */
           bsb_number: string | null;
 
+          /**
+           * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+           */
+          expected_debit_date?: string;
+
           /**
            * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
            */
@@ -762,6 +753,11 @@ declare module 'stripe' {
         }
 
         interface BacsDebit {
+          /**
+           * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+           */
+          expected_debit_date?: string;
+
           /**
            * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
            */
@@ -858,11 +854,6 @@ declare module 'stripe' {
            */
           amount_authorized: number | null;
 
-          /**
-           * The latest amount intended to be authorized by this charge.
-           */
-          amount_requested?: number | null;
-
           /**
            * Authorization code on the charge.
            */
@@ -888,8 +879,6 @@ declare module 'stripe' {
            */
           country: string | null;
 
-          decremental_authorization?: Card.DecrementalAuthorization;
-
           /**
            * A high-level description of the type of cards issued in this range. (For internal use only and not typically available in standard API requests.)
            */
@@ -929,7 +918,7 @@ declare module 'stripe' {
           /**
            * Installment details for this payment.
            *
-           * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
+           * For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments).
            */
           installments: Card.Installments | null;
 
@@ -972,8 +961,6 @@ declare module 'stripe' {
 
           overcapture?: Card.Overcapture;
 
-          partial_authorization?: Card.PartialAuthorization;
-
           /**
            * Status of a card based on the card issuer.
            */
@@ -1008,17 +995,6 @@ declare module 'stripe' {
             cvc_check: string | null;
           }
 
-          interface DecrementalAuthorization {
-            /**
-             * Indicates whether or not the decremental authorization feature is supported.
-             */
-            status: DecrementalAuthorization.Status;
-          }
-
-          namespace DecrementalAuthorization {
-            type Status = 'available' | 'unavailable';
-          }
-
           interface ExtendedAuthorization {
             /**
              * Indicates whether or not the capture window is extended beyond the standard authorization.
@@ -1106,21 +1082,6 @@ declare module 'stripe' {
             type Status = 'available' | 'unavailable';
           }
 
-          interface PartialAuthorization {
-            /**
-             * Indicates whether the transaction requested for partial authorization feature and the authorization outcome.
-             */
-            status: PartialAuthorization.Status;
-          }
-
-          namespace PartialAuthorization {
-            type Status =
-              | 'declined'
-              | 'fully_authorized'
-              | 'not_requested'
-              | 'partially_authorized';
-          }
-
           type RegulatedStatus = 'regulated' | 'unregulated';
 
           interface ThreeDSecure {
@@ -1363,7 +1324,7 @@ declare module 'stripe' {
           iin?: string | null;
 
           /**
-           * Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
+           * Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
            */
           incremental_authorization_supported: boolean;
 
@@ -1660,8 +1621,6 @@ declare module 'stripe' {
           verified_name: string | null;
         }
 
-        interface Gopay {}
-
         interface Grabpay {
           /**
            * Unique transaction id generated by GrabPay
@@ -1669,40 +1628,9 @@ declare module 'stripe' {
           transaction_id: string | null;
         }
 
-        interface IdBankTransfer {
-          /**
-           * Account number of the bank account to transfer funds to.
-           */
-          account_number: string;
-
-          /**
-           * Bank where the account is located.
-           */
-          bank: IdBankTransfer.Bank;
-
-          /**
-           * Local bank code of the bank.
-           */
-          bank_code?: string;
-
-          /**
-           * Name of the bank associated with the bank account.
-           */
-          bank_name?: string;
-
-          /**
-           * Merchant name and billing details name, for the customer to check for the correct merchant when performing the bank transfer.
-           */
-          display_name?: string;
-        }
-
-        namespace IdBankTransfer {
-          type Bank = 'bca' | 'bni' | 'bri' | 'cimb' | 'permata';
-        }
-
         interface Ideal {
           /**
-           * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
+           * The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
            */
           bank: Ideal.Bank | null;
 
@@ -1748,6 +1676,7 @@ declare module 'stripe' {
             | 'handelsbanken'
             | 'ing'
             | 'knab'
+            | 'mollie'
             | 'moneyou'
             | 'n26'
             | 'nn'
@@ -1770,6 +1699,7 @@ declare module 'stripe' {
             | 'HANDNL2A'
             | 'INGBNL2A'
             | 'KNABNL2H'
+            | 'MLLENL2A'
             | 'MOYONL21'
             | 'NNBANL2G'
             | 'NTSBDEB1'
@@ -2143,6 +2073,11 @@ declare module 'stripe' {
            */
           branch_code: string;
 
+          /**
+           * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+           */
+          expected_debit_date?: string;
+
           /**
            * Last four digits of the bank account number.
            */
@@ -2226,12 +2161,12 @@ declare module 'stripe' {
 
         interface Paynow {
           /**
-           * ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
+           * ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to.
            */
           location?: string;
 
           /**
-           * ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
+           * ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on.
            */
           reader?: string;
 
@@ -2269,36 +2204,10 @@ declare module 'stripe' {
            */
           seller_protection: Paypal.SellerProtection | null;
 
-          /**
-           * The shipping address for the customer, as supplied by the merchant at the point of payment
-           * execution. This shipping address will not be updated if the merchant updates the shipping
-           * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
-           */
-          shipping?: Stripe.Address | null;
-
           /**
            * A unique ID generated by PayPal for this transaction.
            */
           transaction_id: string | null;
-
-          /**
-           * The shipping address for the customer, as supplied by the merchant at the point of payment
-           * execution. This shipping address will not be updated if the merchant updates the shipping
-           * address on the PaymentIntent after the PaymentIntent was successfully confirmed.
-           */
-          verified_address?: Stripe.Address | null;
-
-          /**
-           * Owner's verified email. Values are verified or provided by PayPal directly
-           * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
-           */
-          verified_email?: string | null;
-
-          /**
-           * Owner's verified full name. Values are verified or provided by PayPal directly
-           * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
-           */
-          verified_name?: string | null;
         }
 
         namespace Paypal {
@@ -2321,8 +2230,6 @@ declare module 'stripe' {
           }
         }
 
-        interface Paypay {}
-
         interface Payto {
           /**
            * Bank-State-Branch number of the bank account.
@@ -2350,11 +2257,6 @@ declare module 'stripe' {
            * Unique transaction id generated by BCB
            */
           bank_transaction_id?: string | null;
-
-          /**
-           * ID of the multi use Mandate generated by the PaymentIntent
-           */
-          mandate?: string;
         }
 
         interface Promptpay {
@@ -2364,15 +2266,6 @@ declare module 'stripe' {
           reference: string | null;
         }
 
-        interface Qris {}
-
-        interface Rechnung {
-          /**
-           * Payment portal URL.
-           */
-          payment_portal_url: string | null;
-        }
-
         interface RevolutPay {
           funding?: RevolutPay.Funding;
 
@@ -2399,11 +2292,6 @@ declare module 'stripe' {
                */
               brand: string | null;
 
-              /**
-               * The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
-               */
-              brand_product?: string | null;
-
               /**
                * Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
                */
@@ -2484,6 +2372,11 @@ declare module 'stripe' {
            */
           country: string | null;
 
+          /**
+           * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+           */
+          expected_debit_date?: string;
+
           /**
            * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
            */
@@ -2495,13 +2388,11 @@ declare module 'stripe' {
           last4: string | null;
 
           /**
-           * Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).
+           * Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve).
            */
           mandate: string | null;
         }
 
-        interface Shopeepay {}
-
         interface Sofort {
           /**
            * Bank code of bank associated with the bank account.
@@ -2564,22 +2455,6 @@ declare module 'stripe' {
 
         interface StripeAccount {}
 
-        interface StripeBalance {
-          /**
-           * The connected account ID whose Stripe balance to use as the source of payment
-           */
-          account?: string | null;
-
-          /**
-           * The [source_type](https://docs.stripe.com/api/balance/balance_object#balance_object-available-source_types) of the balance
-           */
-          source_type: StripeBalance.SourceType;
-        }
-
-        namespace StripeBalance {
-          type SourceType = 'bank_account' | 'card' | 'fpx';
-        }
-
         interface Swish {
           /**
            * Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer
@@ -2615,6 +2490,11 @@ declare module 'stripe' {
            */
           bank_name: string | null;
 
+          /**
+           * Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format.
+           */
+          expected_debit_date?: string;
+
           /**
            * Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
            */
@@ -2656,12 +2536,12 @@ declare module 'stripe' {
           fingerprint: string | null;
 
           /**
-           * ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to.
+           * ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to.
            */
           location?: string;
 
           /**
-           * ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on.
+           * ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on.
            */
           reader?: string;
 
@@ -2688,7 +2568,7 @@ declare module 'stripe' {
 
       interface RadarOptions {
         /**
-         * A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
+         * A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
          */
         session?: string;
       }