stripe 20.1.2 → 20.2.0-alpha.2

package/types/ApplicationFees.d.ts

@@ -94,6 +94,11 @@ declare module 'stripe' {
          */
         payout?: string;
 
+        /**
+         * Transfer ID that created this application fee.
+         */
+        transfer?: string;
+
         /**
          * Type of object that created the application fee.
          */
@@ -101,7 +106,7 @@ declare module 'stripe' {
       }
 
       namespace FeeSource {
-        type Type = 'charge' | 'payout';
+        type Type = 'charge' | 'payout' | 'transfer';
       }
     }
   }

package/types/Balance.d.ts

@@ -44,6 +44,8 @@ declare module 'stripe' {
       pending: Array<Balance.Pending>;
 
       refund_and_dispute_prefunding?: Balance.RefundAndDisputePrefunding;
+
+      transit_balances_total?: Balance.TransitBalancesTotal;
     }
 
     namespace Balance {
@@ -338,6 +340,86 @@ declare module 'stripe' {
           }
         }
       }
+
+      interface TransitBalancesTotal {
+        /**
+         * Funds that are available for use.
+         */
+        available: Array<TransitBalancesTotal.Available>;
+
+        /**
+         * Funds that are pending
+         */
+        pending: Array<TransitBalancesTotal.Pending>;
+      }
+
+      namespace TransitBalancesTotal {
+        interface Available {
+          /**
+           * Balance amount.
+           */
+          amount: number;
+
+          /**
+           * 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;
+
+          source_types?: Available.SourceTypes;
+        }
+
+        namespace Available {
+          interface SourceTypes {
+            /**
+             * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+             */
+            bank_account?: number;
+
+            /**
+             * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+             */
+            card?: number;
+
+            /**
+             * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+             */
+            fpx?: number;
+          }
+        }
+
+        interface Pending {
+          /**
+           * Balance amount.
+           */
+          amount: number;
+
+          /**
+           * 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;
+
+          source_types?: Pending.SourceTypes;
+        }
+
+        namespace Pending {
+          interface SourceTypes {
+            /**
+             * Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated).
+             */
+            bank_account?: number;
+
+            /**
+             * Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits).
+             */
+            card?: number;
+
+            /**
+             * Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method.
+             */
+            fpx?: number;
+          }
+        }
+      }
     }
   }
 }

package/types/BalanceTransactions.d.ts

@@ -94,7 +94,8 @@ declare module 'stripe' {
       type BalanceType =
         | 'issuing'
         | 'payments'
-        | 'refund_and_dispute_prefunding';
+        | 'refund_and_dispute_prefunding'
+        | 'transit';
 
       interface FeeDetail {
         /**

package/types/BalanceTransfers.d.ts

@@ -0,0 +1,122 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Balance transfers represent funds moving between balance types on your Stripe account.
+     * They currently support moving funds between your Stripe balance and your [Issuing](https://docs.stripe.com/issuing) balance and between your [Allocated Funds](https://docs.stripe.com/connect/funds-segregation) balance and your Stripe balance.
+     */
+    interface BalanceTransfer {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'balance_transfer';
+
+      /**
+       * A positive integer representing how much was transferred in the smallest currency unit.
+       */
+      amount: number;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * 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;
+
+      /**
+       * The balance that funds were transferred to.
+       */
+      destination_balance: BalanceTransfer.DestinationBalance | null;
+
+      /**
+       * A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
+       */
+      hosted_regulatory_receipt_url: string | null;
+
+      /**
+       * 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://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 balance that funds were transferred from. One of `card`, `fpx`, or `bank_account`.
+       */
+      source_balance: BalanceTransfer.SourceBalance | null;
+    }
+
+    namespace BalanceTransfer {
+      interface DestinationBalance {
+        issuing?: DestinationBalance.Issuing;
+
+        payments?: DestinationBalance.Payments;
+
+        /**
+         * Destination balance type to adjust for the Balance Transfer. One of `payments`, `issuing`, or `allocated_funds`.
+         */
+        type: string;
+      }
+
+      namespace DestinationBalance {
+        interface Issuing {
+          /**
+           * Identifier for the balance_transaction that increased the destination balance.
+           */
+          balance_transaction?: string | Stripe.BalanceTransaction;
+        }
+
+        interface Payments {
+          /**
+           * Identifier for the balance_transaction that increased the destination balance.
+           */
+          balance_transaction?: string | Stripe.BalanceTransaction;
+        }
+      }
+
+      interface SourceBalance {
+        issuing?: SourceBalance.Issuing;
+
+        payments?: SourceBalance.Payments;
+
+        /**
+         * Source balance type to adjust for the Balance Transfer. One of `payments`, `issuing`, or `allocated_funds`.
+         */
+        type: string;
+      }
+
+      namespace SourceBalance {
+        interface Issuing {
+          /**
+           * Identifier for the balance_transaction that decreased the source balance.
+           */
+          balance_transaction?: string | Stripe.BalanceTransaction;
+        }
+
+        interface Payments {
+          /**
+           * Identifier for the balance_transaction that decreased the source balance.
+           */
+          balance_transaction: string | Stripe.BalanceTransaction;
+
+          /**
+           * The payments balance type that this BalanceTransfer pulled funds from. One of `card`, `fpx`, or `bank_account`.
+           */
+          source_type?: string;
+        }
+      }
+    }
+  }
+}

