Skip to content
Metronome Docs
  • Auto
  • Light
  • Dark
Talk to an expert

List

API Reference
V2
Contracts
List customer contracts (v2)
v2.contracts.list(ContractListParams**kwargs) -> datalistContractListResponse
post/v2/contracts/list

List all contracts for a customer in chronological order. New clients should use this endpoint rather than the v1 endpoint.

Parameters
customer_idstr
formatuuid
covering_dateunion
optional
Union[str, datetime]

Optional RFC 3339 timestamp. Only include contracts active on the provided date. This cannot be provided if starting_at filter is provided.

formatdate-time
include_archivedbool
optional

Include archived contracts in the response.

include_balancebool
optional

Include the balance of credits and commits in the response. Setting this flag may cause the response to be slower.

include_ledgersbool
optional

Include commit/credit ledgers in the response. Setting this flag may cause the response to be slower.

starting_atunion
optional
Union[str, datetime]

Optional RFC 3339 timestamp. Only include contracts that started on or after this date. This cannot be provided if covering_date filter is provided.

formatdate-time
Returns
ContractListResponseclass
Hide ParametersShow Parameters
datalist
List[Data]
Hide ParametersShow Parameters
idstr
formatuuid
commitslist
List[DataCommit]
Hide ParametersShow Parameters
idstr
formatuuid
productidstrnamestrDataCommitProduct
Hide ParametersShow Parameters
idstr
formatuuid
namestr
typeliteral
Literal["PREPAID", "POSTPAID"]
Hide ParametersShow Parameters
"PREPAID"
"POSTPAID"
access_scheduleScheduleDuration
optional

The schedule that the customer will gain access to the credits purposed with this commit.

applicable_contract_idslist
optional
Optional[List[str]]
applicable_product_idslist
optional
Optional[List[str]]
applicable_product_tagslist
optional
Optional[List[str]]
archived_atdatetime
optional
formatdate-time
balancefloat
optional

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.

contractidstrDataCommitContract
optional
Hide ParametersShow Parameters
idstr
formatuuid
custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
descriptionstr
optional
hierarchy_configurationchild_accessDataCommitHierarchyConfigurationChildAccessDataCommitHierarchyConfiguration
optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters
child_accessDataCommitHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
DataCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
DataCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
DataCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
invoice_contractidstrDataCommitInvoiceContract
optional

The contract that this commit will be billed on.

Hide ParametersShow Parameters
idstr
formatuuid
invoice_scheduleSchedulePointInTime
optional

The schedule that the customer will be invoiced for this commit.

ledgerlist
optional
Optional[List[DataCommitLedger]]

A list of ordered events that impact the balance of a commit. For example, an invoice deduction or a rollover.

Hide ParametersShow Parameters
DataCommitLedgerPrepaidCommitSegmentStartLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_SEGMENT_START"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_SEGMENT_START"
DataCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
invoice_idstr
formatuuid
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"
contract_idstr
optional
formatuuid
DataCommitLedgerPrepaidCommitRolloverLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
new_contract_idstr
formatuuid
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_ROLLOVER"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_ROLLOVER"
DataCommitLedgerPrepaidCommitExpirationLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_EXPIRATION"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_EXPIRATION"
DataCommitLedgerPrepaidCommitCanceledLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
invoice_idstr
formatuuid
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_CANCELED"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_CANCELED"
contract_idstr
optional
formatuuid
DataCommitLedgerPrepaidCommitCreditedLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
invoice_idstr
formatuuid
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_CREDITED"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_CREDITED"
contract_idstr
optional
formatuuid
DataCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT"
DataCommitLedgerPostpaidCommitInitialBalanceLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
timestampdatetime
formatdate-time
typeliteral
Literal["POSTPAID_COMMIT_INITIAL_BALANCE"]
Hide ParametersShow Parameters
"POSTPAID_COMMIT_INITIAL_BALANCE"
DataCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
invoice_idstr
formatuuid
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"]
Hide ParametersShow Parameters
"POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"
contract_idstr
optional
formatuuid
DataCommitLedgerPostpaidCommitRolloverLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
new_contract_idstr
formatuuid
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["POSTPAID_COMMIT_ROLLOVER"]
Hide ParametersShow Parameters
"POSTPAID_COMMIT_ROLLOVER"
DataCommitLedgerPostpaidCommitTrueupLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
invoice_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["POSTPAID_COMMIT_TRUEUP"]
Hide ParametersShow Parameters
"POSTPAID_COMMIT_TRUEUP"
contract_idstr
optional
formatuuid
DataCommitLedgerPrepaidCommitManualLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
reasonstr
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_MANUAL"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_MANUAL"
DataCommitLedgerPostpaidCommitManualLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
reasonstr
timestampdatetime
formatdate-time
typeliteral
Literal["POSTPAID_COMMIT_MANUAL"]
Hide ParametersShow Parameters
"POSTPAID_COMMIT_MANUAL"
DataCommitLedgerPostpaidCommitExpirationLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
timestampdatetime
formatdate-time
typeliteral
Literal["POSTPAID_COMMIT_EXPIRATION"]
Hide ParametersShow Parameters
"POSTPAID_COMMIT_EXPIRATION"
namestr
optional
netsuite_sales_order_idstr
optional

