@metronome/sdk 0.1.0-beta.9 → 0.2.0

package/src/resources/shared.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Shared from './shared';
+import * as Shared from "./shared.js";
 
 export interface BaseUsageFilter {
   group_key: string;
@@ -34,6 +34,12 @@ export interface Commit {
 
   applicable_product_tags?: Array<string>;
 
+  /**
+   * RFC 3339 timestamp indicating when the commit was archived. If not provided, the
+   * commit is not archived.
+   */
+  archived_at?: string;
+
   /**
    * The current balance of the credit or commit. This balance reflects the amount of
    * credit or commit that the customer has access to use at this moment - thus,
@@ -48,10 +54,15 @@ export interface Commit {
 
   contract?: Commit.Contract;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   description?: string;
 
+  /**
+   * Optional configuration for commit hierarchy access control
+   */
+  hierarchy_configuration?: Commit.HierarchyConfiguration;
+
   /**
    * The contract that this commit will be billed on.
    */
@@ -73,6 +84,7 @@ export interface Commit {
     | Commit.PrepaidCommitExpirationLedgerEntry
     | Commit.PrepaidCommitCanceledLedgerEntry
     | Commit.PrepaidCommitCreditedLedgerEntry
+    | Commit.PrepaidCommitSeatBasedAdjustmentLedgerEntry
     | Commit.PostpaidCommitInitialBalanceLedgerEntry
     | Commit.PostpaidCommitAutomatedInvoiceDeductionLedgerEntry
     | Commit.PostpaidCommitRolloverLedgerEntry
@@ -106,6 +118,13 @@ export interface Commit {
    */
   salesforce_opportunity_id?: string;
 
+  /**
+   * List of filters that determine what kind of customer usage draws down a commit
+   * or credit. A customer's usage needs to meet the condition of at least one of the
+   * specifiers to contribute to a commit's or credit's drawdown.
+   */
+  specifiers?: Array<Commit.Specifier>;
+
   /**
    * Prevents the creation of duplicates. If a request to create a commit or credit
    * is made with a uniqueness key that was previously used to create a commit or
@@ -126,6 +145,32 @@ export namespace Commit {
     id: string;
   }
 
+  /**
+   * Optional configuration for commit hierarchy access control
+   */
+  export interface HierarchyConfiguration {
+    child_access:
+      | HierarchyConfiguration.CommitHierarchyChildAccessAll
+      | HierarchyConfiguration.CommitHierarchyChildAccessNone
+      | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+  }
+
+  export namespace HierarchyConfiguration {
+    export interface CommitHierarchyChildAccessAll {
+      type: 'ALL';
+    }
+
+    export interface CommitHierarchyChildAccessNone {
+      type: 'NONE';
+    }
+
+    export interface CommitHierarchyChildAccessContractIDs {
+      contract_ids: Array<string>;
+
+      type: 'CONTRACT_IDS';
+    }
+  }
+
   /**
    * The contract that this commit will be billed on.
    */
@@ -153,6 +198,8 @@ export namespace Commit {
     timestamp: string;
 
     type: 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+
+    contract_id?: string;
   }
 
   export interface PrepaidCommitRolloverLedgerEntry {
@@ -187,6 +234,8 @@ export namespace Commit {
     timestamp: string;
 
     type: 'PREPAID_COMMIT_CANCELED';
+
+    contract_id?: string;
   }
 
   export interface PrepaidCommitCreditedLedgerEntry {
@@ -199,6 +248,18 @@ export namespace Commit {
     timestamp: string;
 
     type: 'PREPAID_COMMIT_CREDITED';
+
+    contract_id?: string;
+  }
+
+  export interface PrepaidCommitSeatBasedAdjustmentLedgerEntry {
+    amount: number;
+
+    segment_id: string;
+
+    timestamp: string;
+
+    type: 'PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT';
   }
 
   export interface PostpaidCommitInitialBalanceLedgerEntry {
@@ -219,6 +280,8 @@ export namespace Commit {
     timestamp: string;
 
     type: 'POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+
+    contract_id?: string;
   }
 
   export interface PostpaidCommitRolloverLedgerEntry {
@@ -241,6 +304,8 @@ export namespace Commit {
     timestamp: string;
 
     type: 'POSTPAID_COMMIT_TRUEUP';
+
+    contract_id?: string;
   }
 
   export interface PrepaidCommitManualLedgerEntry {
@@ -276,6 +341,23 @@ export namespace Commit {
 
     contract_id: string;
   }
+
+  export interface Specifier {
+    presentation_group_values?: { [key: string]: string };
+
+    pricing_group_values?: { [key: string]: string };
+
+    /**
+     * If provided, the specifier will only apply to the product with the specified ID.
+     */
+    product_id?: string;
+
+    /**
+     * If provided, the specifier will only apply to products with all the specified
+     * tags.
+     */
+    product_tags?: Array<string>;
+  }
 }
 
 export interface ContractWithoutAmendments {
@@ -304,6 +386,14 @@ export interface ContractWithoutAmendments {
 
   ending_before?: string;
 
+  /**
+   * Either a **parent** configuration with a list of children or a **child**
+   * configuration with a single parent.
+   */
+  hierarchy_configuration?:
+    | ContractWithoutAmendments.ParentHierarchyConfiguration
+    | ContractWithoutAmendments.ChildHierarchyConfiguration;
+
   name?: string;
 
   net_payment_terms_days?: number;
@@ -313,6 +403,8 @@ export interface ContractWithoutAmendments {
    */
   netsuite_sales_order_id?: string;
 
+  prepaid_balance_threshold_configuration?: ContractWithoutAmendments.PrepaidBalanceThresholdConfiguration;
+
   /**
    * This field's availability is dependent on your client's configuration.
    */
@@ -343,7 +435,7 @@ export interface ContractWithoutAmendments {
    */
   scheduled_charges_on_usage_invoices?: 'ALL';
 
-  threshold_billing_configuration?: ContractWithoutAmendments.ThresholdBillingConfiguration;
+  spend_threshold_configuration?: ContractWithoutAmendments.SpendThresholdConfiguration;
 
   /**
    * This field's availability is dependent on your client's configuration.
@@ -368,7 +460,191 @@ export namespace ContractWithoutAmendments {
      */
     billing_anchor_date: string;
 
-    frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+  }
+
+  export interface ParentHierarchyConfiguration {
+    /**
+     * List of contracts that belong to this parent.
+     */
+    children: Array<ParentHierarchyConfiguration.Child>;
+  }
+
+  export namespace ParentHierarchyConfiguration {
+    export interface Child {
+      contract_id: string;
+
+      customer_id: string;
+    }
+  }
+
+  export interface ChildHierarchyConfiguration {
+    /**
+     * The single parent contract/customer for this child.
+     */
+    parent: ChildHierarchyConfiguration.Parent;
+  }
+
+  export namespace ChildHierarchyConfiguration {
+    /**
+     * The single parent contract/customer for this child.
+     */
+    export interface Parent {
+      contract_id: string;
+
+      customer_id: string;
+    }
+  }
+
+  export interface PrepaidBalanceThresholdConfiguration {
+    commit: PrepaidBalanceThresholdConfiguration.Commit;
+
+    /**
+     * When set to false, the contract will not be evaluated against the
+     * threshold_amount. Toggling to true will result an immediate evaluation,
+     * regardless of prior state.
+     */
+    is_enabled: boolean;
+
+    payment_gate_config: PrepaidBalanceThresholdConfiguration.PaymentGateConfig;
+
+    /**
+     * Specify the amount the balance should be recharged to.
+     */
+    recharge_to_amount: number;
+
+    /**
+     * Specify the threshold amount for the contract. Each time the contract's prepaid
+     * balance lowers to this amount, a threshold charge will be initiated.
+     */
+    threshold_amount: number;
+
+    /**
+     * If provided, the threshold, recharge-to amount, and the resulting threshold
+     * commit amount will be in terms of this credit type instead of the fiat currency.
+     */
+    custom_credit_type_id?: string;
+  }
+
+  export namespace PrepaidBalanceThresholdConfiguration {
+    export interface Commit {
+      /**
+       * The commit product that will be used to generate the line item for commit
+       * payment.
+       */
+      product_id: string;
+
+      /**
+       * Which products the threshold commit applies to. If applicable_product_ids,
+       * applicable_product_tags or specifiers are not provided, the commit applies to
+       * all products.
+       */
+      applicable_product_ids?: Array<string>;
+
+      /**
+       * Which tags the threshold commit applies to. If applicable_product_ids,
+       * applicable_product_tags or specifiers are not provided, the commit applies to
+       * all products.
+       */
+      applicable_product_tags?: Array<string>;
+
+      description?: string;
+
+      /**
+       * Specify the name of the line item for the threshold charge. If left blank, it
+       * will default to the commit product name.
+       */
+      name?: string;
+
+      /**
+       * List of filters that determine what kind of customer usage draws down a commit
+       * or credit. A customer's usage needs to meet the condition of at least one of the
+       * specifiers to contribute to a commit's or credit's drawdown. This field cannot
+       * be used together with `applicable_product_ids` or `applicable_product_tags`.
+       */
+      specifiers?: Array<Commit.Specifier>;
+    }
+
+    export namespace Commit {
+      export interface Specifier {
+        presentation_group_values?: { [key: string]: string };
+
+        pricing_group_values?: { [key: string]: string };
+
+        /**
+         * If provided, the specifier will only apply to the product with the specified ID.
+         */
+        product_id?: string;
+
+        /**
+         * If provided, the specifier will only apply to products with all the specified
+         * tags.
+         */
+        product_tags?: Array<string>;
+      }
+    }
+
+    export interface PaymentGateConfig {
+      /**
+       * Gate access to the commit balance based on successful collection of payment.
+       * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+       * facilitate payment using your own payment integration. Select NONE if you do not
+       * wish to payment gate the commit balance.
+       */
+      payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
+
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      stripe_config?: PaymentGateConfig.StripeConfig;
+
+      /**
+       * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+       * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+       * will default to NONE.
+       */
+      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+    }
+
+    export namespace PaymentGateConfig {
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      export interface PrecalculatedTaxConfig {
+        /**
+         * Amount of tax to be applied. This should be in the same currency and
+         * denomination as the commit's invoice schedule
+         */
+        tax_amount: number;
+
+        /**
+         * Name of the tax to be applied. This may be used in an invoice line item
+         * description.
+         */
+        tax_name?: string;
+      }
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      export interface StripeConfig {
+        /**
+         * If left blank, will default to INVOICE
+         */
+        payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+
+        /**
+         * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+         * your payment type.
+         */
+        invoice_metadata?: { [key: string]: string };
+      }
+    }
   }
 
   export interface RecurringCommit {
@@ -423,6 +699,11 @@ export namespace ContractWithoutAmendments {
      */
     ending_before?: string;
 
+    /**
+     * Optional configuration for recurring commit/credit hierarchy access control
+     */
+    hierarchy_configuration?: RecurringCommit.HierarchyConfiguration;
+
     /**
      * The amount the customer should be billed for the commit. Not required.
      */
@@ -448,10 +729,10 @@ export namespace ContractWithoutAmendments {
      * The frequency at which the recurring commits will be created. If not provided: -
      * The commits will be created on the usage invoice frequency. If provided: - The
      * period defined in the duration will correspond to this frequency. - Commits will
-     * be created aligned with the recurring commit's start_date rather than the usage
+     * be created aligned with the recurring commit's starting_at rather than the usage
      * invoice dates.
      */
-    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     /**
      * Will be passed down to the individual commits. This controls how much of an
@@ -459,6 +740,18 @@ export namespace ContractWithoutAmendments {
      * between 0 and 1.
      */
     rollover_fraction?: number;
+
+    /**
+     * List of filters that determine what kind of customer usage draws down a commit
+     * or credit. A customer's usage needs to meet the condition of at least one of the
+     * specifiers to contribute to a commit's or credit's drawdown.
+     */
+    specifiers?: Array<RecurringCommit.Specifier>;
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    subscription_config?: RecurringCommit.SubscriptionConfig;
   }
 
   export namespace RecurringCommit {
@@ -468,9 +761,9 @@ export namespace ContractWithoutAmendments {
     export interface AccessAmount {
       credit_type_id: string;
 
-      quantity: number;
-
       unit_price: number;
+
+      quantity?: number;
     }
 
     /**
@@ -492,6 +785,32 @@ export namespace ContractWithoutAmendments {
       id: string;
     }
 
+    /**
+     * Optional configuration for recurring commit/credit hierarchy access control
+     */
+    export interface HierarchyConfiguration {
+      child_access:
+        | HierarchyConfiguration.CommitHierarchyChildAccessAll
+        | HierarchyConfiguration.CommitHierarchyChildAccessNone
+        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+    }
+
+    export namespace HierarchyConfiguration {
+      export interface CommitHierarchyChildAccessAll {
+        type: 'ALL';
+      }
+
+      export interface CommitHierarchyChildAccessNone {
+        type: 'NONE';
+      }
+
+      export interface CommitHierarchyChildAccessContractIDs {
+        contract_ids: Array<string>;
+
+        type: 'CONTRACT_IDS';
+      }
+    }
+
     /**
      * The amount the customer should be billed for the commit. Not required.
      */
@@ -502,6 +821,43 @@ export namespace ContractWithoutAmendments {
 
       unit_price: number;
     }
+
+    export interface Specifier {
+      presentation_group_values?: { [key: string]: string };
+
+      pricing_group_values?: { [key: string]: string };
+
+      /**
+       * If provided, the specifier will only apply to the product with the specified ID.
+       */
+      product_id?: string;
+
+      /**
+       * If provided, the specifier will only apply to products with all the specified
+       * tags.
+       */
+      product_tags?: Array<string>;
+    }
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    export interface SubscriptionConfig {
+      allocation: 'INDIVIDUAL' | 'POOLED';
+
+      apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+      subscription_id: string;
+    }
+
+    export namespace SubscriptionConfig {
+      export interface ApplySeatIncreaseConfig {
+        /**
+         * Indicates whether a mid-period seat increase should be prorated.
+         */
+        is_prorated: boolean;
+      }
+    }
   }
 
   export interface RecurringCredit {
@@ -556,6 +912,11 @@ export namespace ContractWithoutAmendments {
      */
     ending_before?: string;
 
+    /**
+     * Optional configuration for recurring commit/credit hierarchy access control
+     */
+    hierarchy_configuration?: RecurringCredit.HierarchyConfiguration;
+
     /**
      * Displayed on invoices. Will be passed through to the individual commits
      */
@@ -576,10 +937,10 @@ export namespace ContractWithoutAmendments {
      * The frequency at which the recurring commits will be created. If not provided: -
      * The commits will be created on the usage invoice frequency. If provided: - The
      * period defined in the duration will correspond to this frequency. - Commits will
-     * be created aligned with the recurring commit's start_date rather than the usage
+     * be created aligned with the recurring commit's starting_at rather than the usage
      * invoice dates.
      */
-    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    recurrence_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     /**
      * Will be passed down to the individual commits. This controls how much of an
@@ -587,6 +948,18 @@ export namespace ContractWithoutAmendments {
      * between 0 and 1.
      */
     rollover_fraction?: number;
+
+    /**
+     * List of filters that determine what kind of customer usage draws down a commit
+     * or credit. A customer's usage needs to meet the condition of at least one of the
+     * specifiers to contribute to a commit's or credit's drawdown.
+     */
+    specifiers?: Array<RecurringCredit.Specifier>;
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    subscription_config?: RecurringCredit.SubscriptionConfig;
   }
 
   export namespace RecurringCredit {
@@ -596,9 +969,9 @@ export namespace ContractWithoutAmendments {
     export interface AccessAmount {
       credit_type_id: string;
 
-      quantity: number;
-
       unit_price: number;
+
+      quantity?: number;
     }
 
     /**
@@ -619,6 +992,69 @@ export namespace ContractWithoutAmendments {
     export interface Contract {
       id: string;
     }
+
+    /**
+     * Optional configuration for recurring commit/credit hierarchy access control
+     */
+    export interface HierarchyConfiguration {
+      child_access:
+        | HierarchyConfiguration.CommitHierarchyChildAccessAll
+        | HierarchyConfiguration.CommitHierarchyChildAccessNone
+        | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+    }
+
+    export namespace HierarchyConfiguration {
+      export interface CommitHierarchyChildAccessAll {
+        type: 'ALL';
+      }
+
+      export interface CommitHierarchyChildAccessNone {
+        type: 'NONE';
+      }
+
+      export interface CommitHierarchyChildAccessContractIDs {
+        contract_ids: Array<string>;
+
+        type: 'CONTRACT_IDS';
+      }
+    }
+
+    export interface Specifier {
+      presentation_group_values?: { [key: string]: string };
+
+      pricing_group_values?: { [key: string]: string };
+
+      /**
+       * If provided, the specifier will only apply to the product with the specified ID.
+       */
+      product_id?: string;
+
+      /**
+       * If provided, the specifier will only apply to products with all the specified
+       * tags.
+       */
+      product_tags?: Array<string>;
+    }
+
+    /**
+     * Attach a subscription to the recurring commit/credit.
+     */
+    export interface SubscriptionConfig {
+      allocation: 'INDIVIDUAL' | 'POOLED';
+
+      apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+
+      subscription_id: string;
+    }
+
+    export namespace SubscriptionConfig {
+      export interface ApplySeatIncreaseConfig {
+        /**
+         * Indicates whether a mid-period seat increase should be prorated.
+         */
+        is_prorated: boolean;
+      }
+    }
   }
 
   export interface ResellerRoyalty {
@@ -649,16 +1085,18 @@ export namespace ContractWithoutAmendments {
     reseller_contract_value?: number;
   }
 
-  export interface ThresholdBillingConfiguration {
-    commit: ThresholdBillingConfiguration.Commit;
+  export interface SpendThresholdConfiguration {
+    commit: SpendThresholdConfiguration.Commit;
 
     /**
      * When set to false, the contract will not be evaluated against the
      * threshold_amount. Toggling to true will result an immediate evaluation,
-     * regardless of prior state
+     * regardless of prior state.
      */
     is_enabled: boolean;
 
+    payment_gate_config: SpendThresholdConfiguration.PaymentGateConfig;
+
     /**
      * Specify the threshold amount for the contract. Each time the contract's usage
      * hits this amount, a threshold charge will be initiated.
@@ -666,30 +1104,83 @@ export namespace ContractWithoutAmendments {
     threshold_amount: number;
   }
 
-  export namespace ThresholdBillingConfiguration {
+  export namespace SpendThresholdConfiguration {
     export interface Commit {
+      /**
+       * The commit product that will be used to generate the line item for commit
+       * payment.
+       */
       product_id: string;
 
+      description?: string;
+
       /**
-       * Which products the threshold commit applies to. If both applicable_product_ids
-       * and applicable_product_tags are not provided, the commit applies to all
-       * products.
+       * Specify the name of the line item for the threshold charge. If left blank, it
+       * will default to the commit product name.
        */
-      applicable_product_ids?: Array<string>;
+      name?: string;
+    }
 
+    export interface PaymentGateConfig {
       /**
-       * Which tags the threshold commit applies to. If both applicable_product_ids and
-       * applicable_product_tags are not provided, the commit applies to all products.
+       * Gate access to the commit balance based on successful collection of payment.
+       * Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+       * facilitate payment using your own payment integration. Select NONE if you do not
+       * wish to payment gate the commit balance.
        */
-      applicable_product_tags?: Array<string>;
+      payment_gate_type: 'NONE' | 'STRIPE' | 'EXTERNAL';
 
-      description?: string;
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      precalculated_tax_config?: PaymentGateConfig.PrecalculatedTaxConfig;
 
       /**
-       * Specify the name of the line item for the threshold charge. If left blank, it
-       * will default to the commit product name.
+       * Only applicable if using STRIPE as your payment gate type.
        */
-      name?: string;
+      stripe_config?: PaymentGateConfig.StripeConfig;
+
+      /**
+       * Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+       * not wish Metronome to calculate tax on your behalf. Leaving this field blank
+       * will default to NONE.
+       */
+      tax_type?: 'NONE' | 'STRIPE' | 'ANROK' | 'PRECALCULATED';
+    }
+
+    export namespace PaymentGateConfig {
+      /**
+       * Only applicable if using PRECALCULATED as your tax type.
+       */
+      export interface PrecalculatedTaxConfig {
+        /**
+         * Amount of tax to be applied. This should be in the same currency and
+         * denomination as the commit's invoice schedule
+         */
+        tax_amount: number;
+
+        /**
+         * Name of the tax to be applied. This may be used in an invoice line item
+         * description.
+         */
+        tax_name?: string;
+      }
+
+      /**
+       * Only applicable if using STRIPE as your payment gate type.
+       */
+      export interface StripeConfig {
+        /**
+         * If left blank, will default to INVOICE
+         */
+        payment_type: 'INVOICE' | 'PAYMENT_INTENT';
+
+        /**
+         * Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+         * your payment type.
+         */
+        invoice_metadata?: { [key: string]: string };
+      }
     }
   }
 
@@ -744,10 +1235,15 @@ export interface Credit {
 
   contract?: Credit.Contract;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   description?: string;
 
+  /**
+   * Optional configuration for credit hierarchy access control
+   */
+  hierarchy_configuration?: Credit.HierarchyConfiguration;
+
   /**
    * A list of ordered events that impact the balance of a credit. For example, an
    * invoice deduction or an expiration.
@@ -759,6 +1255,7 @@ export interface Credit {
     | Credit.CreditCanceledLedgerEntry
     | Credit.CreditCreditedLedgerEntry
     | Credit.CreditManualLedgerEntry
+    | Credit.CreditSeatBasedAdjustmentLedgerEntry
   >;
 
   name?: string;
@@ -781,6 +1278,13 @@ export interface Credit {
    */
   salesforce_opportunity_id?: string;
 
+  /**
+   * List of filters that determine what kind of customer usage draws down a commit
+   * or credit. A customer's usage needs to meet the condition of at least one of the
+   * specifiers to contribute to a commit's or credit's drawdown.
+   */
+  specifiers?: Array<Credit.Specifier>;
+
   /**
    * Prevents the creation of duplicates. If a request to create a commit or credit
    * is made with a uniqueness key that was previously used to create a commit or
@@ -801,6 +1305,32 @@ export namespace Credit {
     id: string;
   }
 
+  /**
+   * Optional configuration for credit hierarchy access control
+   */
+  export interface HierarchyConfiguration {
+    child_access:
+      | HierarchyConfiguration.CommitHierarchyChildAccessAll
+      | HierarchyConfiguration.CommitHierarchyChildAccessNone
+      | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+  }
+
+  export namespace HierarchyConfiguration {
+    export interface CommitHierarchyChildAccessAll {
+      type: 'ALL';
+    }
+
+    export interface CommitHierarchyChildAccessNone {
+      type: 'NONE';
+    }
+
+    export interface CommitHierarchyChildAccessContractIDs {
+      contract_ids: Array<string>;
+
+      type: 'CONTRACT_IDS';
+    }
+  }
+
   export interface CreditSegmentStartLedgerEntry {
     amount: number;
 
@@ -821,6 +1351,8 @@ export namespace Credit {
     timestamp: string;
 
     type: 'CREDIT_AUTOMATED_INVOICE_DEDUCTION';
+
+    contract_id?: string;
   }
 
   export interface CreditExpirationLedgerEntry {
@@ -843,6 +1375,8 @@ export namespace Credit {
     timestamp: string;
 
     type: 'CREDIT_CANCELED';
+
+    contract_id?: string;
   }
 
   export interface CreditCreditedLedgerEntry {
@@ -855,6 +1389,8 @@ export namespace Credit {
     timestamp: string;
 
     type: 'CREDIT_CREDITED';
+
+    contract_id?: string;
   }
 
   export interface CreditManualLedgerEntry {
@@ -866,6 +1402,33 @@ export namespace Credit {
 
     type: 'CREDIT_MANUAL';
   }
+
+  export interface CreditSeatBasedAdjustmentLedgerEntry {
+    amount: number;
+
+    segment_id: string;
+
+    timestamp: string;
+
+    type: 'CREDIT_SEAT_BASED_ADJUSTMENT';
+  }
+
+  export interface Specifier {
+    presentation_group_values?: { [key: string]: string };
+
+    pricing_group_values?: { [key: string]: string };
+
+    /**
+     * If provided, the specifier will only apply to the product with the specified ID.
+     */
+    product_id?: string;
+
+    /**
+     * If provided, the specifier will only apply to products with all the specified
+     * tags.
+     */
+    product_tags?: Array<string>;
+  }
 }
 
 export interface CreditTypeData {
@@ -881,7 +1444,7 @@ export interface Discount {
 
   schedule: SchedulePointInTime;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   name?: string;
 
@@ -981,18 +1544,18 @@ export interface Override {
    * Only set for CUSTOM rate_type. This field is interpreted by custom rate
    * processors.
    */
-  value?: Record<string, unknown>;
+  value?: { [key: string]: unknown };
 }
 
 export namespace Override {
   export interface OverrideSpecifier {
-    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+    billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
 
     commit_ids?: Array<string>;
 
-    presentation_group_values?: Record<string, string | null>;
+    presentation_group_values?: { [key: string]: string | null };
 
-    pricing_group_values?: Record<string, string>;
+    pricing_group_values?: { [key: string]: string };
 
     product_id?: string;
 
@@ -1018,7 +1581,7 @@ export namespace Override {
      * Only set for CUSTOM rate_type. This field is interpreted by custom rate
      * processors.
      */
-    custom_rate?: Record<string, unknown>;
+    custom_rate?: { [key: string]: unknown };
 
     /**
      * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
@@ -1103,7 +1666,7 @@ export interface ProService {
    */
   unit_price: number;
 
-  custom_fields?: Record<string, string>;
+  custom_fields?: { [key: string]: string };
 
   description?: string;
 
@@ -1122,7 +1685,7 @@ export interface Rate {
    * Only set for CUSTOM rate_type. This field is interpreted by custom rate
    * processors.
    */
-  custom_rate?: Record<string, unknown>;
+  custom_rate?: { [key: string]: unknown };
 
   /**
    * Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
@@ -1140,7 +1703,7 @@ export interface Rate {
    * if pricing groups are used, this will contain the values used to calculate the
    * price
    */
-  pricing_group_values?: Record<string, string>;
+  pricing_group_values?: { [key: string]: string };
 
   /**
    * Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
@@ -1167,7 +1730,9 @@ export interface ScheduledCharge {
 
   schedule: SchedulePointInTime;
 
-  custom_fields?: Record<string, string>;
+  archived_at?: string;
+
+  custom_fields?: { [key: string]: string };
 
   /**
    * displayed on invoices
@@ -1218,13 +1783,13 @@ export namespace SchedulePointInTime {
 
     amount: number;
 
-    invoice_id: string;
-
     quantity: number;
 
     timestamp: string;
 
     unit_price: number;
+
+    invoice_id?: string | null;
   }
 }