package/types/BalanceTransfersResource.d.ts

@@ -0,0 +1,87 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface BalanceTransferCreateParams {
+      /**
+       * A positive integer representing how much to transfer in the smallest currency unit.
+       */
+      amount: number;
+
+      /**
+       * 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: BalanceTransferCreateParams.Currency;
+
+      /**
+       * The balance to which funds are transferred.
+       */
+      destination_balance: BalanceTransferCreateParams.DestinationBalance;
+
+      /**
+       * The balance from which funds are transferred, including details specific to the balance you choose.
+       */
+      source_balance: BalanceTransferCreateParams.SourceBalance;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+       */
+      metadata?: Stripe.MetadataParam;
+    }
+
+    namespace BalanceTransferCreateParams {
+      type Currency = 'eur' | 'gbp' | 'usd';
+
+      interface DestinationBalance {
+        /**
+         * Destination balance type to push funds into for the Balance Transfer.
+         */
+        type: DestinationBalance.Type;
+      }
+
+      namespace DestinationBalance {
+        type Type = 'issuing' | 'payments';
+      }
+
+      interface SourceBalance {
+        allocated_funds?: SourceBalance.AllocatedFunds;
+
+        /**
+         * Source balance type to pull funds from for the Balance Transfer.
+         */
+        type: SourceBalance.Type;
+      }
+
+      namespace SourceBalance {
+        interface AllocatedFunds {
+          /**
+           * The charge ID that the funds are originally sourced from. Required if `type` is `charge`.
+           */
+          charge: string;
+
+          /**
+           * The type of object that the funds are originally sourced from. One of `charge`.
+           */
+          type: 'charge';
+        }
+
+        type Type = 'allocated_funds' | 'issuing' | 'payments';
+      }
+    }
+
+    class BalanceTransfersResource {
+      /**
+       * Creates a balance transfer. For Issuing use cases, funds will be debited immediately from the source balance and credited to the destination balance immediately (if your account is based in the US) or next-business-day (if your account is based in the EU). For Segregated Separate Charges and Transfers use cases, funds will be debited immediately from the source balance and credited immediately to the destination balance.
+       */
+      create(
+        params: BalanceTransferCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.BalanceTransfer>>;
+    }
+  }
+}

package/types/BankAccounts.d.ts