This field's availability is dependent on your client's configuration.

priorityfloat
optional

If multiple credits or commits are applicable, the one with the lower priority will apply first.

rate_typeliteral
optional
Optional[Literal["COMMIT_RATE", "LIST_RATE"]]
Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
rolled_over_fromcommit_idstrcontract_idstrDataCommitRolledOverFrom
optional
Hide ParametersShow Parameters
commit_idstr
formatuuid
contract_idstr
formatuuid
rollover_fractionfloat
optional
salesforce_opportunity_idstr
optional

This field's availability is dependent on your client's configuration.

specifierslist
optional
Optional[List[DataCommitSpecifier]]

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.

Hide ParametersShow Parameters
presentation_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
pricing_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
product_idstr
optional

If provided, the specifier will only apply to the product with the specified ID.

formatuuid
product_tagslist
optional
Optional[List[str]]

If provided, the specifier will only apply to products with all the specified tags.

created_atdatetime
formatdate-time
created_bystr
customer_idstr
formatuuid
overrideslist
List[DataOverride]
Hide ParametersShow Parameters
idstr
formatuuid
starting_atdatetime
formatdate-time
applicable_product_tagslist
optional
Optional[List[str]]
ending_beforedatetime
optional
formatdate-time
entitledbool
optional
is_commit_specificbool
optional
multiplierfloat
optional
override_specifierslist
optional
Optional[List[DataOverrideOverrideSpecifier]]
Hide ParametersShow Parameters
billing_frequencyliteral
optional
Optional[Literal["MONTHLY", "QUARTERLY", "ANNUAL", "WEEKLY"]]
Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
commit_idslist
optional
Optional[List[str]]
presentation_group_valuesDict[str, Optional[str]]
optional
Optional[Dict[str, Optional[str]]]
pricing_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
product_idstr
optional
formatuuid
product_tagslist
optional
Optional[List[str]]
recurring_commit_idslist
optional
Optional[List[str]]
recurring_credit_idslist
optional
Optional[List[str]]
override_tierslist
optional
Optional[List[DataOverrideOverrideTier]]
Hide ParametersShow Parameters
multiplierfloat
sizefloat
optional
overwrite_raterate_typeliteralcredit_typeCreditTypeDatacustom_rateDict[str, object]is_proratedboolpricefloatquantityfloattierslistDataOverrideOverwriteRate
optional
Hide ParametersShow Parameters
rate_typeliteral
Literal["FLAT", "PERCENTAGE", "SUBSCRIPTION", 2 more]
Hide ParametersShow Parameters
"FLAT"
"PERCENTAGE"
"SUBSCRIPTION"
"TIERED"
"CUSTOM"
credit_typeCreditTypeData
optional
custom_rateDict[str, object]
optional
Optional[Dict[str, object]]

Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.

is_proratedbool
optional

Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.

pricefloat
optional

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.

quantityfloat
optional

Default quantity. For SUBSCRIPTION rate_type, this must be >=0.

tierslist
optional
Optional[List[pricefloatsizefloatTier]]

Only set for TIERED rate_type.

Hide ParametersShow Parameters
pricefloat
sizefloat
optional
priorityfloat
optional
productidstrnamestrDataOverrideProduct
optional
Hide ParametersShow Parameters
idstr
formatuuid
namestr
targetliteral
optional
Optional[Literal["COMMIT_RATE", "LIST_RATE"]]
Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
typeliteral
optional
Optional[Literal["OVERWRITE", "MULTIPLIER", "TIERED"]]
Hide ParametersShow Parameters
"OVERWRITE"
"MULTIPLIER"
"TIERED"
scheduled_chargeslist
List[idstrproductProductscheduleSchedulePointInTimearchived_atdatetimecustom_fieldsDict[str, str]namestrnetsuite_sales_order_idstrScheduledCharge]
Hide ParametersShow Parameters
idstr
formatuuid
productidstrnamestrProduct
Hide ParametersShow Parameters
idstr
formatuuid
namestr
schedulecredit_typeCreditTypeDatado_not_invoiceboolschedule_itemslistSchedulePointInTime
archived_atdatetime
optional
formatdate-time
custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
namestr
optional

displayed on invoices

minLength1
netsuite_sales_order_idstr
optional

This field's availability is dependent on your client's configuration.

starting_atdatetime
formatdate-time
transitionslist
List[DataTransition]
Hide ParametersShow Parameters
from_contract_idstr
formatuuid
to_contract_idstr
formatuuid
typeliteral
Literal["SUPERSEDE", "RENEWAL"]
Hide ParametersShow Parameters
"SUPERSEDE"
"RENEWAL"
usage_filterlist
List[DataUsageFilter]
Hide ParametersShow Parameters
group_keystr
group_valueslist
List[str]
starting_atdatetime

This will match contract starting_at value if usage filter is active from the beginning of the contract.

formatdate-time
ending_beforedatetime
optional

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.

formatdate-time
usage_statement_schedulebilling_anchor_datedatetimefrequencyliteralDataUsageStatementSchedule
Hide ParametersShow Parameters
billing_anchor_datedatetime

Contract usage statements follow a selected cadence based on this date.

