orb-billing 4.73.0 → 5.0.0

package/src/resources/customers/credits/top-ups.ts

@@ -127,6 +127,34 @@ export class TopUpListResponsesPage extends Page<TopUpListResponse> {}
 
 export class TopUpListByExternalIDResponsesPage extends Page<TopUpListByExternalIDResponse> {}
 
+export interface TopUpInvoiceSettings {
+  /**
+   * Whether the credits purchase invoice should auto collect with the customer's
+   * saved payment method.
+   */
+  auto_collection: boolean;
+
+  /**
+   * The net terms determines the difference between the invoice date and the issue
+   * date for the invoice. If you intend the invoice to be due on issue, set this
+   * to 0.
+   */
+  net_terms: number;
+
+  /**
+   * An optional memo to display on the invoice.
+   */
+  memo?: string | null;
+
+  /**
+   * When true, credit blocks created by this top-up will require that the
+   * corresponding invoice is paid before they are drawn down from. If any topup
+   * block is pending payment, further automatic top-ups will be paused until the
+   * invoice is paid or voided.
+   */
+  require_successful_payment?: boolean;
+}
+
 export interface TopUpCreateResponse {
   id: string;
 
@@ -144,7 +172,7 @@ export interface TopUpCreateResponse {
   /**
    * Settings for invoices generated by triggered top-ups.
    */
-  invoice_settings: TopUpCreateResponse.InvoiceSettings;
+  invoice_settings: TopUpInvoiceSettings;
 
   /**
    * How much, in the customer's currency, to charge for each unit.
@@ -169,37 +197,6 @@ export interface TopUpCreateResponse {
   expires_after_unit?: 'day' | 'month' | null;
 }
 
-export namespace TopUpCreateResponse {
-  /**
-   * Settings for invoices generated by triggered top-ups.
-   */
-  export interface InvoiceSettings {
-    /**
-     * Whether the credits purchase invoice should auto collect with the customer's
-     * saved payment method.
-     */
-    auto_collection: boolean;
-
-    /**
-     * The net terms determines the difference between the invoice date and the issue
-     * date for the invoice. If you intend the invoice to be due on issue, set this
-     * to 0.
-     */
-    net_terms: number;
-
-    /**
-     * An optional memo to display on the invoice.
-     */
-    memo?: string | null;
-
-    /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
-     */
-    require_successful_payment?: boolean;
-  }
-}
-
 export interface TopUpListResponse {
   id: string;
 
@@ -217,7 +214,7 @@ export interface TopUpListResponse {
   /**
    * Settings for invoices generated by triggered top-ups.
    */
-  invoice_settings: TopUpListResponse.InvoiceSettings;
+  invoice_settings: TopUpInvoiceSettings;
 
   /**
    * How much, in the customer's currency, to charge for each unit.
@@ -242,37 +239,6 @@ export interface TopUpListResponse {
   expires_after_unit?: 'day' | 'month' | null;
 }
 
-export namespace TopUpListResponse {
-  /**
-   * Settings for invoices generated by triggered top-ups.
-   */
-  export interface InvoiceSettings {
-    /**
-     * Whether the credits purchase invoice should auto collect with the customer's
-     * saved payment method.
-     */
-    auto_collection: boolean;
-
-    /**
-     * The net terms determines the difference between the invoice date and the issue
-     * date for the invoice. If you intend the invoice to be due on issue, set this
-     * to 0.
-     */
-    net_terms: number;
-
-    /**
-     * An optional memo to display on the invoice.
-     */
-    memo?: string | null;
-
-    /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
-     */
-    require_successful_payment?: boolean;
-  }
-}
-
 export interface TopUpCreateByExternalIDResponse {
   id: string;
 
@@ -290,7 +256,7 @@ export interface TopUpCreateByExternalIDResponse {
   /**
    * Settings for invoices generated by triggered top-ups.
    */
-  invoice_settings: TopUpCreateByExternalIDResponse.InvoiceSettings;
+  invoice_settings: TopUpInvoiceSettings;
 
   /**
    * How much, in the customer's currency, to charge for each unit.
@@ -315,37 +281,6 @@ export interface TopUpCreateByExternalIDResponse {
   expires_after_unit?: 'day' | 'month' | null;
 }
 
-export namespace TopUpCreateByExternalIDResponse {
-  /**
-   * Settings for invoices generated by triggered top-ups.
-   */
-  export interface InvoiceSettings {
-    /**
-     * Whether the credits purchase invoice should auto collect with the customer's
-     * saved payment method.
-     */
-    auto_collection: boolean;
-
-    /**
-     * The net terms determines the difference between the invoice date and the issue
-     * date for the invoice. If you intend the invoice to be due on issue, set this
-     * to 0.
-     */
-    net_terms: number;
-
-    /**
-     * An optional memo to display on the invoice.
-     */
-    memo?: string | null;
-
-    /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
-     */
-    require_successful_payment?: boolean;
-  }
-}
-
 export interface TopUpListByExternalIDResponse {
   id: string;
 
@@ -363,7 +298,7 @@ export interface TopUpListByExternalIDResponse {
   /**
    * Settings for invoices generated by triggered top-ups.
    */
-  invoice_settings: TopUpListByExternalIDResponse.InvoiceSettings;
+  invoice_settings: TopUpInvoiceSettings;
 
   /**
    * How much, in the customer's currency, to charge for each unit.
@@ -388,37 +323,6 @@ export interface TopUpListByExternalIDResponse {
   expires_after_unit?: 'day' | 'month' | null;
 }
 
-export namespace TopUpListByExternalIDResponse {
-  /**
-   * Settings for invoices generated by triggered top-ups.
-   */
-  export interface InvoiceSettings {
-    /**
-     * Whether the credits purchase invoice should auto collect with the customer's
-     * saved payment method.
-     */
-    auto_collection: boolean;
-
-    /**
-     * The net terms determines the difference between the invoice date and the issue
-     * date for the invoice. If you intend the invoice to be due on issue, set this
-     * to 0.
-     */
-    net_terms: number;
-
-    /**
-     * An optional memo to display on the invoice.
-     */
-    memo?: string | null;
-
-    /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
-     */
-    require_successful_payment?: boolean;
-  }
-}
-
 export interface TopUpCreateParams {
   /**
    * The amount to increment when the threshold is reached.
@@ -489,8 +393,10 @@ export namespace TopUpCreateParams {
     memo?: string | null;
 
     /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
+     * When true, credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they are drawn down from. If any topup
+     * block is pending payment, further automatic top-ups will be paused until the
+     * invoice is paid or voided.
      */
     require_successful_payment?: boolean;
   }
@@ -568,8 +474,10 @@ export namespace TopUpCreateByExternalIDParams {
     memo?: string | null;
 
     /**
-     * If true, new credit blocks created by this top-up will require that the
-     * corresponding invoice is paid before they can be drawn down from.
+     * When true, credit blocks created by this top-up will require that the
+     * corresponding invoice is paid before they are drawn down from. If any topup
+     * block is pending payment, further automatic top-ups will be paused until the
+     * invoice is paid or voided.
      */
     require_successful_payment?: boolean;
   }
@@ -582,6 +490,7 @@ TopUps.TopUpListByExternalIDResponsesPage = TopUpListByExternalIDResponsesPage;
 
 export declare namespace TopUps {
   export {
+    type TopUpInvoiceSettings as TopUpInvoiceSettings,
     type TopUpCreateResponse as TopUpCreateResponse,
     type TopUpListResponse as TopUpListResponse,
     type TopUpCreateByExternalIDResponse as TopUpCreateByExternalIDResponse,