@@ -206,6 +206,7 @@ declare module 'stripe' {
             | 'invalid_url_website_other'
             | 'invalid_value_other'
             | 'unsupported_business_type'
+            | 'verification_data_not_found'
             | 'verification_directors_mismatch'
             | 'verification_document_address_mismatch'
             | 'verification_document_address_missing'
@@ -348,6 +349,7 @@ declare module 'stripe' {
             | 'invalid_url_website_other'
             | 'invalid_value_other'
             | 'unsupported_business_type'
+            | 'verification_data_not_found'
             | 'verification_directors_mismatch'
             | 'verification_document_address_mismatch'
             | 'verification_document_address_missing'

package/types/Billing/AlertTriggereds.d.ts

@@ -22,11 +22,26 @@ declare module 'stripe' {
          */
         created: number;
 
+        /**
+         * Currency for the threshold value
+         */
+        currency?: string | null;
+
+        /**
+         * Custom pricing unit for the threshold value
+         */
+        custom_pricing_unit?: string | null;
+
         /**
          * ID of customer for which the alert triggered
          */
         customer: string;
 
+        /**
+         * External customer ID for the customer for which the alert triggered
+         */
+        external_customer_id?: string | null;
+
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
          */
@@ -35,7 +50,7 @@ declare module 'stripe' {
         /**
          * The value triggering the alert
          */
-        value: number;
+        value: string;
       }
     }
   }

package/types/Billing/Alerts.d.ts

@@ -20,7 +20,12 @@ declare module 'stripe' {
         /**
          * Defines the type of the alert.
          */
-        alert_type: 'usage_threshold';
+        alert_type: Alert.AlertType;
+
+        /**
+         * Encapsulates configuration of the alert to monitor billing credit balance.
+         */
+        credit_balance_threshold?: Alert.CreditBalanceThreshold | null;
 
         /**
          * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
@@ -44,6 +49,116 @@ declare module 'stripe' {
       }
 
       namespace Alert {
+        type AlertType = 'credit_balance_threshold' | 'usage_threshold';
+
+        interface CreditBalanceThreshold {
+          /**
+           * The filters allow limiting the scope of this credit balance alert. You must specify only a customer filter at this time.
+           */
+          filters: Array<CreditBalanceThreshold.Filter> | null;
+
+          lte: CreditBalanceThreshold.Lte;
+        }
+
+        namespace CreditBalanceThreshold {
+          interface Filter {
+            /**
+             * Limit the scope of the alert to this customer ID
+             */
+            customer: string | Stripe.Customer | null;
+
+            type: Filter.Type;
+          }
+
+          namespace Filter {
+            type Type = 'customer' | 'tenant';
+          }
+
+          interface Lte {
+            /**
+             * The type of this balance. We currently only support `monetary` amounts.
+             */
+            balance_type: Lte.BalanceType;
+
+            /**
+             * The custom pricing unit amount.
+             */
+            custom_pricing_unit?: Lte.CustomPricingUnit | null;
+
+            /**
+             * The monetary amount.
+             */
+            monetary: Lte.Monetary | null;
+          }
+
+          namespace Lte {
+            type BalanceType = 'custom_pricing_unit' | 'monetary';
+
+            interface CustomPricingUnit {
+              /**
+               * The custom pricing unit object.
+               */
+              custom_pricing_unit_details: CustomPricingUnit.CustomPricingUnitDetails | null;
+
+              /**
+               * Unique identifier for the object.
+               */
+              id: string;
+
+              /**
+               * A positive decimal string representing the amount.
+               */
+              value: string;
+            }
+
+            namespace CustomPricingUnit {
+              interface CustomPricingUnitDetails {
+                /**
+                 * Time at which the object was created. Measured in seconds since the Unix epoch.
+                 */
+                created: number;
+
+                /**
+                 * The name of the custom pricing unit.
+                 */
+                display_name: string;
+
+                /**
+                 * Unique identifier for the object.
+                 */
+                id: string;
+
+                /**
+                 * A lookup key for the custom pricing unit.
+                 */
+                lookup_key: string | null;
+
+                /**
+                 * 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 status of the custom pricing unit.
+                 */
+                status: string;
+              }
+            }
+
+            interface Monetary {
+              /**
+               * 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.
+               */
+              value: number;
+            }
+          }
+        }
+
         type Status = 'active' | 'archived' | 'inactive';
 
         interface UsageThreshold {