formatdate-time
frequencyliteral
Literal["MONTHLY", "QUARTERLY", "ANNUAL", "WEEKLY"]
Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
archived_atdatetime
optional
formatdate-time
creditslist
optional
Optional[List[DataCredit]]
Hide ParametersShow Parameters
idstr
formatuuid
productidstrnamestrDataCreditProduct
Hide ParametersShow Parameters
idstr
formatuuid
namestr
typeliteral
Literal["CREDIT"]
Hide ParametersShow Parameters
"CREDIT"
access_scheduleScheduleDuration
optional

The schedule that the customer will gain access to the credits.

applicable_contract_idslist
optional
Optional[List[str]]
applicable_product_idslist
optional
Optional[List[str]]
applicable_product_tagslist
optional
Optional[List[str]]
balancefloat
optional

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.

contractidstrDataCreditContract
optional
Hide ParametersShow Parameters
idstr
formatuuid
custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
descriptionstr
optional
hierarchy_configurationchild_accessDataCreditHierarchyConfigurationChildAccessDataCreditHierarchyConfiguration
optional

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters
child_accessDataCreditHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
DataCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
DataCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
DataCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
ledgerlist
optional
Optional[List[DataCreditLedger]]

A list of ordered events that impact the balance of a credit. For example, an invoice deduction or an expiration.

Hide ParametersShow Parameters
DataCreditLedgerCreditSegmentStartLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["CREDIT_SEGMENT_START"]
Hide ParametersShow Parameters
"CREDIT_SEGMENT_START"
DataCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
invoice_idstr
formatuuid
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["CREDIT_AUTOMATED_INVOICE_DEDUCTION"]
Hide ParametersShow Parameters
"CREDIT_AUTOMATED_INVOICE_DEDUCTION"
contract_idstr
optional
formatuuid
DataCreditLedgerCreditExpirationLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["CREDIT_EXPIRATION"]
Hide ParametersShow Parameters
"CREDIT_EXPIRATION"
DataCreditLedgerCreditCanceledLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
invoice_idstr
formatuuid
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["CREDIT_CANCELED"]
Hide ParametersShow Parameters
"CREDIT_CANCELED"
contract_idstr
optional
formatuuid
DataCreditLedgerCreditCreditedLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
invoice_idstr
formatuuid
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["CREDIT_CREDITED"]
Hide ParametersShow Parameters
"CREDIT_CREDITED"
contract_idstr
optional
formatuuid
DataCreditLedgerCreditManualLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
reasonstr
timestampdatetime
formatdate-time
typeliteral
Literal["CREDIT_MANUAL"]
Hide ParametersShow Parameters
"CREDIT_MANUAL"
DataCreditLedgerCreditSeatBasedAdjustmentLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["CREDIT_SEAT_BASED_ADJUSTMENT"]
Hide ParametersShow Parameters
"CREDIT_SEAT_BASED_ADJUSTMENT"
namestr
optional
netsuite_sales_order_idstr
optional

This field's availability is dependent on your client's configuration.

priorityfloat
optional

If multiple credits or commits are applicable, the one with the lower priority will apply first.

salesforce_opportunity_idstr
optional

This field's availability is dependent on your client's configuration.

specifierslist
optional
Optional[List[DataCreditSpecifier]]

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.

Hide ParametersShow Parameters
presentation_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
pricing_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
product_idstr
optional

If provided, the specifier will only apply to the product with the specified ID.

formatuuid
product_tagslist
optional
Optional[List[str]]

If provided, the specifier will only apply to products with all the specified tags.

custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
customer_billing_provider_configurationidstrbilling_providerliteraldelivery_methodliteralDataCustomerBillingProviderConfiguration
optional

This field's availability is dependent on your client's configuration.

Hide ParametersShow Parameters
idstr

ID of Customer's billing provider configuration.

formatuuid
billing_providerliteral
Literal["aws_marketplace", "stripe", "netsuite", 5 more]
Hide ParametersShow Parameters
"aws_marketplace"
"stripe"
"netsuite"
"custom"
"azure_marketplace"
"quickbooks_online"
"workday"
"gcp_marketplace"
delivery_methodliteral
Literal["direct_to_billing_provider", "aws_sqs", "tackle", "aws_sns"]
Hide ParametersShow Parameters
"direct_to_billing_provider"
"aws_sqs"
"tackle"
"aws_sns"
discountslist
optional
Optional[List[idstrproductProductscheduleSchedulePointInTimecustom_fieldsDict[str, str]namestrnetsuite_sales_order_idstrDiscount]]

This field's availability is dependent on your client's configuration.

Hide ParametersShow Parameters
idstr
formatuuid
productidstrnamestrProduct
Hide ParametersShow Parameters
idstr
formatuuid
namestr
schedulecredit_typeCreditTypeDatado_not_invoiceboolschedule_itemslistSchedulePointInTime
custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
namestr
optional
minLength1
netsuite_sales_order_idstr
optional

This field's availability is dependent on your client's configuration.

ending_beforedatetime
optional
formatdate-time
has_morecommitsboolcreditsboolDataHasMore
optional

Indicates whether there are more items than the limit for this endpoint. Use the respective list endpoints to get the full lists.

Hide ParametersShow Parameters
commitsbool

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.

creditsbool

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_configurationDataHierarchyConfiguration
optional

