## Retrieve **post** `/v2/contracts/get` Get a specific contract. New clients should use this endpoint rather than the v1 endpoint. ### Returns - **data:** `object` - **id:** `string` - **commits:** `array of object` - **id:** `string` - **product:** `object` - **id:** `string` - **name:** `string` - **type:** `"PREPAID" OR "POSTPAID"` - `"PREPAID"` - `"POSTPAID"` - **access\_schedule:** `ScheduleDuration` The schedule that the customer will gain access to the credits purposed with this commit. - **applicable\_contract\_ids:** `array of string` - **applicable\_product\_ids:** `array of string` - **applicable\_product\_tags:** `array of string` - **archived\_at:** `string` - **balance:** `number` 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, expired and upcoming credit or commit segments contribute 0 to the balance. The balance will match the sum of all ledger entries with the exception of the case where the sum of negative manual ledger entries exceeds the positive amount remaining on the credit or commit - in that case, the balance will be 0. All manual ledger entries associated with active credit or commit segments are included in the balance, including future-dated manual ledger entries. - **contract:** `object` - **id:** `string` - **custom\_fields:** `map[string]` - **description:** `string` - **hierarchy\_configuration:** `object` Optional configuration for commit hierarchy access control - **child\_access:** `object OR object OR object` - **CommitHierarchyChildAccessAll:** `object` - **type:** `"ALL"` - `"ALL"` - **CommitHierarchyChildAccessNone:** `object` - **type:** `"NONE"` - `"NONE"` - **CommitHierarchyChildAccessContractIDs:** `object` - **contract\_ids:** `array of string` - **type:** `"CONTRACT_IDS"` - `"CONTRACT_IDS"` - **invoice\_contract:** `object` The contract that this commit will be billed on. - **id:** `string` - **invoice\_schedule:** `SchedulePointInTime` The schedule that the customer will be invoiced for this commit. - **ledger:** `array of object OR object OR object OR 11 more` A list of ordered events that impact the balance of a commit. For example, an invoice deduction or a rollover. - **PrepaidCommitSegmentStartLedgerEntry:** `object` - **amount:** `number` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"PREPAID_COMMIT_SEGMENT_START"` - `"PREPAID_COMMIT_SEGMENT_START"` - **PrepaidCommitAutomatedInvoiceDeductionLedgerEntry:** `object` - **amount:** `number` - **invoice\_id:** `string` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"` - `"PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"` - **contract\_id:** `string` - **PrepaidCommitRolloverLedgerEntry:** `object` - **amount:** `number` - **new\_contract\_id:** `string` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"PREPAID_COMMIT_ROLLOVER"` - `"PREPAID_COMMIT_ROLLOVER"` - **PrepaidCommitExpirationLedgerEntry:** `object` - **amount:** `number` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"PREPAID_COMMIT_EXPIRATION"` - `"PREPAID_COMMIT_EXPIRATION"` - **PrepaidCommitCanceledLedgerEntry:** `object` - **amount:** `number` - **invoice\_id:** `string` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"PREPAID_COMMIT_CANCELED"` - `"PREPAID_COMMIT_CANCELED"` - **contract\_id:** `string` - **PrepaidCommitCreditedLedgerEntry:** `object` - **amount:** `number` - **invoice\_id:** `string` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"PREPAID_COMMIT_CREDITED"` - `"PREPAID_COMMIT_CREDITED"` - **contract\_id:** `string` - **PrepaidCommitSeatBasedAdjustmentLedgerEntry:** `object` - **amount:** `number` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT"` - `"PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT"` - **PostpaidCommitInitialBalanceLedgerEntry:** `object` - **amount:** `number` - **timestamp:** `string` - **type:** `"POSTPAID_COMMIT_INITIAL_BALANCE"` - `"POSTPAID_COMMIT_INITIAL_BALANCE"` - **PostpaidCommitAutomatedInvoiceDeductionLedgerEntry:** `object` - **amount:** `number` - **invoice\_id:** `string` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"` - `"POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"` - **contract\_id:** `string` - **PostpaidCommitRolloverLedgerEntry:** `object` - **amount:** `number` - **new\_contract\_id:** `string` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"POSTPAID_COMMIT_ROLLOVER"` - `"POSTPAID_COMMIT_ROLLOVER"` - **PostpaidCommitTrueupLedgerEntry:** `object` - **amount:** `number` - **invoice\_id:** `string` - **timestamp:** `string` - **type:** `"POSTPAID_COMMIT_TRUEUP"` - `"POSTPAID_COMMIT_TRUEUP"` - **contract\_id:** `string` - **PrepaidCommitManualLedgerEntry:** `object` - **amount:** `number` - **reason:** `string` - **timestamp:** `string` - **type:** `"PREPAID_COMMIT_MANUAL"` - `"PREPAID_COMMIT_MANUAL"` - **PostpaidCommitManualLedgerEntry:** `object` - **amount:** `number` - **reason:** `string` - **timestamp:** `string` - **type:** `"POSTPAID_COMMIT_MANUAL"` - `"POSTPAID_COMMIT_MANUAL"` - **PostpaidCommitExpirationLedgerEntry:** `object` - **amount:** `number` - **timestamp:** `string` - **type:** `"POSTPAID_COMMIT_EXPIRATION"` - `"POSTPAID_COMMIT_EXPIRATION"` - **name:** `string` - **netsuite\_sales\_order\_id:** `string` This field's availability is dependent on your client's configuration. - **priority:** `number` If multiple credits or commits are applicable, the one with the lower priority will apply first. - **rate\_type:** `"COMMIT_RATE" OR "LIST_RATE"` - `"COMMIT_RATE"` - `"LIST_RATE"` - **rolled\_over\_from:** `object` - **commit\_id:** `string` - **contract\_id:** `string` - **rollover\_fraction:** `number` - **salesforce\_opportunity\_id:** `string` This field's availability is dependent on your client's configuration. - **specifiers:** `array of object` 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. - **presentation\_group\_values:** `map[string]` - **pricing\_group\_values:** `map[string]` - **product\_id:** `string` If provided, the specifier will only apply to the product with the specified ID. - **product\_tags:** `array of string` If provided, the specifier will only apply to products with all the specified tags. - **created\_at:** `string` - **created\_by:** `string` - **customer\_id:** `string` - **overrides:** `array of object` - **id:** `string` - **starting\_at:** `string` - **applicable\_product\_tags:** `array of string` - **ending\_before:** `string` - **entitled:** `boolean` - **is\_commit\_specific:** `boolean` - **multiplier:** `number` - **override\_specifiers:** `array of object` - **billing\_frequency:** `"MONTHLY" OR "QUARTERLY" OR "ANNUAL" OR "WEEKLY"` - `"MONTHLY"` - `"QUARTERLY"` - `"ANNUAL"` - `"WEEKLY"` - **commit\_ids:** `array of string` - **presentation\_group\_values:** `map[string]` - **pricing\_group\_values:** `map[string]` - **product\_id:** `string` - **product\_tags:** `array of string` - **recurring\_commit\_ids:** `array of string` - **recurring\_credit\_ids:** `array of string` - **override\_tiers:** `array of object` - **multiplier:** `number` - **size:** `number` - **overwrite\_rate:** `object` - **rate\_type:** `"FLAT" OR "PERCENTAGE" OR "SUBSCRIPTION" OR 2 more` - `"FLAT"` - `"PERCENTAGE"` - `"SUBSCRIPTION"` - `"TIERED"` - `"CUSTOM"` - **credit\_type:** `CreditTypeData` - **custom\_rate:** `map[unknown]` Only set for CUSTOM rate_type. This field is interpreted by custom rate processors. - **is\_prorated:** `boolean` Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true. - **price:** `number` Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1. - **quantity:** `number` Default quantity. For SUBSCRIPTION rate_type, this must be >=0. - **tiers:** `array of Tier` Only set for TIERED rate_type. - **priority:** `number` - **product:** `object` - **id:** `string` - **name:** `string` - **target:** `"COMMIT_RATE" OR "LIST_RATE"` - `"COMMIT_RATE"` - `"LIST_RATE"` - **type:** `"OVERWRITE" OR "MULTIPLIER" OR "TIERED"` - `"OVERWRITE"` - `"MULTIPLIER"` - `"TIERED"` - **scheduled\_charges:** `array of ScheduledCharge` - **starting\_at:** `string` - **transitions:** `array of object` - **from\_contract\_id:** `string` - **to\_contract\_id:** `string` - **type:** `"SUPERSEDE" OR "RENEWAL"` - `"SUPERSEDE"` - `"RENEWAL"` - **usage\_filter:** `array of object` - **group\_key:** `string` - **group\_values:** `array of string` - **starting\_at:** `string` This will match contract starting_at value if usage filter is active from the beginning of the contract. - **ending\_before:** `string` This will match contract ending_before value if usage filter is active until the end of the contract. It will be undefined if the contract is open-ended. - **usage\_statement\_schedule:** `object` - **billing\_anchor\_date:** `string` Contract usage statements follow a selected cadence based on this date. - **frequency:** `"MONTHLY" OR "QUARTERLY" OR "ANNUAL" OR "WEEKLY"` - `"MONTHLY"` - `"QUARTERLY"` - `"ANNUAL"` - `"WEEKLY"` - **archived\_at:** `string` - **credits:** `array of object` - **id:** `string` - **product:** `object` - **id:** `string` - **name:** `string` - **type:** `"CREDIT"` - `"CREDIT"` - **access\_schedule:** `ScheduleDuration` The schedule that the customer will gain access to the credits. - **applicable\_contract\_ids:** `array of string` - **applicable\_product\_ids:** `array of string` - **applicable\_product\_tags:** `array of string` - **balance:** `number` 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, expired and upcoming credit or commit segments contribute 0 to the balance. The balance will match the sum of all ledger entries with the exception of the case where the sum of negative manual ledger entries exceeds the positive amount remaining on the credit or commit - in that case, the balance will be 0. All manual ledger entries associated with active credit or commit segments are included in the balance, including future-dated manual ledger entries. - **contract:** `object` - **id:** `string` - **custom\_fields:** `map[string]` - **description:** `string` - **hierarchy\_configuration:** `object` Optional configuration for credit hierarchy access control - **child\_access:** `object OR object OR object` - **CommitHierarchyChildAccessAll:** `object` - **type:** `"ALL"` - `"ALL"` - **CommitHierarchyChildAccessNone:** `object` - **type:** `"NONE"` - `"NONE"` - **CommitHierarchyChildAccessContractIDs:** `object` - **contract\_ids:** `array of string` - **type:** `"CONTRACT_IDS"` - `"CONTRACT_IDS"` - **ledger:** `array of object OR object OR object OR 4 more` A list of ordered events that impact the balance of a credit. For example, an invoice deduction or an expiration. - **CreditSegmentStartLedgerEntry:** `object` - **amount:** `number` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"CREDIT_SEGMENT_START"` - `"CREDIT_SEGMENT_START"` - **CreditAutomatedInvoiceDeductionLedgerEntry:** `object` - **amount:** `number` - **invoice\_id:** `string` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"CREDIT_AUTOMATED_INVOICE_DEDUCTION"` - `"CREDIT_AUTOMATED_INVOICE_DEDUCTION"` - **contract\_id:** `string` - **CreditExpirationLedgerEntry:** `object` - **amount:** `number` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"CREDIT_EXPIRATION"` - `"CREDIT_EXPIRATION"` - **CreditCanceledLedgerEntry:** `object` - **amount:** `number` - **invoice\_id:** `string` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"CREDIT_CANCELED"` - `"CREDIT_CANCELED"` - **contract\_id:** `string` - **CreditCreditedLedgerEntry:** `object` - **amount:** `number` - **invoice\_id:** `string` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"CREDIT_CREDITED"` - `"CREDIT_CREDITED"` - **contract\_id:** `string` - **CreditManualLedgerEntry:** `object` - **amount:** `number` - **reason:** `string` - **timestamp:** `string` - **type:** `"CREDIT_MANUAL"` - `"CREDIT_MANUAL"` - **CreditSeatBasedAdjustmentLedgerEntry:** `object` - **amount:** `number` - **segment\_id:** `string` - **timestamp:** `string` - **type:** `"CREDIT_SEAT_BASED_ADJUSTMENT"` - `"CREDIT_SEAT_BASED_ADJUSTMENT"` - **name:** `string` - **netsuite\_sales\_order\_id:** `string` This field's availability is dependent on your client's configuration. - **priority:** `number` If multiple credits or commits are applicable, the one with the lower priority will apply first. - **salesforce\_opportunity\_id:** `string` This field's availability is dependent on your client's configuration. - **specifiers:** `array of object` 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. - **presentation\_group\_values:** `map[string]` - **pricing\_group\_values:** `map[string]` - **product\_id:** `string` If provided, the specifier will only apply to the product with the specified ID. - **product\_tags:** `array of string` If provided, the specifier will only apply to products with all the specified tags. - **custom\_fields:** `map[string]` - **customer\_billing\_provider\_configuration:** `object` This field's availability is dependent on your client's configuration. - **id:** `string` ID of Customer's billing provider configuration. - **billing\_provider:** `"aws_marketplace" OR "stripe" OR "netsuite" OR 5 more` - `"aws_marketplace"` - `"stripe"` - `"netsuite"` - `"custom"` - `"azure_marketplace"` - `"quickbooks_online"` - `"workday"` - `"gcp_marketplace"` - **delivery\_method:** `"direct_to_billing_provider" OR "aws_sqs" OR "tackle" OR "aws_sns"` - `"direct_to_billing_provider"` - `"aws_sqs"` - `"tackle"` - `"aws_sns"` - **discounts:** `array of Discount` This field's availability is dependent on your client's configuration. - **ending\_before:** `string` - **has\_more:** `object` Indicates whether there are more items than the limit for this endpoint. Use the respective list endpoints to get the full lists. - **commits:** `boolean` Whether there are more commits on this contract than the limit for this endpoint. Use the /contracts/customerCommits/list endpoint to get the full list of commits. - **credits:** `boolean` Whether there are more credits on this contract than the limit for this endpoint. Use the /contracts/customerCredits/list endpoint to get the full list of credits. - **hierarchy\_configuration:** `object OR object` Either a **parent** configuration with a list of children or a **child** configuration with a single parent. - **ParentHierarchyConfiguration:** `object` - **children:** `array of object` List of contracts that belong to this parent. - **contract\_id:** `string` - **customer\_id:** `string` - **ChildHierarchyConfiguration:** `object` - **parent:** `object` The single parent contract/customer for this child. - **contract\_id:** `string` - **customer\_id:** `string` - **multiplier\_override\_prioritization:** `"LOWEST_MULTIPLIER" OR "EXPLICIT"` Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list prices automatically. EXPLICIT prioritization requires specifying priorities for each multiplier; the one with the lowest priority value will be prioritized first. - `"LOWEST_MULTIPLIER"` - `"EXPLICIT"` - **name:** `string` - **net\_payment\_terms\_days:** `number` - **netsuite\_sales\_order\_id:** `string` This field's availability is dependent on your client's configuration. - **prepaid\_balance\_threshold\_configuration:** `object` - **commit:** `object` - **product\_id:** `string` The commit product that will be used to generate the line item for commit payment. - **applicable\_product\_ids:** `array of 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\_tags:** `array of 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. - **description:** `string` - **name:** `string` Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name. - **specifiers:** `array of object` 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`. Instead, to target usage by product or product tag, pass those values in the body of `specifiers`. - **presentation\_group\_values:** `map[string]` - **pricing\_group\_values:** `map[string]` - **product\_id:** `string` If provided, the specifier will only apply to the product with the specified ID. - **product\_tags:** `array of string` If provided, the specifier will only apply to products with all the specified tags. - **is\_enabled:** `boolean` 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. - **payment\_gate\_config:** `object` - **payment\_gate\_type:** `"NONE" OR "STRIPE" OR "EXTERNAL"` 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. - `"NONE"` - `"STRIPE"` - `"EXTERNAL"` - **precalculated\_tax\_config:** `object` Only applicable if using PRECALCULATED as your tax type. - **tax\_amount:** `number` Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule - **tax\_name:** `string` Name of the tax to be applied. This may be used in an invoice line item description. - **stripe\_config:** `object` Only applicable if using STRIPE as your payment gateway type. - **payment\_type:** `"INVOICE" OR "PAYMENT_INTENT"` If left blank, will default to INVOICE - `"INVOICE"` - `"PAYMENT_INTENT"` - **invoice\_metadata:** `map[string]` Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type. - **tax\_type:** `"NONE" OR "STRIPE" OR "ANROK" OR "PRECALCULATED"` 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. - `"NONE"` - `"STRIPE"` - `"ANROK"` - `"PRECALCULATED"` - **recharge\_to\_amount:** `number` Specify the amount the balance should be recharged to. - **threshold\_amount:** `number` Specify the threshold amount for the contract. Each time the contract's balance lowers to this amount, a threshold charge will be initiated. - **custom\_credit\_type\_id:** `string` 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. - **priority:** `number` Priority of the contract. - **professional\_services:** `array of ProService` This field's availability is dependent on your client's configuration. - **rate\_card\_id:** `string` - **recurring\_commits:** `array of object` - **id:** `string` - **access\_amount:** `object` The amount of commit to grant. - **credit\_type\_id:** `string` - **unit\_price:** `number` - **quantity:** `number` - **commit\_duration:** `object` The amount of time the created commits will be valid for - **value:** `number` - **unit:** `"PERIODS"` - `"PERIODS"` - **priority:** `number` Will be passed down to the individual commits - **product:** `object` - **id:** `string` - **name:** `string` - **rate\_type:** `"COMMIT_RATE" OR "LIST_RATE"` Whether the created commits will use the commit rate or list rate - `"COMMIT_RATE"` - `"LIST_RATE"` - **starting\_at:** `string` Determines the start time for the first commit - **applicable\_product\_ids:** `array of string` Will be passed down to the individual commits - **applicable\_product\_tags:** `array of string` Will be passed down to the individual commits - **contract:** `object` - **id:** `string` - **description:** `string` Will be passed down to the individual commits - **ending\_before:** `string` Determines when the contract will stop creating recurring commits. Optional - **hierarchy\_configuration:** `object` Optional configuration for recurring credit hierarchy access control - **child\_access:** `object OR object OR object` - **CommitHierarchyChildAccessAll:** `object` - **type:** `"ALL"` - `"ALL"` - **CommitHierarchyChildAccessNone:** `object` - **type:** `"NONE"` - `"NONE"` - **CommitHierarchyChildAccessContractIDs:** `object` - **contract\_ids:** `array of string` - **type:** `"CONTRACT_IDS"` - `"CONTRACT_IDS"` - **invoice\_amount:** `object` The amount the customer should be billed for the commit. Not required. - **credit\_type\_id:** `string` - **quantity:** `number` - **unit\_price:** `number` - **name:** `string` Displayed on invoices. Will be passed through to the individual commits - **netsuite\_sales\_order\_id:** `string` Will be passed down to the individual commits - **proration:** `"NONE" OR "FIRST" OR "LAST" OR "FIRST_AND_LAST"` Determines whether the first and last commit will be prorated. If not provided, the default is FIRST_AND_LAST (i.e. prorate both the first and last commits). - `"NONE"` - `"FIRST"` - `"LAST"` - `"FIRST_AND_LAST"` - **recurrence\_frequency:** `"MONTHLY" OR "QUARTERLY" OR "ANNUAL" OR "WEEKLY"` 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 starting_at rather than the usage invoice dates. - `"MONTHLY"` - `"QUARTERLY"` - `"ANNUAL"` - `"WEEKLY"` - **rollover\_fraction:** `number` 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. - **specifiers:** `array of object` 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. - **presentation\_group\_values:** `map[string]` - **pricing\_group\_values:** `map[string]` - **product\_id:** `string` If provided, the specifier will only apply to the product with the specified ID. - **product\_tags:** `array of string` If provided, the specifier will only apply to products with all the specified tags. - **subscription\_config:** `object` Attach a subscription to the recurring commit/credit. - **allocation:** `"INDIVIDUAL" OR "POOLED"` - `"INDIVIDUAL"` - `"POOLED"` - **apply\_seat\_increase\_config:** `object` - **is\_prorated:** `boolean` Indicates whether a mid-period seat increase should be prorated. - **subscription\_id:** `string` - **recurring\_credits:** `array of object` - **id:** `string` - **access\_amount:** `object` The amount of commit to grant. - **credit\_type\_id:** `string` - **unit\_price:** `number` - **quantity:** `number` - **commit\_duration:** `object` The amount of time the created commits will be valid for - **value:** `number` - **unit:** `"PERIODS"` - `"PERIODS"` - **priority:** `number` Will be passed down to the individual commits - **product:** `object` - **id:** `string` - **name:** `string` - **rate\_type:** `"COMMIT_RATE" OR "LIST_RATE"` Whether the created commits will use the commit rate or list rate - `"COMMIT_RATE"` - `"LIST_RATE"` - **starting\_at:** `string` Determines the start time for the first commit - **applicable\_product\_ids:** `array of string` Will be passed down to the individual commits - **applicable\_product\_tags:** `array of string` Will be passed down to the individual commits - **contract:** `object` - **id:** `string` - **description:** `string` Will be passed down to the individual commits - **ending\_before:** `string` Determines when the contract will stop creating recurring commits. Optional - **hierarchy\_configuration:** `object` Optional configuration for recurring credit hierarchy access control - **child\_access:** `object OR object OR object` - **CommitHierarchyChildAccessAll:** `object` - **type:** `"ALL"` - `"ALL"` - **CommitHierarchyChildAccessNone:** `object` - **type:** `"NONE"` - `"NONE"` - **CommitHierarchyChildAccessContractIDs:** `object` - **contract\_ids:** `array of string` - **type:** `"CONTRACT_IDS"` - `"CONTRACT_IDS"` - **name:** `string` Displayed on invoices. Will be passed through to the individual commits - **netsuite\_sales\_order\_id:** `string` Will be passed down to the individual commits - **proration:** `"NONE" OR "FIRST" OR "LAST" OR "FIRST_AND_LAST"` Determines whether the first and last commit will be prorated. If not provided, the default is FIRST_AND_LAST (i.e. prorate both the first and last commits). - `"NONE"` - `"FIRST"` - `"LAST"` - `"FIRST_AND_LAST"` - **recurrence\_frequency:** `"MONTHLY" OR "QUARTERLY" OR "ANNUAL" OR "WEEKLY"` 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 starting_at rather than the usage invoice dates. - `"MONTHLY"` - `"QUARTERLY"` - `"ANNUAL"` - `"WEEKLY"` - **rollover\_fraction:** `number` 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. - **specifiers:** `array of object` 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. - **presentation\_group\_values:** `map[string]` - **pricing\_group\_values:** `map[string]` - **product\_id:** `string` If provided, the specifier will only apply to the product with the specified ID. - **product\_tags:** `array of string` If provided, the specifier will only apply to products with all the specified tags. - **subscription\_config:** `object` Attach a subscription to the recurring commit/credit. - **allocation:** `"INDIVIDUAL" OR "POOLED"` - `"INDIVIDUAL"` - `"POOLED"` - **apply\_seat\_increase\_config:** `object` - **is\_prorated:** `boolean` Indicates whether a mid-period seat increase should be prorated. - **subscription\_id:** `string` - **reseller\_royalties:** `array of object` This field's availability is dependent on your client's configuration. - **reseller\_type:** `"AWS" OR "AWS_PRO_SERVICE" OR "GCP" OR "GCP_PRO_SERVICE"` - `"AWS"` - `"AWS_PRO_SERVICE"` - `"GCP"` - `"GCP_PRO_SERVICE"` - **segments:** `array of object` - **fraction:** `number` - **netsuite\_reseller\_id:** `string` - **reseller\_type:** `"AWS" OR "AWS_PRO_SERVICE" OR "GCP" OR "GCP_PRO_SERVICE"` - `"AWS"` - `"AWS_PRO_SERVICE"` - `"GCP"` - `"GCP_PRO_SERVICE"` - **starting\_at:** `string` - **applicable\_product\_ids:** `array of string` - **applicable\_product\_tags:** `array of string` - **aws\_account\_number:** `string` - **aws\_offer\_id:** `string` - **aws\_payer\_reference\_id:** `string` - **ending\_before:** `string` - **gcp\_account\_id:** `string` - **gcp\_offer\_id:** `string` - **reseller\_contract\_value:** `number` - **salesforce\_opportunity\_id:** `string` This field's availability is dependent on your client's configuration. - **scheduled\_charges\_on\_usage\_invoices:** `"ALL"` Determines which scheduled and commit charges to consolidate onto the Contract's usage invoice. The charge's `timestamp` must match the usage invoice's `ending_before` date for consolidation to occur. This field cannot be modified after a Contract has been created. If this field is omitted, charges will appear on a separate invoice from usage charges. - `"ALL"` - **spend\_threshold\_configuration:** `object` - **commit:** `object` - **product\_id:** `string` The commit product that will be used to generate the line item for commit payment. - **description:** `string` - **name:** `string` Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name. - **is\_enabled:** `boolean` 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. - **payment\_gate\_config:** `object` - **payment\_gate\_type:** `"NONE" OR "STRIPE" OR "EXTERNAL"` 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. - `"NONE"` - `"STRIPE"` - `"EXTERNAL"` - **precalculated\_tax\_config:** `object` Only applicable if using PRECALCULATED as your tax type. - **tax\_amount:** `number` Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule - **tax\_name:** `string` Name of the tax to be applied. This may be used in an invoice line item description. - **stripe\_config:** `object` Only applicable if using STRIPE as your payment gateway type. - **payment\_type:** `"INVOICE" OR "PAYMENT_INTENT"` If left blank, will default to INVOICE - `"INVOICE"` - `"PAYMENT_INTENT"` - **invoice\_metadata:** `map[string]` Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type. - **tax\_type:** `"NONE" OR "STRIPE" OR "ANROK" OR "PRECALCULATED"` 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. - `"NONE"` - `"STRIPE"` - `"ANROK"` - `"PRECALCULATED"` - **threshold\_amount:** `number` Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated. - **subscriptions:** `array of object` List of subscriptions on the contract. - **collection\_schedule:** `"ADVANCE" OR "ARREARS"` - `"ADVANCE"` - `"ARREARS"` - **proration:** `object` - **invoice\_behavior:** `"BILL_IMMEDIATELY" OR "BILL_ON_NEXT_COLLECTION_DATE"` - `"BILL_IMMEDIATELY"` - `"BILL_ON_NEXT_COLLECTION_DATE"` - **is\_prorated:** `boolean` - **quantity\_schedule:** `array of object` List of quantity schedule items for the subscription. Only includes the current quantity and future quantity changes. - **quantity:** `number` - **starting\_at:** `string` - **ending\_before:** `string` - **starting\_at:** `string` - **subscription\_rate:** `object` - **billing\_frequency:** `"MONTHLY" OR "QUARTERLY" OR "ANNUAL" OR "WEEKLY"` - `"MONTHLY"` - `"QUARTERLY"` - `"ANNUAL"` - `"WEEKLY"` - **product:** `object` - **id:** `string` - **name:** `string` - **id:** `string` - **custom\_fields:** `map[string]` - **description:** `string` - **ending\_before:** `string` - **fiat\_credit\_type\_id:** `string` - **name:** `string` - **total\_contract\_value:** `number` - **uniqueness\_key:** `string` Prevents the creation of duplicates. If a request to create a record is made with a previously used uniqueness key, a new record will not be created and the request will fail with a 409 error.