stripe 22.3.0 → 22.4.0-beta.1

package/esm/resources/Treasury/FinancialAccounts.d.ts

@@ -1,6 +1,6 @@
 import { StripeResource } from '../../StripeResource.js';
 import { FinancialAccountFeatures } from './FinancialAccountFeatures.js';
-import { MetadataParam, Emptyable, PaginationParams, RangeQueryParam, Metadata } from '../../shared.js';
+import { Emptyable, MetadataParam, PaginationParams, RangeQueryParam, Metadata } from '../../shared.js';
 import { RequestOptions, ApiListPromise, Response } from '../../lib.js';
 export declare class FinancialAccountResource extends StripeResource {
     /**
@@ -57,6 +57,10 @@ export interface FinancialAccount {
      * Time at which the object was created. Measured in seconds since the Unix epoch.
      */
     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.
@@ -203,6 +207,10 @@ export declare namespace Treasury {
          * The currencies the FinancialAccount can hold a balance in.
          */
         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?: Emptyable<string>;
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -318,11 +326,18 @@ export declare namespace Treasury {
             }
             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';
+                }
             }
             namespace InboundTransfers {
                 interface Ach {
@@ -377,6 +392,10 @@ export declare namespace Treasury {
 }
 export declare namespace Treasury {
     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?: Emptyable<string>;
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -510,11 +529,18 @@ export declare namespace Treasury {
             }
             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';
+                }
             }
             namespace InboundTransfers {
                 interface Ach {
@@ -708,11 +734,18 @@ export declare namespace Treasury {
         }
         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';
+            }
         }
         namespace InboundTransfers {
             interface Ach {

package/esm/resources/Treasury/OutboundPayments.d.ts

@@ -86,6 +86,10 @@ export interface OutboundPayment {
      * 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: Metadata;
+    /**
+     * The purpose of the OutboundPayment, if applicable.
+     */
+    purpose?: 'payroll' | null;
     /**
      * Details about a returned OutboundPayment. Only set when the status is `returned`.
      */
@@ -301,6 +305,10 @@ export declare namespace Treasury {
          * 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?: MetadataParam;
+        /**
+         * The purpose of the OutboundPayment, if applicable. This list is not exhaustive, do not specify this parameter if your purpose does not match any that are provided.
+         */
+        purpose?: 'payroll';
         /**
          * The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. Can only include -#.$&*, spaces, and alphanumeric characters. The default value is "payment".
          */

package/esm/resources/Treasury/OutboundTransfers.d.ts

@@ -75,6 +75,10 @@ export interface OutboundTransfer {
      * 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: 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`.
      */
@@ -107,6 +111,16 @@ export declare namespace OutboundTransfer {
         type: DestinationPaymentMethodDetails.Type;
         us_bank_account?: DestinationPaymentMethodDetails.UsBankAccount;
     }
+    interface NetworkDetails {
+        /**
+         * Details about an ACH transaction.
+         */
+        ach?: NetworkDetails.Ach | null;
+        /**
+         * The type of flow that originated the OutboundTransfer.
+         */
+        type: 'ach';
+    }
     interface ReturnedDetails {
         /**
          * Reason for the return.
@@ -207,6 +221,14 @@ export declare namespace OutboundTransfer {
             type Network = 'ach' | 'us_domestic_wire';
         }
     }
+    namespace NetworkDetails {
+        interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+        }
+    }
     namespace ReturnedDetails {
         type Code = 'account_closed' | 'account_frozen' | 'bank_account_restricted' | 'bank_ownership_changed' | 'declined' | 'incorrect_account_holder_name' | 'invalid_account_number' | 'invalid_currency' | 'no_account' | 'other';
     }
@@ -272,6 +294,10 @@ export declare namespace Treasury {
          * 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?: 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". Can only include -#.$&*, spaces, and alphanumeric characters.
          */
@@ -294,6 +320,16 @@ export declare namespace Treasury {
              */
             us_bank_account?: Emptyable<DestinationPaymentMethodOptions.UsBankAccount>;
         }
+        interface NetworkDetails {
+            /**
+             * Optional fields for `ach`.
+             */
+            ach?: NetworkDetails.Ach;
+            /**
+             * The type of flow that originated the OutboundTransfer.
+             */
+            type: 'ach';
+        }
         namespace DestinationPaymentMethodOptions {
             interface UsBankAccount {
                 /**
@@ -305,6 +341,14 @@ export declare namespace Treasury {
                 type Network = 'ach' | 'us_domestic_wire';
             }
         }
+        namespace NetworkDetails {
+            interface Ach {
+                /**
+                 * Addenda record data associated with this OutboundTransfer.
+                 */
+                addenda?: string;
+            }
+        }
     }
 }
 export declare namespace Treasury {

package/esm/resources/Treasury/ReceivedCredits.d.ts

@@ -63,6 +63,10 @@ export interface ReceivedCredit {
      * The rails used to send the funds.
      */
     network: ReceivedCredit.Network;
+    /**
+     * Details specific to the money movement rails.
+     */
+    network_details?: ReceivedCredit.NetworkDetails | null;
     /**
      * Details describing when a ReceivedCredit may be reversed.
      */
@@ -122,6 +126,16 @@ export declare namespace ReceivedCredit {
         source_flow_type: string | null;
     }
     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';
+    }
     interface ReversalDetails {
         /**
          * Time before which a ReceivedCredit can be reversed.
@@ -213,6 +227,14 @@ export declare namespace ReceivedCredit {
             type Type = 'credit_reversal' | 'other' | 'outbound_payment' | 'outbound_transfer' | 'payout';
         }
     }
+    namespace NetworkDetails {
+        interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+        }
+    }
     namespace ReversalDetails {
         type RestrictedReason = 'already_reversed' | 'deadline_passed' | 'network_restricted' | 'other' | 'source_flow_restricted';
     }

package/esm/resources/Treasury/ReceivedDebits.d.ts

@@ -59,6 +59,10 @@ export interface ReceivedDebit {
      * The network used for the ReceivedDebit.
      */
     network: ReceivedDebit.Network;
+    /**
+     * Details specific to the money movement rails.
+     */
+    network_details?: ReceivedDebit.NetworkDetails | null;
     /**
      * Details describing when a ReceivedDebit might be reversed.
      */
@@ -112,12 +116,26 @@ export declare namespace ReceivedDebit {
          * Set if the ReceivedDebit was created due to a [Payout](https://api.stripe.com#payouts) object.
          */
         payout: string | null;
+        /**
+         * The ReceivedCredit that Capital withheld from
+         */
+        received_credit_capital_withholding?: string | null;
         /**
          * Set if the ReceivedDebit was created due to a [Topup](https://api.stripe.com#topups) object.
          */
         topup: 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';
+    }
     interface ReversalDetails {
         /**
          * Time before which a ReceivedDebit can be reversed.
@@ -167,6 +185,14 @@ export declare namespace ReceivedDebit {
             routing_number: string | null;
         }
     }
+    namespace NetworkDetails {
+        interface Ach {
+            /**
+             * ACH Addenda record
+             */
+            addenda: string | null;
+        }
+    }
     namespace ReversalDetails {
         type RestrictedReason = 'already_reversed' | 'deadline_passed' | 'network_restricted' | 'other' | 'source_flow_restricted';
     }

package/esm/resources/V2/Billing/BillSettingVersions.d.ts

@@ -0,0 +1,71 @@
+export 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;
+}
+export declare namespace BillSettingVersion {
+    interface Calculation {
+        /**
+         * Settings for calculating tax.
+         */
+        tax?: Calculation.Tax;
+    }
+    interface Invoice {
+        /**
+         * The amount of time until the invoice is overdue for payment.
+         */
+        time_until_due?: Invoice.TimeUntilDue;
+    }
+    namespace Calculation {
+        interface Tax {
+            /**
+             * Determines if tax is calculated automatically based on a PTC or manually based on rules defined by the business. Defaults to "manual".
+             */
+            type: Tax.Type;
+        }
+        namespace Tax {
+            type Type = 'automatic' | 'manual';
+        }
+    }
+    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 is due in 30 days.
+             */
+            interval_count: number;
+        }
+        namespace TimeUntilDue {
+            type Interval = 'day' | 'month' | 'week' | 'year';
+        }
+    }
+}

package/esm/resources/V2/Billing/BillSettingVersions.js

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec
+export {};
+//# sourceMappingURL=BillSettingVersions.js.map

package/esm/resources/V2/Billing/BillSettingVersions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BillSettingVersions.js","sourceRoot":"","sources":["../../../../src/resources/V2/Billing/BillSettingVersions.ts"],"names":[],"mappings":"AAAA,uCAAuC"}

package/esm/resources/V2/Billing/BillSettings/Versions.d.ts

@@ -0,0 +1,33 @@
+import { StripeResource } from '../../../../StripeResource.js';
+import { BillSettingVersion } from './../../../V2/Billing/BillSettingVersions.js';
+import { RequestOptions, V2ListPromise, Response } from '../../../../lib.js';
+export declare class VersionResource extends StripeResource {
+    /**
+     * List all BillSettingVersions by BillSetting ID.
+     */
+    list(billSettingId: string, params?: V2.Billing.BillSettings.VersionListParams, options?: RequestOptions): V2ListPromise<BillSettingVersion>;
+    /**
+     * Retrieve a BillSettingVersion by ID.
+     */
+    retrieve(billSettingId: string, id: string, params?: V2.Billing.BillSettings.VersionRetrieveParams, options?: RequestOptions): Promise<Response<BillSettingVersion>>;
+}
+export declare namespace V2 {
+    namespace Billing {
+        namespace BillSettings {
+            interface VersionRetrieveParams {
+            }
+        }
+    }
+}
+export declare namespace V2 {
+    namespace Billing {
+        namespace BillSettings {
+            interface VersionListParams {
+                /**
+                 * Optionally set the maximum number of results per page. Defaults to 20.
+                 */
+                limit?: number;
+            }
+        }
+    }
+}

package/esm/resources/V2/Billing/BillSettings/Versions.js

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec
+import { StripeResource } from '../../../../StripeResource.js';
+export class VersionResource extends StripeResource {
+    /**
+     * List all BillSettingVersions by BillSetting ID.
+     */
+    list(billSettingId, params, options) {
+        return this._makeRequest('GET', `/v2/billing/bill_settings/${encodeURIComponent(billSettingId)}/versions`, params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Retrieve a BillSettingVersion by ID.
+     */
+    retrieve(billSettingId, id, params, options) {
+        return this._makeRequest('GET', `/v2/billing/bill_settings/${encodeURIComponent(billSettingId)}/versions/${encodeURIComponent(id)}`, params, options);
+    }
+}
+//# sourceMappingURL=Versions.js.map

package/esm/resources/V2/Billing/BillSettings/Versions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Versions.js","sourceRoot":"","sources":["../../../../../src/resources/V2/Billing/BillSettings/Versions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,+BAA+B,CAAC;AAI7D,MAAM,OAAO,eAAgB,SAAQ,cAAc;IACjD;;OAEG;IACH,IAAI,CACF,aAAqB,EACrB,MAAkD,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,6BAA6B,kBAAkB,CAAC,aAAa,CAAC,WAAW,EACzE,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,aAAqB,EACrB,EAAU,EACV,MAAsD,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,6BAA6B,kBAAkB,CAC7C,aAAa,CACd,aAAa,kBAAkB,CAAC,EAAE,CAAC,EAAE,EACtC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}