Either a parent configuration with a list of children or a child configuration with a single parent.

Hide ParametersShow Parameters
DataHierarchyConfigurationParentHierarchyConfigurationclass
Hide ParametersShow Parameters
childrenlist
List[DataHierarchyConfigurationParentHierarchyConfigurationChild]

List of contracts that belong to this parent.

Hide ParametersShow Parameters
contract_idstr
formatuuid
customer_idstr
formatuuid
DataHierarchyConfigurationChildHierarchyConfigurationclass
Hide ParametersShow Parameters
parentcontract_idstrcustomer_idstrDataHierarchyConfigurationChildHierarchyConfigurationParent

The single parent contract/customer for this child.

Hide ParametersShow Parameters
contract_idstr
formatuuid
customer_idstr
formatuuid
multiplier_override_prioritizationliteral
optional
Optional[Literal["LOWEST_MULTIPLIER", "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.

Hide ParametersShow Parameters
"LOWEST_MULTIPLIER"
"EXPLICIT"
namestr
optional
net_payment_terms_daysfloat
optional
netsuite_sales_order_idstr
optional

This field's availability is dependent on your client's configuration.

prepaid_balance_threshold_configurationcommitDataPrepaidBalanceThresholdConfigurationCommitis_enabledboolpayment_gate_configDataPrepaidBalanceThresholdConfigurationPaymentGateConfigrecharge_to_amountfloatthreshold_amountfloatcustom_credit_type_idstrDataPrepaidBalanceThresholdConfiguration
optional
Hide ParametersShow Parameters
commitproduct_idstrapplicable_product_idslistapplicable_product_tagslistdescriptionstrnamestrspecifierslistDataPrepaidBalanceThresholdConfigurationCommit
Hide ParametersShow Parameters
product_idstr

The commit product that will be used to generate the line item for commit payment.

applicable_product_idslist
optional
Optional[List[str]]

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_tagslist
optional
Optional[List[str]]

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.

descriptionstr
optional
namestr
optional

Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.

specifierslist
optional
Optional[List[DataPrepaidBalanceThresholdConfigurationCommitSpecifier]]

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.

Hide ParametersShow Parameters
presentation_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
pricing_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
product_idstr
optional

If provided, the specifier will only apply to the product with the specified ID.

formatuuid
product_tagslist
optional
Optional[List[str]]

If provided, the specifier will only apply to products with all the specified tags.

is_enabledbool

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_configpayment_gate_typeliteralprecalculated_tax_configDataPrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigstripe_configDataPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigtax_typeliteralDataPrepaidBalanceThresholdConfigurationPaymentGateConfig
Hide ParametersShow Parameters
payment_gate_typeliteral
Literal["NONE", "STRIPE", "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.

Hide ParametersShow Parameters
"NONE"
"STRIPE"
"EXTERNAL"
precalculated_tax_configtax_amountfloattax_namestrDataPrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig
optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters
tax_amountfloat

Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule

tax_namestr
optional

Name of the tax to be applied. This may be used in an invoice line item description.

stripe_configpayment_typeliteralinvoice_metadataDict[str, str]DataPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfig
optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters
payment_typeliteral
Literal["INVOICE", "PAYMENT_INTENT"]

If left blank, will default to INVOICE

Hide ParametersShow Parameters
"INVOICE"
"PAYMENT_INTENT"
invoice_metadataDict[str, str]
optional
Optional[Dict[str, str]]

Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.

tax_typeliteral
optional
Optional[Literal["NONE", "STRIPE", "ANROK", "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.

Hide ParametersShow Parameters
"NONE"
"STRIPE"
"ANROK"
"PRECALCULATED"
recharge_to_amountfloat

Specify the amount the balance should be recharged to.

threshold_amountfloat

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_idstr
optional

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.

formatuuid
priorityfloat
optional

Priority of the contract.

professional_serviceslist
optional
Optional[List[idstrmax_amountfloatproduct_idstrquantityfloatunit_pricefloatcustom_fieldsDict[str, str]descriptionstrnetsuite_sales_order_idstrProService]]

This field's availability is dependent on your client's configuration.

Hide ParametersShow Parameters
idstr
formatuuid
max_amountfloat

Maximum amount for the term.

product_idstr
formatuuid
quantityfloat

Quantity for the charge. Will be multiplied by unit_price to determine the amount.

unit_pricefloat

Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified.

custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
descriptionstr
optional
netsuite_sales_order_idstr
optional

This field's availability is dependent on your client's configuration.

rate_card_idstr
optional
formatuuid
recurring_commitslist
optional
Optional[List[DataRecurringCommit]]
Hide ParametersShow Parameters
idstr
formatuuid
access_amountcredit_type_idstrunit_pricefloatquantityfloatDataRecurringCommitAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters
credit_type_idstr
formatuuid
unit_pricefloat
quantityfloat
optional
commit_durationvaluefloatunitliteralDataRecurringCommitCommitDuration

The amount of time the created commits will be valid for

Hide ParametersShow Parameters
valuefloat
unitliteral
optional
Optional[Literal["PERIODS"]]
Hide ParametersShow Parameters
"PERIODS"
priorityfloat

Will be passed down to the individual commits

productidstrnamestrDataRecurringCommitProduct
Hide ParametersShow Parameters
idstr
formatuuid
namestr
rate_typeliteral
Literal["COMMIT_RATE", "LIST_RATE"]

Whether the created commits will use the commit rate or list rate

Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
starting_atdatetime

Determines the start time for the first commit

formatdate-time
applicable_product_idslist
optional
Optional[List[str]]

Will be passed down to the individual commits

applicable_product_tagslist
optional
Optional[List[str]]

Will be passed down to the individual commits

contractidstrDataRecurringCommitContract
optional
Hide ParametersShow Parameters
idstr
formatuuid
descriptionstr
optional

Will be passed down to the individual commits

ending_beforedatetime
optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time
hierarchy_configurationchild_accessDataRecurringCommitHierarchyConfigurationChildAccessDataRecurringCommitHierarchyConfiguration
optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters
child_accessDataRecurringCommitHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
DataRecurringCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
DataRecurringCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
DataRecurringCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
invoice_amountcredit_type_idstrquantityfloatunit_pricefloatDataRecurringCommitInvoiceAmount
optional

The amount the customer should be billed for the commit. Not required.

Hide ParametersShow Parameters
credit_type_idstr
formatuuid
quantityfloat
unit_pricefloat
namestr
optional

Displayed on invoices. Will be passed through to the individual commits

netsuite_sales_order_idstr
optional

Will be passed down to the individual commits

prorationliteral
optional
Optional[Literal["NONE", "FIRST", "LAST", "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).

Hide ParametersShow Parameters
"NONE"
"FIRST"
"LAST"
"FIRST_AND_LAST"
recurrence_frequencyliteral
optional
Optional[Literal["MONTHLY", "QUARTERLY", "ANNUAL", "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.

Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
rollover_fractionfloat
optional

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.

specifierslist
optional
Optional[List[DataRecurringCommitSpecifier]]

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.

Hide ParametersShow Parameters
presentation_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
pricing_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
product_idstr
optional

If provided, the specifier will only apply to the product with the specified ID.

formatuuid
product_tagslist
optional
Optional[List[str]]

If provided, the specifier will only apply to products with all the specified tags.

subscription_configallocationliteralapply_seat_increase_configDataRecurringCommitSubscriptionConfigApplySeatIncreaseConfigsubscription_idstrDataRecurringCommitSubscriptionConfig
optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters
allocationliteral
Literal["INDIVIDUAL", "POOLED"]
Hide ParametersShow Parameters
"INDIVIDUAL"
"POOLED"
apply_seat_increase_configis_proratedboolDataRecurringCommitSubscriptionConfigApplySeatIncreaseConfig
Hide ParametersShow Parameters
is_proratedbool

Indicates whether a mid-period seat increase should be prorated.

subscription_idstr
formatuuid
recurring_creditslist
optional
Optional[List[DataRecurringCredit]]
Hide ParametersShow Parameters
idstr
formatuuid
access_amountcredit_type_idstrunit_pricefloatquantityfloatDataRecurringCreditAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters
credit_type_idstr
formatuuid
unit_pricefloat
quantityfloat
optional
commit_durationvaluefloatunitliteralDataRecurringCreditCommitDuration

The amount of time the created commits will be valid for

Hide ParametersShow Parameters
valuefloat
unitliteral
optional
Optional[Literal["PERIODS"]]
Hide ParametersShow Parameters
"PERIODS"
priorityfloat

Will be passed down to the individual commits

productidstrnamestrDataRecurringCreditProduct
Hide ParametersShow Parameters
idstr
formatuuid
namestr
rate_typeliteral
Literal["COMMIT_RATE", "LIST_RATE"]

Whether the created commits will use the commit rate or list rate

Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
starting_atdatetime

Determines the start time for the first commit

formatdate-time
applicable_product_idslist
optional
Optional[List[str]]

Will be passed down to the individual commits

applicable_product_tagslist
optional
Optional[List[str]]

Will be passed down to the individual commits

contractidstrDataRecurringCreditContract
optional
Hide ParametersShow Parameters
idstr
formatuuid
descriptionstr
optional

Will be passed down to the individual commits

ending_beforedatetime
optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time
hierarchy_configurationchild_accessDataRecurringCreditHierarchyConfigurationChildAccessDataRecurringCreditHierarchyConfiguration
optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters
child_accessDataRecurringCreditHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
DataRecurringCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
DataRecurringCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
DataRecurringCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
namestr
optional

Displayed on invoices. Will be passed through to the individual commits

netsuite_sales_order_idstr
optional

Will be passed down to the individual commits

prorationliteral
optional
Optional[Literal["NONE", "FIRST", "LAST", "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).

Hide ParametersShow Parameters
"NONE"
"FIRST"
"LAST"
"FIRST_AND_LAST"
recurrence_frequencyliteral
optional
Optional[Literal["MONTHLY", "QUARTERLY", "ANNUAL", "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.

Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
rollover_fractionfloat
optional

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.

specifierslist
optional
Optional[List[DataRecurringCreditSpecifier]]

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.

Hide ParametersShow Parameters
presentation_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
pricing_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]
product_idstr
optional

If provided, the specifier will only apply to the product with the specified ID.

formatuuid
product_tagslist
optional
Optional[List[str]]

If provided, the specifier will only apply to products with all the specified tags.

subscription_configallocationliteralapply_seat_increase_configDataRecurringCreditSubscriptionConfigApplySeatIncreaseConfigsubscription_idstrDataRecurringCreditSubscriptionConfig
optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters
allocationliteral
Literal["INDIVIDUAL", "POOLED"]
Hide ParametersShow Parameters
"INDIVIDUAL"
"POOLED"
apply_seat_increase_configis_proratedboolDataRecurringCreditSubscriptionConfigApplySeatIncreaseConfig
Hide ParametersShow Parameters
is_proratedbool

Indicates whether a mid-period seat increase should be prorated.

subscription_idstr
formatuuid
reseller_royaltieslist
optional
Optional[List[DataResellerRoyalty]]

This field's availability is dependent on your client's configuration.

Hide ParametersShow Parameters
reseller_typeliteral
Literal["AWS", "AWS_PRO_SERVICE", "GCP", "GCP_PRO_SERVICE"]
Hide ParametersShow Parameters
"AWS"
"AWS_PRO_SERVICE"
"GCP"
"GCP_PRO_SERVICE"
segmentslist
List[DataResellerRoyaltySegment]
Hide ParametersShow Parameters
fractionfloat
netsuite_reseller_idstr
reseller_typeliteral
Literal["AWS", "AWS_PRO_SERVICE", "GCP", "GCP_PRO_SERVICE"]
Hide ParametersShow Parameters
"AWS"
"AWS_PRO_SERVICE"
"GCP"
"GCP_PRO_SERVICE"
starting_atdatetime
formatdate-time
applicable_product_idslist
optional
Optional[List[str]]
applicable_product_tagslist
optional
Optional[List[str]]
aws_account_numberstr
optional
aws_offer_idstr
optional
aws_payer_reference_idstr
optional
ending_beforedatetime
optional
formatdate-time
gcp_account_idstr
optional
gcp_offer_idstr
optional
reseller_contract_valuefloat
optional
salesforce_opportunity_idstr
optional

This field's availability is dependent on your client's configuration.

scheduled_charges_on_usage_invoicesliteral
optional
Optional[Literal["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.

Hide ParametersShow Parameters
"ALL"
spend_threshold_configurationcommitDataSpendThresholdConfigurationCommitis_enabledboolpayment_gate_configDataSpendThresholdConfigurationPaymentGateConfigthreshold_amountfloatDataSpendThresholdConfiguration
optional
Hide ParametersShow Parameters
commitproduct_idstrdescriptionstrnamestrDataSpendThresholdConfigurationCommit
Hide ParametersShow Parameters
product_idstr

The commit product that will be used to generate the line item for commit payment.

descriptionstr
optional
namestr
optional

Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.

is_enabledbool

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_configpayment_gate_typeliteralprecalculated_tax_configDataSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigstripe_configDataSpendThresholdConfigurationPaymentGateConfigStripeConfigtax_typeliteralDataSpendThresholdConfigurationPaymentGateConfig
Hide ParametersShow Parameters
payment_gate_typeliteral
Literal["NONE", "STRIPE", "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.

Hide ParametersShow Parameters
"NONE"
"STRIPE"
"EXTERNAL"
precalculated_tax_configtax_amountfloattax_namestrDataSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig
optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters
tax_amountfloat

Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule

tax_namestr
optional

Name of the tax to be applied. This may be used in an invoice line item description.

stripe_configpayment_typeliteralinvoice_metadataDict[str, str]DataSpendThresholdConfigurationPaymentGateConfigStripeConfig
optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters
payment_typeliteral
Literal["INVOICE", "PAYMENT_INTENT"]

If left blank, will default to INVOICE

Hide ParametersShow Parameters
"INVOICE"
"PAYMENT_INTENT"
invoice_metadataDict[str, str]
optional
Optional[Dict[str, str]]

Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.

tax_typeliteral
optional
Optional[Literal["NONE", "STRIPE", "ANROK", "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.

Hide ParametersShow Parameters
"NONE"
"STRIPE"
"ANROK"
"PRECALCULATED"
threshold_amountfloat

Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.

subscriptionslist
optional
Optional[List[DataSubscription]]

List of subscriptions on the contract.

Hide ParametersShow Parameters
collection_scheduleliteral
Literal["ADVANCE", "ARREARS"]
Hide ParametersShow Parameters
"ADVANCE"
"ARREARS"
prorationinvoice_behaviorliteralis_proratedboolDataSubscriptionProration
Hide ParametersShow Parameters
invoice_behaviorliteral
Literal["BILL_IMMEDIATELY", "BILL_ON_NEXT_COLLECTION_DATE"]
Hide ParametersShow Parameters
"BILL_IMMEDIATELY"
"BILL_ON_NEXT_COLLECTION_DATE"
is_proratedbool
quantity_schedulelist
List[DataSubscriptionQuantitySchedule]

List of quantity schedule items for the subscription. Only includes the current quantity and future quantity changes.

Hide ParametersShow Parameters
quantityfloat
starting_atdatetime
formatdate-time
ending_beforedatetime
optional
formatdate-time
starting_atdatetime
formatdate-time
subscription_ratebilling_frequencyliteralproductDataSubscriptionSubscriptionRateProductDataSubscriptionSubscriptionRate
Hide ParametersShow Parameters
billing_frequencyliteral
Literal["MONTHLY", "QUARTERLY", "ANNUAL", "WEEKLY"]
Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
productidstrnamestrDataSubscriptionSubscriptionRateProduct
Hide ParametersShow Parameters
idstr
formatuuid
namestr
idstr
optional
formatuuid
custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
descriptionstr
optional
ending_beforedatetime
optional
formatdate-time
fiat_credit_type_idstr
optional
formatuuid
namestr
optional
total_contract_valuefloat
optional
uniqueness_keystr
optional

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.

minLength1
maxLength128
from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
contracts = client.v2.contracts.list(
    customer_id="13117714-3f05-48e5-a6e9-a66093f13b4d",
)
print(contracts.data)
200 Example
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "commits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "type": "PREPAID",
          "access_schedule": {
            "schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "ending_before": "2019-12-27T18:11:19.117Z",
                "starting_at": "2019-12-27T18:11:19.117Z"
              }
            ],
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            }
          },
          "applicable_contract_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "archived_at": "2019-12-27T18:11:19.117Z",
          "balance": 0,
          "contract": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          },
          "custom_fields": {
            "foo": "string"
          },
          "description": "description",
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "invoice_contract": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          },
          "invoice_schedule": {
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "do_not_invoice": true,
            "schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "quantity": 0,
                "timestamp": "2019-12-27T18:11:19.117Z",
                "unit_price": 0,
                "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ]
          },
          "ledger": [
            {
              "amount": 0,
              "segment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "timestamp": "2019-12-27T18:11:19.117Z",
              "type": "PREPAID_COMMIT_SEGMENT_START"
            }
          ],
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "priority": 0,
          "rate_type": "COMMIT_RATE",
          "rolled_over_from": {
            "commit_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          },
          "rollover_fraction": 0,
          "salesforce_opportunity_id": "salesforce_opportunity_id",
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ]
        }
      ],
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "overrides": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "starting_at": "2019-12-27T18:11:19.117Z",
          "applicable_product_tags": [
            "string"
          ],
          "ending_before": "2019-12-27T18:11:19.117Z",
          "entitled": true,
          "is_commit_specific": true,
          "multiplier": 0,
          "override_specifiers": [
            {
              "billing_frequency": "MONTHLY",
              "commit_ids": [
                "string"
              ],
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ],
              "recurring_commit_ids": [
                "string"
              ],
              "recurring_credit_ids": [
                "string"
              ]
            }
          ],
          "override_tiers": [
            {
              "multiplier": 0,
              "size": 0
            }
          ],
          "overwrite_rate": {
            "rate_type": "FLAT",
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "custom_rate": {
              "foo": "bar"
            },
            "is_prorated": true,
            "price": 0,
            "quantity": 0,
            "tiers": [
              {
                "price": 0,
                "size": 0
              }
            ]
          },
          "priority": 0,
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "target": "COMMIT_RATE",
          "type": "OVERWRITE"
        }
      ],
      "scheduled_charges": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "schedule": {
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "do_not_invoice": true,
            "schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "quantity": 0,
                "timestamp": "2019-12-27T18:11:19.117Z",
                "unit_price": 0,
                "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ]
          },
          "archived_at": "2019-12-27T18:11:19.117Z",
          "custom_fields": {
            "foo": "string"
          },
          "name": "x",
          "netsuite_sales_order_id": "netsuite_sales_order_id"
        }
      ],
      "starting_at": "2019-12-27T18:11:19.117Z",
      "transitions": [
        {
          "from_contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "to_contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "type": "SUPERSEDE"
        }
      ],
      "usage_filter": [
        {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z",
          "ending_before": "2019-12-27T18:11:19.117Z"
        }
      ],
      "usage_statement_schedule": {
        "billing_anchor_date": "2019-12-27T18:11:19.117Z",
        "frequency": "MONTHLY"
      },
      "archived_at": "2019-12-27T18:11:19.117Z",
      "credits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "type": "CREDIT",
          "access_schedule": {
            "schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "ending_before": "2019-12-27T18:11:19.117Z",
                "starting_at": "2019-12-27T18:11:19.117Z"
              }
            ],
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            }
          },
          "applicable_contract_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "balance": 0,
          "contract": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          },
          "custom_fields": {
            "foo": "string"
          },
          "description": "description",
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "ledger": [
            {
              "amount": 0,
              "segment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "timestamp": "2019-12-27T18:11:19.117Z",
              "type": "CREDIT_SEGMENT_START"
            }
          ],
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "priority": 0,
          "salesforce_opportunity_id": "salesforce_opportunity_id",
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ]
        }
      ],
      "custom_fields": {
        "foo": "string"
      },
      "customer_billing_provider_configuration": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "billing_provider": "aws_marketplace",
        "delivery_method": "direct_to_billing_provider"
      },
      "discounts": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "schedule": {
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "do_not_invoice": true,
            "schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "quantity": 0,
                "timestamp": "2019-12-27T18:11:19.117Z",
                "unit_price": 0,
                "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ]
          },
          "custom_fields": {
            "foo": "string"
          },
          "name": "x",
          "netsuite_sales_order_id": "netsuite_sales_order_id"
        }
      ],
      "ending_before": "2019-12-27T18:11:19.117Z",
      "has_more": {
        "commits": true,
        "credits": true
      },
      "hierarchy_configuration": {
        "children": [
          {
            "contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          }
        ]
      },
      "multiplier_override_prioritization": "LOWEST_MULTIPLIER",
      "name": "name",
      "net_payment_terms_days": 0,
      "netsuite_sales_order_id": "netsuite_sales_order_id",
      "prepaid_balance_threshold_configuration": {
        "commit": {
          "product_id": "product_id",
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "description": "description",
          "name": "name",
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ]
        },
        "is_enabled": true,
        "payment_gate_config": {
          "payment_gate_type": "NONE",
          "precalculated_tax_config": {
            "tax_amount": 0,
            "tax_name": "tax_name"
          },
          "stripe_config": {
            "payment_type": "INVOICE",
            "invoice_metadata": {
              "foo": "string"
            }
          },
          "tax_type": "NONE"
        },
        "recharge_to_amount": 0,
        "threshold_amount": 0,
        "custom_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
      },
      "priority": 0,
      "professional_services": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "max_amount": 0,
          "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "quantity": 0,
          "unit_price": 0,
          "custom_fields": {
            "foo": "string"
          },
          "description": "description",
          "netsuite_sales_order_id": "netsuite_sales_order_id"
        }
      ],
      "rate_card_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "recurring_commits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_amount": {
            "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "unit_price": 0,
            "quantity": 0
          },
          "commit_duration": {
            "value": 0,
            "unit": "PERIODS"
          },
          "priority": 0,
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "rate_type": "COMMIT_RATE",
          "starting_at": "2019-12-27T18:11:19.117Z",
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "contract": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          },
          "description": "description",
          "ending_before": "2019-12-27T18:11:19.117Z",
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "invoice_amount": {
            "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "quantity": 0,
            "unit_price": 0
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "proration": "NONE",
          "recurrence_frequency": "MONTHLY",
          "rollover_fraction": 0,
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ],
          "subscription_config": {
            "allocation": "INDIVIDUAL",
            "apply_seat_increase_config": {
              "is_prorated": true
            },
            "subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          }
        }
      ],
      "recurring_credits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_amount": {
            "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "unit_price": 0,
            "quantity": 0
          },
          "commit_duration": {
            "value": 0,
            "unit": "PERIODS"
          },
          "priority": 0,
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "rate_type": "COMMIT_RATE",
          "starting_at": "2019-12-27T18:11:19.117Z",
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "contract": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          },
          "description": "description",
          "ending_before": "2019-12-27T18:11:19.117Z",
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "proration": "NONE",
          "recurrence_frequency": "MONTHLY",
          "rollover_fraction": 0,
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ],
          "subscription_config": {
            "allocation": "INDIVIDUAL",
            "apply_seat_increase_config": {
              "is_prorated": true
            },
            "subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          }
        }
      ],
      "reseller_royalties": [
        {
          "reseller_type": "AWS",
          "segments": [
            {
              "fraction": 0,
              "netsuite_reseller_id": "netsuite_reseller_id",
              "reseller_type": "AWS",
              "starting_at": "2019-12-27T18:11:19.117Z",
              "applicable_product_ids": [
                "string"
              ],
              "applicable_product_tags": [
                "string"
              ],
              "aws_account_number": "aws_account_number",
              "aws_offer_id": "aws_offer_id",
              "aws_payer_reference_id": "aws_payer_reference_id",
              "ending_before": "2019-12-27T18:11:19.117Z",
              "gcp_account_id": "gcp_account_id",
              "gcp_offer_id": "gcp_offer_id",
              "reseller_contract_value": 0
            }
          ]
        }
      ],
      "salesforce_opportunity_id": "salesforce_opportunity_id",
      "scheduled_charges_on_usage_invoices": "ALL",
      "spend_threshold_configuration": {
        "commit": {
          "product_id": "product_id",
          "description": "description",
          "name": "name"
        },
        "is_enabled": true,
        "payment_gate_config": {
          "payment_gate_type": "NONE",
          "precalculated_tax_config": {
            "tax_amount": 0,
            "tax_name": "tax_name"
          },
          "stripe_config": {
            "payment_type": "INVOICE",
            "invoice_metadata": {
              "foo": "string"
            }
          },
          "tax_type": "NONE"
        },
        "threshold_amount": 0
      },
      "subscriptions": [
        {
          "collection_schedule": "ADVANCE",
          "proration": {
            "invoice_behavior": "BILL_IMMEDIATELY",
            "is_prorated": true
          },
          "quantity_schedule": [
            {
              "quantity": 0,
              "starting_at": "2019-12-27T18:11:19.117Z",
              "ending_before": "2019-12-27T18:11:19.117Z"
            }
          ],
          "starting_at": "2019-12-27T18:11:19.117Z",
          "subscription_rate": {
            "billing_frequency": "MONTHLY",
            "product": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            }
          },
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "custom_fields": {
            "foo": "string"
          },
          "description": "description",
          "ending_before": "2019-12-27T18:11:19.117Z",
          "fiat_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        }
      ],
      "total_contract_value": 0,
      "uniqueness_key": "x"
    }
  ]
}