stripe 19.3.1 → 19.4.0-alpha.2

package/types/TokensResource.d.ts

@@ -433,6 +433,16 @@ declare module 'stripe' {
            * The individual's verification document information.
            */
           verification?: Individual.Verification;
+
+          /**
+           * The credit applicant's self-reported yearly income in minor units.
+           */
+          self_reported_income?: Individual.SelfReportedIncome;
+
+          /**
+           * The credit applicant's self-reported monthly housing payment in minor units.
+           */
+          self_reported_monthly_housing_payment?: Individual.SelfReportedMonthlyHousingPayment;
         }
 
         namespace Individual {
@@ -482,6 +492,18 @@ declare module 'stripe' {
             title?: string;
           }
 
+          interface SelfReportedIncome {
+            amount: number;
+
+            currency: string;
+          }
+
+          interface SelfReportedMonthlyHousingPayment {
+            amount: number;
+
+            currency: string;
+          }
+
           interface Verification {
             /**
              * A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
@@ -792,6 +814,16 @@ declare module 'stripe' {
          * The person's verification status.
          */
         verification?: Person.Verification;
+
+        /**
+         * The credit applicant's self-reported yearly income in minor units.
+         */
+        self_reported_income?: Person.SelfReportedIncome;
+
+        /**
+         * The credit applicant's self-reported monthly housing payment in minor units.
+         */
+        self_reported_monthly_housing_payment?: Person.SelfReportedMonthlyHousingPayment;
       }
 
       namespace Person {
@@ -922,6 +954,18 @@ declare module 'stripe' {
           title?: string;
         }
 
+        interface SelfReportedIncome {
+          amount: number;
+
+          currency: string;
+        }
+
+        interface SelfReportedMonthlyHousingPayment {
+          amount: number;
+
+          currency: string;
+        }
+
         interface UsCfpbData {
           /**
            * The persons ethnicity details

package/types/Transfers.d.ts

@@ -35,6 +35,10 @@ declare module 'stripe' {
        */
       amount_reversed: number;
 
+      application_fee?: string | Stripe.ApplicationFee | null;
+
+      application_fee_amount?: number | null;
+
       /**
        * Balance transaction that describes the impact of this transfer on your account balance.
        */
@@ -65,6 +69,11 @@ declare module 'stripe' {
        */
       destination_payment?: string | Stripe.Charge;
 
+      /**
+       * The FX Quote used for the transfer.
+       */
+      fx_quote?: string;
+
       /**
        * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
        */

package/types/TransfersResource.d.ts

@@ -18,6 +18,8 @@ declare module 'stripe' {
        */
       amount?: number;
 
+      application_fee_amount?: number;
+
       /**
        * An arbitrary string attached to the object. Often useful for displaying to users.
        */
@@ -28,6 +30,11 @@ declare module 'stripe' {
        */
       expand?: Array<string>;
 
+      /**
+       * The FX rate in the quote is validated and used to convert the transfer amount to the destination currency.
+       */
+      fx_quote?: 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`.
        */

package/types/TransitBalances.d.ts

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Funds that are in transit and destined for another balance or another connected account.
+     */
+    interface TransitBalance {
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'transit_balance';
+
+      balance: TransitBalance.Balance;
+
+      /**
+       * 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;
+
+      /**
+       * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+       */
+      livemode: boolean;
+    }
+
+    namespace TransitBalance {
+      interface Balance {
+        available: number;
+
+        pending: number;
+      }
+    }
+  }
+}

package/types/Treasury/FinancialAccountFeatures.d.ts

@@ -175,6 +175,11 @@ declare module 'stripe' {
 
         namespace FinancialAddresses {
           interface Aba {
+            /**
+             * Requested bank partner for this Financial Account
+             */
+            bank?: Aba.Bank;
+
             /**
              * Whether the FinancialAccount should have the Feature.
              */
@@ -192,6 +197,8 @@ declare module 'stripe' {
           }
 
           namespace Aba {
+            type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+
             type Status = 'active' | 'pending' | 'restricted';
 
             interface StatusDetail {

package/types/Treasury/FinancialAccounts.d.ts

@@ -38,6 +38,11 @@ declare module 'stripe' {
          */
         created: number;
 
+        /**
+         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+         */
+        display_name?: string | null;
+
         /**
          * Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.
          * Stripe or the platform can control Features via the requested field.

package/types/Treasury/FinancialAccountsResource.d.ts

@@ -9,6 +9,11 @@ declare module 'stripe' {
          */
         supported_currencies: Array<string>;
 
+        /**
+         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+         */
+        display_name?: Stripe.Emptyable<string>;
+
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -97,11 +102,20 @@ declare module 'stripe' {
 
           namespace FinancialAddresses {
             interface Aba {
+              /**
+               * Requested bank partner
+               */
+              bank?: Aba.Bank;
+
               /**
                * Whether the FinancialAccount should have the Feature.
                */
               requested: boolean;
             }
+
+            namespace Aba {
+              type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+            }
           }
 
           interface InboundTransfers {
@@ -211,6 +225,11 @@ declare module 'stripe' {
       }
 
       interface FinancialAccountUpdateParams {
+        /**
+         * The display name for the FinancialAccount. Use this field to customize the names of the FinancialAccounts for your connected accounts. Unlike the `nickname` field, `display_name` is not internal metadata and will be exposed to connected accounts.
+         */
+        display_name?: Stripe.Emptyable<string>;
+
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -304,11 +323,20 @@ declare module 'stripe' {
 
           namespace FinancialAddresses {
             interface Aba {
+              /**
+               * Requested bank partner
+               */
+              bank?: Aba.Bank;
+
               /**
                * Whether the FinancialAccount should have the Feature.
                */
               requested: boolean;
             }
+
+            namespace Aba {
+              type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+            }
           }
 
           interface InboundTransfers {
@@ -560,11 +588,20 @@ declare module 'stripe' {
 
         namespace FinancialAddresses {
           interface Aba {
+            /**
+             * Requested bank partner
+             */
+            bank?: Aba.Bank;
+
             /**
              * Whether the FinancialAccount should have the Feature.
              */
             requested: boolean;
           }
+
+          namespace Aba {
+            type Bank = 'evolve' | 'fifth_third' | 'goldman_sachs';
+          }
         }
 
         interface InboundTransfers {

package/types/Treasury/OutboundTransfers.d.ts

@@ -78,6 +78,11 @@ declare module 'stripe' {
          */
         metadata: Stripe.Metadata;
 
+        /**
+         * Details about the network used for the OutboundTransfer.
+         */
+        network_details?: OutboundTransfer.NetworkDetails | null;
+
         /**
          * Details about a returned OutboundTransfer. Only set when the status is `returned`.
          */
@@ -200,6 +205,27 @@ declare module 'stripe' {
           }
         }
 
+        interface NetworkDetails {
+          /**
+           * Details about an ACH transaction.
+           */
+          ach?: NetworkDetails.Ach | null;
+
+          /**
+           * The type of flow that originated the OutboundTransfer.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+          }
+        }
+
         interface ReturnedDetails {
           /**
            * Reason for the return.

package/types/Treasury/OutboundTransfersResource.d.ts

@@ -49,6 +49,11 @@ declare module 'stripe' {
          */
         metadata?: Stripe.MetadataParam;
 
+        /**
+         * Details about the network used for the OutboundTransfer.
+         */
+        network_details?: OutboundTransferCreateParams.NetworkDetails;
+
         /**
          * Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer".
          */
@@ -89,6 +94,27 @@ declare module 'stripe' {
             type Network = 'ach' | 'us_domestic_wire';
           }
         }
+
+        interface NetworkDetails {
+          /**
+           * Optional fields for `ach`.
+           */
+          ach?: NetworkDetails.Ach;
+
+          /**
+           * The type of flow that originated the OutboundTransfer.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * Addenda record data associated with this OutboundTransfer.
+             */
+            addenda?: string;
+          }
+        }
       }
 
       interface OutboundTransferRetrieveParams {

package/types/Treasury/ReceivedCredits.d.ts

@@ -66,6 +66,11 @@ declare module 'stripe' {
          */
         network: ReceivedCredit.Network;
 
+        /**
+         * Details specific to the money movement rails.
+         */
+        network_details?: ReceivedCredit.NetworkDetails | null;
+
         /**
          * Details describing when a ReceivedCredit may be reversed.
          */
@@ -251,6 +256,27 @@ declare module 'stripe' {
 
         type Network = 'ach' | 'card' | 'stripe' | 'us_domestic_wire';
 
+        interface NetworkDetails {
+          /**
+           * Details about an ACH transaction.
+           */
+          ach?: NetworkDetails.Ach | null;
+
+          /**
+           * The type of flow that originated the ReceivedCredit.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+          }
+        }
+
         interface ReversalDetails {
           /**
            * Time before which a ReceivedCredit can be reversed.

package/types/Treasury/ReceivedDebits.d.ts

@@ -66,6 +66,11 @@ declare module 'stripe' {
          */
         network: ReceivedDebit.Network;
 
+        /**
+         * Details specific to the money movement rails.
+         */
+        network_details?: ReceivedDebit.NetworkDetails | null;
+
         /**
          * Details describing when a ReceivedDebit might be reversed.
          */
@@ -190,10 +195,36 @@ declare module 'stripe' {
            * Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object.
            */
           payout: string | null;
+
+          /**
+           * The ReceivedCredit that Capital withheld from
+           */
+          received_credit_capital_withholding?: string | null;
         }
 
         type Network = 'ach' | 'card' | 'stripe';
 
+        interface NetworkDetails {
+          /**
+           * Details about an ACH transaction.
+           */
+          ach?: NetworkDetails.Ach | null;
+
+          /**
+           * The type of flow that originated the ReceivedDebit.
+           */
+          type: 'ach';
+        }
+
+        namespace NetworkDetails {
+          interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+          }
+        }
+
         interface ReversalDetails {
           /**
            * Time before which a ReceivedDebit can be reversed.

package/types/V2/Billing/BillSettingVersions.d.ts

@@ -0,0 +1,97 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        /**
+         * The BillSettingVersion object.
+         */
+        interface BillSettingVersion {
+          /**
+           * The ID of the BillSettingVersion object.
+           */
+          id: string;
+
+          /**
+           * String representing the object's type. Objects of the same type share the same value of the object field.
+           */
+          object: 'v2.billing.bill_setting_version';
+
+          /**
+           * Settings related to calculating a bill.
+           */
+          calculation?: BillSettingVersion.Calculation;
+
+          /**
+           * Timestamp of when the object was created.
+           */
+          created: string;
+
+          /**
+           * Settings related to invoice behavior.
+           */
+          invoice?: BillSettingVersion.Invoice;
+
+          /**
+           * The ID of the invoice rendering template to be used when generating invoices.
+           */
+          invoice_rendering_template?: 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;
+        }
+
+        namespace BillSettingVersion {
+          interface Calculation {
+            /**
+             * Settings for calculating tax.
+             */
+            tax?: Calculation.Tax;
+          }
+
+          namespace Calculation {
+            interface Tax {
+              /**
+               * Determines if tax will be calculated automatically based on a PTC or manually based on rules defined by the merchant. Defaults to "manual".
+               */
+              type: Tax.Type;
+            }
+
+            namespace Tax {
+              type Type = 'automatic' | 'manual';
+            }
+          }
+
+          interface Invoice {
+            /**
+             * The amount of time until the invoice will be overdue for payment.
+             */
+            time_until_due?: Invoice.TimeUntilDue;
+          }
+
+          namespace Invoice {
+            interface TimeUntilDue {
+              /**
+               * The interval unit for the time until due.
+               */
+              interval: TimeUntilDue.Interval;
+
+              /**
+               * The number of interval units. For example, if interval=day and interval_count=30,
+               * the invoice will be due in 30 days.
+               */
+              interval_count: number;
+            }
+
+            namespace TimeUntilDue {
+              type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/types/V2/Billing/BillSettings/VersionsResource.d.ts

@@ -0,0 +1,58 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace V2 {
+      namespace Billing {
+        namespace BillSettings {
+          interface VersionRetrieveParams {}
+        }
+      }
+
+      namespace Billing {
+        namespace BillSettings {
+          interface VersionListParams {
+            /**
+             * Optionally set the maximum number of results per page. Defaults to 20.
+             */
+            limit?: number;
+          }
+        }
+      }
+
+      namespace Billing {
+        namespace BillSettings {
+          class VersionsResource {
+            /**
+             * Retrieve a BillSettingVersion by ID.
+             */
+            retrieve(
+              billSettingId: string,
+              id: string,
+              params?: VersionRetrieveParams,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.BillSettingVersion>>;
+            retrieve(
+              billSettingId: string,
+              id: string,
+              options?: RequestOptions
+            ): Promise<Stripe.Response<Stripe.V2.Billing.BillSettingVersion>>;
+
+            /**
+             * List all BillSettingVersions by BillSetting ID.
+             */
+            list(
+              id: string,
+              params?: VersionListParams,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.BillSettingVersion>;
+            list(
+              id: string,
+              options?: RequestOptions
+            ): ApiListPromise<Stripe.V2.Billing.BillSettingVersion>;
+          }
+        }
+      }
+    }
+  }
+}