@metronome/sdk 0.1.0-beta.9 → 0.2.0

package/resources/shared.d.ts

@@ -20,6 +20,11 @@ export interface Commit {
     applicable_contract_ids?: Array<string>;
     applicable_product_ids?: Array<string>;
     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,
@@ -32,8 +37,14 @@ export interface Commit {
      */
     balance?: number;
     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.
      */
@@ -46,7 +57,7 @@ export interface Commit {
      * A list of ordered events that impact the balance of a commit. For example, an
      * invoice deduction or a rollover.
      */
-    ledger?: Array<Commit.PrepaidCommitSegmentStartLedgerEntry | Commit.PrepaidCommitAutomatedInvoiceDeductionLedgerEntry | Commit.PrepaidCommitRolloverLedgerEntry | Commit.PrepaidCommitExpirationLedgerEntry | Commit.PrepaidCommitCanceledLedgerEntry | Commit.PrepaidCommitCreditedLedgerEntry | Commit.PostpaidCommitInitialBalanceLedgerEntry | Commit.PostpaidCommitAutomatedInvoiceDeductionLedgerEntry | Commit.PostpaidCommitRolloverLedgerEntry | Commit.PostpaidCommitTrueupLedgerEntry | Commit.PrepaidCommitManualLedgerEntry | Commit.PostpaidCommitManualLedgerEntry | Commit.PostpaidCommitExpirationLedgerEntry>;
+    ledger?: Array<Commit.PrepaidCommitSegmentStartLedgerEntry | Commit.PrepaidCommitAutomatedInvoiceDeductionLedgerEntry | Commit.PrepaidCommitRolloverLedgerEntry | Commit.PrepaidCommitExpirationLedgerEntry | Commit.PrepaidCommitCanceledLedgerEntry | Commit.PrepaidCommitCreditedLedgerEntry | Commit.PrepaidCommitSeatBasedAdjustmentLedgerEntry | Commit.PostpaidCommitInitialBalanceLedgerEntry | Commit.PostpaidCommitAutomatedInvoiceDeductionLedgerEntry | Commit.PostpaidCommitRolloverLedgerEntry | Commit.PostpaidCommitTrueupLedgerEntry | Commit.PrepaidCommitManualLedgerEntry | Commit.PostpaidCommitManualLedgerEntry | Commit.PostpaidCommitExpirationLedgerEntry>;
     name?: string;
     /**
      * This field's availability is dependent on your client's configuration.
@@ -64,6 +75,12 @@ export interface Commit {
      * This field's availability is dependent on your client's configuration.
      */
     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
@@ -80,6 +97,24 @@ export declare namespace Commit {
     interface Contract {
         id: string;
     }
+    /**
+     * Optional configuration for commit hierarchy access control
+     */
+    interface HierarchyConfiguration {
+        child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+    }
+    namespace HierarchyConfiguration {
+        interface CommitHierarchyChildAccessAll {
+            type: 'ALL';
+        }
+        interface CommitHierarchyChildAccessNone {
+            type: 'NONE';
+        }
+        interface CommitHierarchyChildAccessContractIDs {
+            contract_ids: Array<string>;
+            type: 'CONTRACT_IDS';
+        }
+    }
     /**
      * The contract that this commit will be billed on.
      */
@@ -98,6 +133,7 @@ export declare namespace Commit {
         segment_id: string;
         timestamp: string;
         type: 'PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+        contract_id?: string;
     }
     interface PrepaidCommitRolloverLedgerEntry {
         amount: number;
@@ -118,6 +154,7 @@ export declare namespace Commit {
         segment_id: string;
         timestamp: string;
         type: 'PREPAID_COMMIT_CANCELED';
+        contract_id?: string;
     }
     interface PrepaidCommitCreditedLedgerEntry {
         amount: number;
@@ -125,6 +162,13 @@ export declare namespace Commit {
         segment_id: string;
         timestamp: string;
         type: 'PREPAID_COMMIT_CREDITED';
+        contract_id?: string;
+    }
+    interface PrepaidCommitSeatBasedAdjustmentLedgerEntry {
+        amount: number;
+        segment_id: string;
+        timestamp: string;
+        type: 'PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT';
     }
     interface PostpaidCommitInitialBalanceLedgerEntry {
         amount: number;
@@ -137,6 +181,7 @@ export declare namespace Commit {
         segment_id: string;
         timestamp: string;
         type: 'POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION';
+        contract_id?: string;
     }
     interface PostpaidCommitRolloverLedgerEntry {
         amount: number;
@@ -150,6 +195,7 @@ export declare namespace Commit {
         invoice_id: string;
         timestamp: string;
         type: 'POSTPAID_COMMIT_TRUEUP';
+        contract_id?: string;
     }
     interface PrepaidCommitManualLedgerEntry {
         amount: number;
@@ -172,6 +218,23 @@ export declare namespace Commit {
         commit_id: string;
         contract_id: string;
     }
+    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 {
     commits: Array<Commit>;
@@ -188,12 +251,18 @@ export interface ContractWithoutAmendments {
      */
     discounts?: Array<Discount>;
     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;
     /**
      * This field's availability is dependent on your client's configuration.
      */
     netsuite_sales_order_id?: string;
+    prepaid_balance_threshold_configuration?: ContractWithoutAmendments.PrepaidBalanceThresholdConfiguration;
     /**
      * This field's availability is dependent on your client's configuration.
      */
@@ -217,7 +286,7 @@ export interface ContractWithoutAmendments {
      * on a separate invoice from usage charges.
      */
     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.
      */
@@ -235,7 +304,167 @@ export declare namespace ContractWithoutAmendments {
          * Contract usage statements follow a selected cadence based on this date.
          */
         billing_anchor_date: string;
-        frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+        frequency: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
+    }
+    interface ParentHierarchyConfiguration {
+        /**
+         * List of contracts that belong to this parent.
+         */
+        children: Array<ParentHierarchyConfiguration.Child>;
+    }
+    namespace ParentHierarchyConfiguration {
+        interface Child {
+            contract_id: string;
+            customer_id: string;
+        }
+    }
+    interface ChildHierarchyConfiguration {
+        /**
+         * The single parent contract/customer for this child.
+         */
+        parent: ChildHierarchyConfiguration.Parent;
+    }
+    namespace ChildHierarchyConfiguration {
+        /**
+         * The single parent contract/customer for this child.
+         */
+        interface Parent {
+            contract_id: string;
+            customer_id: string;
+        }
+    }
+    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;
+    }
+    namespace PrepaidBalanceThresholdConfiguration {
+        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>;
+        }
+        namespace Commit {
+            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>;
+            }
+        }
+        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';
+        }
+        namespace PaymentGateConfig {
+            /**
+             * Only applicable if using PRECALCULATED as your tax type.
+             */
+            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.
+             */
+            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;
+                };
+            }
+        }
     }
     interface RecurringCommit {
         id: string;
@@ -277,6 +506,10 @@ export declare namespace ContractWithoutAmendments {
          * Determines when the contract will stop creating recurring commits. Optional
          */
         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.
          */
@@ -298,16 +531,26 @@ export declare 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
          * individual unexpired commit will roll over upon contract transition. Must be
          * 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;
     }
     namespace RecurringCommit {
         /**
@@ -315,8 +558,8 @@ export declare namespace ContractWithoutAmendments {
          */
         interface AccessAmount {
             credit_type_id: string;
-            quantity: number;
             unit_price: number;
+            quantity?: number;
         }
         /**
          * The amount of time the created commits will be valid for
@@ -332,6 +575,24 @@ export declare namespace ContractWithoutAmendments {
         interface Contract {
             id: string;
         }
+        /**
+         * Optional configuration for recurring commit/credit hierarchy access control
+         */
+        interface HierarchyConfiguration {
+            child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+        }
+        namespace HierarchyConfiguration {
+            interface CommitHierarchyChildAccessAll {
+                type: 'ALL';
+            }
+            interface CommitHierarchyChildAccessNone {
+                type: 'NONE';
+            }
+            interface CommitHierarchyChildAccessContractIDs {
+                contract_ids: Array<string>;
+                type: 'CONTRACT_IDS';
+            }
+        }
         /**
          * The amount the customer should be billed for the commit. Not required.
          */
@@ -340,6 +601,39 @@ export declare namespace ContractWithoutAmendments {
             quantity: number;
             unit_price: number;
         }
+        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.
+         */
+        interface SubscriptionConfig {
+            allocation: 'INDIVIDUAL' | 'POOLED';
+            apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+            subscription_id: string;
+        }
+        namespace SubscriptionConfig {
+            interface ApplySeatIncreaseConfig {
+                /**
+                 * Indicates whether a mid-period seat increase should be prorated.
+                 */
+                is_prorated: boolean;
+            }
+        }
     }
     interface RecurringCredit {
         id: string;
@@ -381,6 +675,10 @@ export declare namespace ContractWithoutAmendments {
          * Determines when the contract will stop creating recurring commits. Optional
          */
         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
          */
@@ -398,16 +696,26 @@ export declare 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
          * individual unexpired commit will roll over upon contract transition. Must be
          * 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;
     }
     namespace RecurringCredit {
         /**
@@ -415,8 +723,8 @@ export declare namespace ContractWithoutAmendments {
          */
         interface AccessAmount {
             credit_type_id: string;
-            quantity: number;
             unit_price: number;
+            quantity?: number;
         }
         /**
          * The amount of time the created commits will be valid for
@@ -432,6 +740,57 @@ export declare namespace ContractWithoutAmendments {
         interface Contract {
             id: string;
         }
+        /**
+         * Optional configuration for recurring commit/credit hierarchy access control
+         */
+        interface HierarchyConfiguration {
+            child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+        }
+        namespace HierarchyConfiguration {
+            interface CommitHierarchyChildAccessAll {
+                type: 'ALL';
+            }
+            interface CommitHierarchyChildAccessNone {
+                type: 'NONE';
+            }
+            interface CommitHierarchyChildAccessContractIDs {
+                contract_ids: Array<string>;
+                type: 'CONTRACT_IDS';
+            }
+        }
+        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.
+         */
+        interface SubscriptionConfig {
+            allocation: 'INDIVIDUAL' | 'POOLED';
+            apply_seat_increase_config: SubscriptionConfig.ApplySeatIncreaseConfig;
+            subscription_id: string;
+        }
+        namespace SubscriptionConfig {
+            interface ApplySeatIncreaseConfig {
+                /**
+                 * Indicates whether a mid-period seat increase should be prorated.
+                 */
+                is_prorated: boolean;
+            }
+        }
     }
     interface ResellerRoyalty {
         fraction: number;
@@ -448,34 +807,28 @@ export declare namespace ContractWithoutAmendments {
         gcp_offer_id?: string;
         reseller_contract_value?: number;
     }
-    interface ThresholdBillingConfiguration {
-        commit: ThresholdBillingConfiguration.Commit;
+    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.
          */
         threshold_amount: number;
     }
-    namespace ThresholdBillingConfiguration {
+    namespace SpendThresholdConfiguration {
         interface Commit {
-            product_id: 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.
+             * The commit product that will be used to generate the line item for commit
+             * payment.
              */
-            applicable_product_ids?: Array<string>;
-            /**
-             * 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.
-             */
-            applicable_product_tags?: Array<string>;
+            product_id: string;
             description?: string;
             /**
              * Specify the name of the line item for the threshold charge. If left blank, it
@@ -483,6 +836,62 @@ export declare namespace ContractWithoutAmendments {
              */
             name?: string;
         }
+        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';
+        }
+        namespace PaymentGateConfig {
+            /**
+             * Only applicable if using PRECALCULATED as your tax type.
+             */
+            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.
+             */
+            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;
+                };
+            }
+        }
     }
     interface UsageFilter {
         current: Shared.BaseUsageFilter | null;
@@ -520,13 +929,19 @@ export interface Credit {
      */
     balance?: number;
     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.
      */
-    ledger?: Array<Credit.CreditSegmentStartLedgerEntry | Credit.CreditAutomatedInvoiceDeductionLedgerEntry | Credit.CreditExpirationLedgerEntry | Credit.CreditCanceledLedgerEntry | Credit.CreditCreditedLedgerEntry | Credit.CreditManualLedgerEntry>;
+    ledger?: Array<Credit.CreditSegmentStartLedgerEntry | Credit.CreditAutomatedInvoiceDeductionLedgerEntry | Credit.CreditExpirationLedgerEntry | Credit.CreditCanceledLedgerEntry | Credit.CreditCreditedLedgerEntry | Credit.CreditManualLedgerEntry | Credit.CreditSeatBasedAdjustmentLedgerEntry>;
     name?: string;
     /**
      * This field's availability is dependent on your client's configuration.
@@ -542,6 +957,12 @@ export interface Credit {
      * This field's availability is dependent on your client's configuration.
      */
     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
@@ -558,6 +979,24 @@ export declare namespace Credit {
     interface Contract {
         id: string;
     }
+    /**
+     * Optional configuration for credit hierarchy access control
+     */
+    interface HierarchyConfiguration {
+        child_access: HierarchyConfiguration.CommitHierarchyChildAccessAll | HierarchyConfiguration.CommitHierarchyChildAccessNone | HierarchyConfiguration.CommitHierarchyChildAccessContractIDs;
+    }
+    namespace HierarchyConfiguration {
+        interface CommitHierarchyChildAccessAll {
+            type: 'ALL';
+        }
+        interface CommitHierarchyChildAccessNone {
+            type: 'NONE';
+        }
+        interface CommitHierarchyChildAccessContractIDs {
+            contract_ids: Array<string>;
+            type: 'CONTRACT_IDS';
+        }
+    }
     interface CreditSegmentStartLedgerEntry {
         amount: number;
         segment_id: string;
@@ -570,6 +1009,7 @@ export declare namespace Credit {
         segment_id: string;
         timestamp: string;
         type: 'CREDIT_AUTOMATED_INVOICE_DEDUCTION';
+        contract_id?: string;
     }
     interface CreditExpirationLedgerEntry {
         amount: number;
@@ -583,6 +1023,7 @@ export declare namespace Credit {
         segment_id: string;
         timestamp: string;
         type: 'CREDIT_CANCELED';
+        contract_id?: string;
     }
     interface CreditCreditedLedgerEntry {
         amount: number;
@@ -590,6 +1031,7 @@ export declare namespace Credit {
         segment_id: string;
         timestamp: string;
         type: 'CREDIT_CREDITED';
+        contract_id?: string;
     }
     interface CreditManualLedgerEntry {
         amount: number;
@@ -597,6 +1039,29 @@ export declare namespace Credit {
         timestamp: string;
         type: 'CREDIT_MANUAL';
     }
+    interface CreditSeatBasedAdjustmentLedgerEntry {
+        amount: number;
+        segment_id: string;
+        timestamp: string;
+        type: 'CREDIT_SEAT_BASED_ADJUSTMENT';
+    }
+    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 {
     id: string;
@@ -606,7 +1071,9 @@ export interface Discount {
     id: string;
     product: Discount.Product;
     schedule: SchedulePointInTime;
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
     name?: string;
     /**
      * This field's availability is dependent on your client's configuration.
@@ -678,14 +1145,20 @@ 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 declare namespace Override {
     interface OverrideSpecifier {
-        billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL';
+        billing_frequency?: 'MONTHLY' | 'QUARTERLY' | 'ANNUAL' | 'WEEKLY';
         commit_ids?: Array<string>;
-        presentation_group_values?: Record<string, string | null>;
-        pricing_group_values?: Record<string, string>;
+        presentation_group_values?: {
+            [key: string]: string | null;
+        };
+        pricing_group_values?: {
+            [key: string]: string;
+        };
         product_id?: string;
         product_tags?: Array<string>;
         recurring_commit_ids?: Array<string>;
@@ -702,7 +1175,9 @@ export declare 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
          * set to true.
@@ -771,7 +1246,9 @@ export interface ProService {
      * amount and must be specified.
      */
     unit_price: number;
-    custom_fields?: Record<string, string>;
+    custom_fields?: {
+        [key: string]: string;
+    };
     description?: string;
     /**
      * This field's availability is dependent on your client's configuration.
@@ -785,7 +1262,9 @@ 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
      * set to true.
@@ -800,7 +1279,9 @@ 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.
      */
@@ -820,7 +1301,10 @@ export interface ScheduledCharge {
     id: string;
     product: ScheduledCharge.Product;
     schedule: SchedulePointInTime;
-    custom_fields?: Record<string, string>;
+    archived_at?: string;
+    custom_fields?: {
+        [key: string]: string;
+    };
     /**
      * displayed on invoices
      */
@@ -856,10 +1340,10 @@ export declare namespace SchedulePointInTime {
     interface ScheduleItem {
         id: string;
         amount: number;
-        invoice_id: string;
         quantity: number;
         timestamp: string;
         unit_price: number;
+        invoice_id?: string | null;
     }
 }
 export interface Tier {