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

Retrieve

API Reference
V2
Contracts
Get a contract (v2)
client.v2.contracts.retrieve(ContractRetrieveParamsbody, RequestOptionsoptions?): dataDataContractRetrieveResponse
post/v2/contracts/get

Get a specific contract. New clients should use this endpoint rather than the v1 endpoint.

Parameters
bodycontract_idstringcustomer_idstringas_of_datestringinclude_balancebooleaninclude_ledgersbooleanContractRetrieveParams
Hide ParametersShow Parameters
contract_idstring
formatuuid
customer_idstring
formatuuid
as_of_datestring
optional

Optional RFC 3339 timestamp. Return the contract as of this date. Cannot be used with include_ledgers parameter.

formatdate-time
include_balanceboolean
optional

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

include_ledgersboolean
optional

Include commit/credit ledgers in the response. Setting this flag may cause the query to be slower. Cannot be used with as_of_date parameter.

Returns
ContractRetrieveResponse
Hide ParametersShow Parameters
dataidstringcommitsarraycreated_atstringcreated_bystringcustomer_idstringoverridesarrayscheduled_chargesarraystarting_atstringtransitionsarrayusage_filterarrayusage_statement_scheduleUsageStatementSchedulearchived_atstringcreditsarraycustom_fieldsRecord<string, string>customer_billing_provider_configurationCustomerBillingProviderConfigurationdiscountsarrayending_beforestringhas_moreHasMorehierarchy_configurationunionmultiplier_override_prioritizationunionnamestringnet_payment_terms_daysnumbernetsuite_sales_order_idstringprepaid_balance_threshold_configurationPrepaidBalanceThresholdConfigurationprioritynumberprofessional_servicesarrayrate_card_idstringrecurring_commitsarrayrecurring_creditsarrayreseller_royaltiesarraysalesforce_opportunity_idstringscheduled_charges_on_usage_invoices"ALL"spend_threshold_configurationSpendThresholdConfigurationsubscriptionsarraytotal_contract_valuenumberuniqueness_keystringData
Hide ParametersShow Parameters
idstring
formatuuid
commitsarray
Array<Commit>
Hide ParametersShow Parameters
idstring
formatuuid
productidstringnamestringProduct
Hide ParametersShow Parameters
idstring
formatuuid
namestring
typeunion
"PREPAID" | "POSTPAID"
Hide ParametersShow Parameters
"PREPAID"
"POSTPAID"
access_scheduleschedule_itemsarraycredit_typeCreditTypeDataScheduleDuration
optional

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

applicable_contract_idsarray
optional
Array<string>
applicable_product_idsarray
optional
Array<string>
applicable_product_tagsarray
optional
Array<string>
archived_atstring
optional
formatdate-time
balancenumber
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.

contractidstringContract
optional
Hide ParametersShow Parameters
idstring
formatuuid
custom_fieldsRecord<string, string>
optional
descriptionstring
optional
hierarchy_configurationchild_accessunionHierarchyConfiguration
optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters
child_accessunion
type"ALL"CommitHierarchyChildAccessAll | type"NONE"CommitHierarchyChildAccessNone | contract_idsarraytype"CONTRACT_IDS"CommitHierarchyChildAccessContractIDs
Hide ParametersShow Parameters
CommitHierarchyChildAccessAll
Hide ParametersShow Parameters
type"ALL"
Hide ParametersShow Parameters
"ALL"
CommitHierarchyChildAccessNone
Hide ParametersShow Parameters
type"NONE"
Hide ParametersShow Parameters
"NONE"
CommitHierarchyChildAccessContractIDs
Hide ParametersShow Parameters
contract_idsarray
Array<string>
type"CONTRACT_IDS"
Hide ParametersShow Parameters
"CONTRACT_IDS"
invoice_contractidstringInvoiceContract
optional

The contract that this commit will be billed on.

Hide ParametersShow Parameters
idstring
formatuuid
invoice_schedulecredit_typeCreditTypeDatado_not_invoicebooleanschedule_itemsarraySchedulePointInTime
optional

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

ledgerarray
optional
Array<amountnumbersegment_idstringtimestampstringtype"PREPAID_COMMIT_SEGMENT_START"PrepaidCommitSegmentStartLedgerEntry | amountnumberinvoice_idstringsegment_idstringtimestampstringtype"PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"contract_idstringPrepaidCommitAutomatedInvoiceDeductionLedgerEntry | amountnumbernew_contract_idstringsegment_idstringtimestampstringtype"PREPAID_COMMIT_ROLLOVER"PrepaidCommitRolloverLedgerEntry | 11 more>

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

Hide ParametersShow Parameters
PrepaidCommitSegmentStartLedgerEntry
Hide ParametersShow Parameters
amountnumber
segment_idstring
formatuuid
timestampstring
formatdate-time
type"PREPAID_COMMIT_SEGMENT_START"
Hide ParametersShow Parameters
"PREPAID_COMMIT_SEGMENT_START"
PrepaidCommitAutomatedInvoiceDeductionLedgerEntry
Hide ParametersShow Parameters
amountnumber
invoice_idstring
formatuuid
segment_idstring
formatuuid
timestampstring
formatdate-time
type"PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"
Hide ParametersShow Parameters
"PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"
contract_idstring
optional
formatuuid
PrepaidCommitRolloverLedgerEntry
Hide ParametersShow Parameters
amountnumber
new_contract_idstring
formatuuid
segment_idstring
formatuuid
timestampstring
formatdate-time
type"PREPAID_COMMIT_ROLLOVER"
Hide ParametersShow Parameters
"PREPAID_COMMIT_ROLLOVER"
PrepaidCommitExpirationLedgerEntry
Hide ParametersShow Parameters
amountnumber
segment_idstring
formatuuid
timestampstring
formatdate-time
type"PREPAID_COMMIT_EXPIRATION"
Hide ParametersShow Parameters
"PREPAID_COMMIT_EXPIRATION"
PrepaidCommitCanceledLedgerEntry
Hide ParametersShow Parameters
amountnumber
invoice_idstring
formatuuid
segment_idstring
formatuuid
timestampstring
formatdate-time
type"PREPAID_COMMIT_CANCELED"
Hide ParametersShow Parameters
"PREPAID_COMMIT_CANCELED"
contract_idstring
optional
formatuuid
PrepaidCommitCreditedLedgerEntry
Hide ParametersShow Parameters
amountnumber
invoice_idstring
formatuuid
segment_idstring
formatuuid
timestampstring
formatdate-time
type"PREPAID_COMMIT_CREDITED"
Hide ParametersShow Parameters
"PREPAID_COMMIT_CREDITED"
contract_idstring
optional
formatuuid
PrepaidCommitSeatBasedAdjustmentLedgerEntry
Hide ParametersShow Parameters
amountnumber
segment_idstring
formatuuid
timestampstring
formatdate-time
type"PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT"
Hide ParametersShow Parameters
"PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT"
PostpaidCommitInitialBalanceLedgerEntry
Hide ParametersShow Parameters
amountnumber
timestampstring
formatdate-time
type"POSTPAID_COMMIT_INITIAL_BALANCE"
Hide ParametersShow Parameters
"POSTPAID_COMMIT_INITIAL_BALANCE"
PostpaidCommitAutomatedInvoiceDeductionLedgerEntry
Hide ParametersShow Parameters
amountnumber
invoice_idstring
formatuuid
segment_idstring
formatuuid
timestampstring
formatdate-time
type"POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"
Hide ParametersShow Parameters
"POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"
contract_idstring
optional
formatuuid
PostpaidCommitRolloverLedgerEntry
Hide ParametersShow Parameters
amountnumber
new_contract_idstring
formatuuid
segment_idstring
formatuuid
timestampstring
formatdate-time
type"POSTPAID_COMMIT_ROLLOVER"
Hide ParametersShow Parameters
"POSTPAID_COMMIT_ROLLOVER"
PostpaidCommitTrueupLedgerEntry
Hide ParametersShow Parameters
amountnumber
invoice_idstring
formatuuid
timestampstring
formatdate-time
type"POSTPAID_COMMIT_TRUEUP"
Hide ParametersShow Parameters
"POSTPAID_COMMIT_TRUEUP"
contract_idstring
optional
formatuuid
PrepaidCommitManualLedgerEntry
Hide ParametersShow Parameters
amountnumber
reasonstring
timestampstring
formatdate-time
type"PREPAID_COMMIT_MANUAL"
Hide ParametersShow Parameters
"PREPAID_COMMIT_MANUAL"
PostpaidCommitManualLedgerEntry
Hide ParametersShow Parameters
amountnumber
reasonstring
timestampstring
formatdate-time
type"POSTPAID_COMMIT_MANUAL"
Hide ParametersShow Parameters
"POSTPAID_COMMIT_MANUAL"
PostpaidCommitExpirationLedgerEntry
Hide ParametersShow Parameters
amountnumber
timestampstring
formatdate-time
type"POSTPAID_COMMIT_EXPIRATION"
Hide ParametersShow Parameters
"POSTPAID_COMMIT_EXPIRATION"
namestring
optional
netsuite_sales_order_idstring
optional

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

prioritynumber
optional

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

rate_typeunion
optional
"COMMIT_RATE" | "LIST_RATE"
Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
rolled_over_fromcommit_idstringcontract_idstringRolledOverFrom
optional
Hide ParametersShow Parameters
commit_idstring
formatuuid
contract_idstring
formatuuid
rollover_fractionnumber
optional
salesforce_opportunity_idstring
optional

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

specifiersarray
optional
Array<Specifier>

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_valuesRecord<string, string>
optional
pricing_group_valuesRecord<string, string>
optional
product_idstring
optional

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

formatuuid
product_tagsarray
optional
Array<string>

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

created_atstring
formatdate-time
created_bystring
customer_idstring
formatuuid
overridesarray
Array<Override>
Hide ParametersShow Parameters
idstring
formatuuid
starting_atstring
formatdate-time
applicable_product_tagsarray
optional
Array<string>
ending_beforestring
optional
formatdate-time
entitledboolean
optional
is_commit_specificboolean
optional
multipliernumber
optional
override_specifiersarray
optional
Array<OverrideSpecifier>
Hide ParametersShow Parameters
billing_frequencyunion
optional
"MONTHLY" | "QUARTERLY" | "ANNUAL" | "WEEKLY"
Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
commit_idsarray
optional
Array<string>
presentation_group_valuesRecord<string, string | null>
optional
pricing_group_valuesRecord<string, string>
optional
product_idstring
optional
formatuuid
product_tagsarray
optional
Array<string>
recurring_commit_idsarray
optional
Array<string>
recurring_credit_idsarray
optional
Array<string>
override_tiersarray
optional
Array<OverrideTier>
Hide ParametersShow Parameters
multipliernumber
sizenumber
optional
overwrite_raterate_typeunioncredit_typeCreditTypeDatacustom_rateRecord<string, unknown>is_proratedbooleanpricenumberquantitynumbertiersarrayOverwriteRate
optional
Hide ParametersShow Parameters
rate_typeunion
"FLAT" | "PERCENTAGE" | "SUBSCRIPTION" | 2 more
Hide ParametersShow Parameters
"FLAT"
"PERCENTAGE"
"SUBSCRIPTION"
"TIERED"
"CUSTOM"
credit_typeidstringnamestringCreditTypeData
optional
custom_rateRecord<string, unknown>
optional

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

is_proratedboolean
optional

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

pricenumber
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.

quantitynumber
optional

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

tiersarray
optional
Array<pricenumbersizenumberTier>

Only set for TIERED rate_type.

Hide ParametersShow Parameters
pricenumber
sizenumber
optional
prioritynumber
optional
productidstringnamestringProduct
optional
Hide ParametersShow Parameters
idstring
formatuuid
namestring
targetunion
optional
"COMMIT_RATE" | "LIST_RATE"
Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
typeunion
optional
"OVERWRITE" | "MULTIPLIER" | "TIERED"
Hide ParametersShow Parameters
"OVERWRITE"
"MULTIPLIER"
"TIERED"
scheduled_chargesarray
Array<idstringproductProductscheduleSchedulePointInTimearchived_atstringcustom_fieldsRecord<string, string>namestringnetsuite_sales_order_idstringScheduledCharge>
Hide ParametersShow Parameters
idstring
formatuuid
productidstringnamestringProduct
Hide ParametersShow Parameters
idstring
formatuuid
namestring
schedulecredit_typeCreditTypeDatado_not_invoicebooleanschedule_itemsarraySchedulePointInTime
archived_atstring
optional
formatdate-time
custom_fieldsRecord<string, string>
optional
namestring
optional

displayed on invoices

minLength1
netsuite_sales_order_idstring
optional

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

starting_atstring
formatdate-time
transitionsarray
Array<Transition>
Hide ParametersShow Parameters
from_contract_idstring
formatuuid
to_contract_idstring
formatuuid
typeunion
"SUPERSEDE" | "RENEWAL"
Hide ParametersShow Parameters
"SUPERSEDE"
"RENEWAL"
usage_filterarray
Array<UsageFilter>
Hide ParametersShow Parameters
group_keystring
group_valuesarray
Array<string>
starting_atstring

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

formatdate-time
ending_beforestring
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_datestringfrequencyunionUsageStatementSchedule
Hide ParametersShow Parameters
billing_anchor_datestring

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

formatdate-time
frequencyunion
"MONTHLY" | "QUARTERLY" | "ANNUAL" | "WEEKLY"
Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
archived_atstring
optional
formatdate-time
creditsarray
optional
Array<Credit>
Hide ParametersShow Parameters
idstring
formatuuid
productidstringnamestringProduct
Hide ParametersShow Parameters
idstring
formatuuid
namestring
type"CREDIT"
Hide ParametersShow Parameters
"CREDIT"
access_scheduleschedule_itemsarraycredit_typeCreditTypeDataScheduleDuration
optional

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

applicable_contract_idsarray
optional
Array<string>
applicable_product_idsarray
optional
Array<string>
applicable_product_tagsarray
optional
Array<string>
balancenumber
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.

contractidstringContract
optional
Hide ParametersShow Parameters
idstring
formatuuid
custom_fieldsRecord<string, string>
optional
descriptionstring
optional
hierarchy_configurationchild_accessunionHierarchyConfiguration
optional

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters
child_accessunion
type"ALL"CommitHierarchyChildAccessAll | type"NONE"CommitHierarchyChildAccessNone | contract_idsarraytype"CONTRACT_IDS"CommitHierarchyChildAccessContractIDs
Hide ParametersShow Parameters
CommitHierarchyChildAccessAll
Hide ParametersShow Parameters
type"ALL"
Hide ParametersShow Parameters
"ALL"
CommitHierarchyChildAccessNone
Hide ParametersShow Parameters
type"NONE"
Hide ParametersShow Parameters
"NONE"
CommitHierarchyChildAccessContractIDs
Hide ParametersShow Parameters
contract_idsarray
Array<string>
type"CONTRACT_IDS"
Hide ParametersShow Parameters
"CONTRACT_IDS"
ledgerarray
optional
Array<amountnumbersegment_idstringtimestampstringtype"CREDIT_SEGMENT_START"CreditSegmentStartLedgerEntry | amountnumberinvoice_idstringsegment_idstringtimestampstringtype"CREDIT_AUTOMATED_INVOICE_DEDUCTION"contract_idstringCreditAutomatedInvoiceDeductionLedgerEntry | amountnumbersegment_idstringtimestampstringtype"CREDIT_EXPIRATION"CreditExpirationLedgerEntry | 4 more>

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

Hide ParametersShow Parameters
CreditSegmentStartLedgerEntry
Hide ParametersShow Parameters
amountnumber
segment_idstring
formatuuid
timestampstring
formatdate-time
type"CREDIT_SEGMENT_START"
Hide ParametersShow Parameters
"CREDIT_SEGMENT_START"
CreditAutomatedInvoiceDeductionLedgerEntry
Hide ParametersShow Parameters
amountnumber
invoice_idstring
formatuuid
segment_idstring
formatuuid
timestampstring
formatdate-time
type"CREDIT_AUTOMATED_INVOICE_DEDUCTION"
Hide ParametersShow Parameters
"CREDIT_AUTOMATED_INVOICE_DEDUCTION"
contract_idstring
optional
formatuuid
CreditExpirationLedgerEntry
Hide ParametersShow Parameters
amountnumber
segment_idstring
formatuuid
timestampstring
formatdate-time
type"CREDIT_EXPIRATION"
Hide ParametersShow Parameters
"CREDIT_EXPIRATION"
CreditCanceledLedgerEntry
Hide ParametersShow Parameters
amountnumber
invoice_idstring
formatuuid
segment_idstring
formatuuid
timestampstring
formatdate-time
type"CREDIT_CANCELED"
Hide ParametersShow Parameters
"CREDIT_CANCELED"
contract_idstring
optional
formatuuid
CreditCreditedLedgerEntry
Hide ParametersShow Parameters
amountnumber
invoice_idstring
formatuuid
segment_idstring
formatuuid
timestampstring
formatdate-time
type"CREDIT_CREDITED"
Hide ParametersShow Parameters
"CREDIT_CREDITED"
contract_idstring
optional
formatuuid
CreditManualLedgerEntry
Hide ParametersShow Parameters
amountnumber
reasonstring
timestampstring
formatdate-time
type"CREDIT_MANUAL"
Hide ParametersShow Parameters
"CREDIT_MANUAL"
CreditSeatBasedAdjustmentLedgerEntry
Hide ParametersShow Parameters
amountnumber
segment_idstring
formatuuid
timestampstring
formatdate-time
type"CREDIT_SEAT_BASED_ADJUSTMENT"
Hide ParametersShow Parameters
"CREDIT_SEAT_BASED_ADJUSTMENT"
namestring
optional
netsuite_sales_order_idstring
optional

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

prioritynumber
optional

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

salesforce_opportunity_idstring
optional

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

specifiersarray
optional
Array<Specifier>

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_valuesRecord<string, string>
optional
pricing_group_valuesRecord<string, string>
optional
product_idstring
optional

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

formatuuid
product_tagsarray
optional
Array<string>

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

custom_fieldsRecord<string, string>
optional
customer_billing_provider_configurationidstringbilling_provideruniondelivery_methodunionCustomerBillingProviderConfiguration
optional

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

Hide ParametersShow Parameters
idstring

ID of Customer's billing provider configuration.

formatuuid
billing_providerunion
"aws_marketplace" | "stripe" | "netsuite" | 5 more
Hide ParametersShow Parameters
"aws_marketplace"
"stripe"
"netsuite"
"custom"
"azure_marketplace"
"quickbooks_online"
"workday"
"gcp_marketplace"
delivery_methodunion
"direct_to_billing_provider" | "aws_sqs" | "tackle" | "aws_sns"
Hide ParametersShow Parameters
"direct_to_billing_provider"
"aws_sqs"
"tackle"
"aws_sns"
discountsarray
optional
Array<idstringproductProductscheduleSchedulePointInTimecustom_fieldsRecord<string, string>namestringnetsuite_sales_order_idstringDiscount>

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

Hide ParametersShow Parameters
idstring
formatuuid
productidstringnamestringProduct
Hide ParametersShow Parameters
idstring
formatuuid
namestring
schedulecredit_typeCreditTypeDatado_not_invoicebooleanschedule_itemsarraySchedulePointInTime
custom_fieldsRecord<string, string>
optional
namestring
optional
minLength1
netsuite_sales_order_idstring
optional

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

ending_beforestring
optional
formatdate-time
has_morecommitsbooleancreditsbooleanHasMore
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
commitsboolean

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.

creditsboolean

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_configurationunion
optional
childrenarrayParentHierarchyConfiguration | parentParentChildHierarchyConfiguration

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

Hide ParametersShow Parameters
ParentHierarchyConfiguration
Hide ParametersShow Parameters
childrenarray
Array<Child>

List of contracts that belong to this parent.

Hide ParametersShow Parameters
contract_idstring
formatuuid
customer_idstring
formatuuid
ChildHierarchyConfiguration
Hide ParametersShow Parameters
parentcontract_idstringcustomer_idstringParent

The single parent contract/customer for this child.

Hide ParametersShow Parameters
contract_idstring
formatuuid
customer_idstring
formatuuid
multiplier_override_prioritizationunion
optional
"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"
namestring
optional
net_payment_terms_daysnumber
optional
netsuite_sales_order_idstring
optional

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

prepaid_balance_threshold_configurationcommitCommitis_enabledbooleanpayment_gate_configPaymentGateConfigrecharge_to_amountnumberthreshold_amountnumbercustom_credit_type_idstringPrepaidBalanceThresholdConfiguration
optional
Hide ParametersShow Parameters
commitproduct_idstringapplicable_product_idsarrayapplicable_product_tagsarraydescriptionstringnamestringspecifiersarrayCommit
Hide ParametersShow Parameters
product_idstring

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

applicable_product_idsarray
optional
Array<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_tagsarray
optional
Array<string>

Which tags the threshold commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.

descriptionstring
optional
namestring
optional

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

specifiersarray
optional
Array<Specifier>

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_valuesRecord<string, string>
optional
pricing_group_valuesRecord<string, string>
optional
product_idstring
optional

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

formatuuid
product_tagsarray
optional
Array<string>

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

is_enabledboolean

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_typeunionprecalculated_tax_configPrecalculatedTaxConfigstripe_configStripeConfigtax_typeunionPaymentGateConfig
Hide ParametersShow Parameters
payment_gate_typeunion
"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_amountnumbertax_namestringPrecalculatedTaxConfig
optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters
tax_amountnumber

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

tax_namestring
optional

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

stripe_configpayment_typeunioninvoice_metadataRecord<string, string>StripeConfig
optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters
payment_typeunion
"INVOICE" | "PAYMENT_INTENT"

If left blank, will default to INVOICE

Hide ParametersShow Parameters
"INVOICE"
"PAYMENT_INTENT"
invoice_metadataRecord<string, string>
optional

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

tax_typeunion
optional
"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_amountnumber

Specify the amount the balance should be recharged to.

threshold_amountnumber

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_idstring
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
prioritynumber
optional

Priority of the contract.

professional_servicesarray
optional
Array<idstringmax_amountnumberproduct_idstringquantitynumberunit_pricenumbercustom_fieldsRecord<string, string>descriptionstringnetsuite_sales_order_idstringProService>

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

Hide ParametersShow Parameters
idstring
formatuuid
max_amountnumber

Maximum amount for the term.

product_idstring
formatuuid
quantitynumber

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

unit_pricenumber

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

custom_fieldsRecord<string, string>
optional
descriptionstring
optional
netsuite_sales_order_idstring
optional

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

rate_card_idstring
optional
formatuuid
recurring_commitsarray
optional
Array<RecurringCommit>
Hide ParametersShow Parameters
idstring
formatuuid
access_amountcredit_type_idstringunit_pricenumberquantitynumberAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters
credit_type_idstring
formatuuid
unit_pricenumber
quantitynumber
optional
commit_durationvaluenumberunit"PERIODS"CommitDuration

The amount of time the created commits will be valid for

Hide ParametersShow Parameters
valuenumber
unit"PERIODS"
optional
Hide ParametersShow Parameters
"PERIODS"
prioritynumber

Will be passed down to the individual commits

productidstringnamestringProduct
Hide ParametersShow Parameters
idstring
formatuuid
namestring
rate_typeunion
"COMMIT_RATE" | "LIST_RATE"

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

Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
starting_atstring

Determines the start time for the first commit

formatdate-time
applicable_product_idsarray
optional
Array<string>

Will be passed down to the individual commits

applicable_product_tagsarray
optional
Array<string>

Will be passed down to the individual commits

contractidstringContract
optional
Hide ParametersShow Parameters
idstring
formatuuid
descriptionstring
optional

Will be passed down to the individual commits

ending_beforestring
optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time
hierarchy_configurationchild_accessunionHierarchyConfiguration
optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters
child_accessunion
type"ALL"CommitHierarchyChildAccessAll | type"NONE"CommitHierarchyChildAccessNone | contract_idsarraytype"CONTRACT_IDS"CommitHierarchyChildAccessContractIDs
Hide ParametersShow Parameters
CommitHierarchyChildAccessAll
Hide ParametersShow Parameters
type"ALL"
Hide ParametersShow Parameters
"ALL"
CommitHierarchyChildAccessNone
Hide ParametersShow Parameters
type"NONE"
Hide ParametersShow Parameters
"NONE"
CommitHierarchyChildAccessContractIDs
Hide ParametersShow Parameters
contract_idsarray
Array<string>
type"CONTRACT_IDS"
Hide ParametersShow Parameters
"CONTRACT_IDS"
invoice_amountcredit_type_idstringquantitynumberunit_pricenumberInvoiceAmount
optional

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

Hide ParametersShow Parameters
credit_type_idstring
formatuuid
quantitynumber
unit_pricenumber
namestring
optional

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

netsuite_sales_order_idstring
optional

Will be passed down to the individual commits

prorationunion
optional
"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_frequencyunion
optional
"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_fractionnumber
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.

specifiersarray
optional
Array<Specifier>

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_valuesRecord<string, string>
optional
pricing_group_valuesRecord<string, string>
optional
product_idstring
optional

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

formatuuid
product_tagsarray
optional
Array<string>

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

subscription_configallocationunionapply_seat_increase_configApplySeatIncreaseConfigsubscription_idstringSubscriptionConfig
optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters
allocationunion
"INDIVIDUAL" | "POOLED"
Hide ParametersShow Parameters
"INDIVIDUAL"
"POOLED"
apply_seat_increase_configis_proratedbooleanApplySeatIncreaseConfig
Hide ParametersShow Parameters
is_proratedboolean

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

subscription_idstring
formatuuid
recurring_creditsarray
optional
Array<RecurringCredit>
Hide ParametersShow Parameters
idstring
formatuuid
access_amountcredit_type_idstringunit_pricenumberquantitynumberAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters
credit_type_idstring
formatuuid
unit_pricenumber
quantitynumber
optional
commit_durationvaluenumberunit"PERIODS"CommitDuration

The amount of time the created commits will be valid for

Hide ParametersShow Parameters
valuenumber
unit"PERIODS"
optional
Hide ParametersShow Parameters
"PERIODS"
prioritynumber

Will be passed down to the individual commits

productidstringnamestringProduct
Hide ParametersShow Parameters
idstring
formatuuid
namestring
rate_typeunion
"COMMIT_RATE" | "LIST_RATE"

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

Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
starting_atstring

Determines the start time for the first commit

formatdate-time
applicable_product_idsarray
optional
Array<string>

Will be passed down to the individual commits

applicable_product_tagsarray
optional
Array<string>

Will be passed down to the individual commits

contractidstringContract
optional
Hide ParametersShow Parameters
idstring
formatuuid
descriptionstring
optional

Will be passed down to the individual commits

ending_beforestring
optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time
hierarchy_configurationchild_accessunionHierarchyConfiguration
optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters
child_accessunion
type"ALL"CommitHierarchyChildAccessAll | type"NONE"CommitHierarchyChildAccessNone | contract_idsarraytype"CONTRACT_IDS"CommitHierarchyChildAccessContractIDs
Hide ParametersShow Parameters
CommitHierarchyChildAccessAll
Hide ParametersShow Parameters
type"ALL"
Hide ParametersShow Parameters
"ALL"
CommitHierarchyChildAccessNone
Hide ParametersShow Parameters
type"NONE"
Hide ParametersShow Parameters
"NONE"
CommitHierarchyChildAccessContractIDs
Hide ParametersShow Parameters
contract_idsarray
Array<string>
type"CONTRACT_IDS"
Hide ParametersShow Parameters
"CONTRACT_IDS"
namestring
optional

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

netsuite_sales_order_idstring
optional

Will be passed down to the individual commits

prorationunion
optional
"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_frequencyunion
optional
"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_fractionnumber
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.

specifiersarray
optional
Array<Specifier>

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_valuesRecord<string, string>
optional
pricing_group_valuesRecord<string, string>
optional
product_idstring
optional

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

formatuuid
product_tagsarray
optional
Array<string>

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

subscription_configallocationunionapply_seat_increase_configApplySeatIncreaseConfigsubscription_idstringSubscriptionConfig
optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters
allocationunion
"INDIVIDUAL" | "POOLED"
Hide ParametersShow Parameters
"INDIVIDUAL"
"POOLED"
apply_seat_increase_configis_proratedbooleanApplySeatIncreaseConfig
Hide ParametersShow Parameters
is_proratedboolean

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

subscription_idstring
formatuuid
reseller_royaltiesarray
optional
Array<ResellerRoyalty>

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

Hide ParametersShow Parameters
reseller_typeunion
"AWS" | "AWS_PRO_SERVICE" | "GCP" | "GCP_PRO_SERVICE"
Hide ParametersShow Parameters
"AWS"
"AWS_PRO_SERVICE"
"GCP"
"GCP_PRO_SERVICE"
segmentsarray
Array<Segment>
Hide ParametersShow Parameters
fractionnumber
netsuite_reseller_idstring
reseller_typeunion
"AWS" | "AWS_PRO_SERVICE" | "GCP" | "GCP_PRO_SERVICE"
Hide ParametersShow Parameters
"AWS"
"AWS_PRO_SERVICE"
"GCP"
"GCP_PRO_SERVICE"
starting_atstring
formatdate-time
applicable_product_idsarray
optional
Array<string>
applicable_product_tagsarray
optional
Array<string>
aws_account_numberstring
optional
aws_offer_idstring
optional
aws_payer_reference_idstring
optional
ending_beforestring
optional
formatdate-time
gcp_account_idstring
optional
gcp_offer_idstring
optional
reseller_contract_valuenumber
optional
salesforce_opportunity_idstring
optional

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

scheduled_charges_on_usage_invoices"ALL"
optional

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_configurationcommitCommitis_enabledbooleanpayment_gate_configPaymentGateConfigthreshold_amountnumberSpendThresholdConfiguration
optional
Hide ParametersShow Parameters
commitproduct_idstringdescriptionstringnamestringCommit
Hide ParametersShow Parameters
product_idstring

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

descriptionstring
optional
namestring
optional

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

is_enabledboolean

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_typeunionprecalculated_tax_configPrecalculatedTaxConfigstripe_configStripeConfigtax_typeunionPaymentGateConfig
Hide ParametersShow Parameters
payment_gate_typeunion
"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_amountnumbertax_namestringPrecalculatedTaxConfig
optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters
tax_amountnumber

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

tax_namestring
optional

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

stripe_configpayment_typeunioninvoice_metadataRecord<string, string>StripeConfig
optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters
payment_typeunion
"INVOICE" | "PAYMENT_INTENT"

If left blank, will default to INVOICE

Hide ParametersShow Parameters
"INVOICE"
"PAYMENT_INTENT"
invoice_metadataRecord<string, string>
optional

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

tax_typeunion
optional
"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_amountnumber

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

subscriptionsarray
optional
Array<Subscription>

List of subscriptions on the contract.

Hide ParametersShow Parameters
collection_scheduleunion
"ADVANCE" | "ARREARS"
Hide ParametersShow Parameters
"ADVANCE"
"ARREARS"
prorationinvoice_behaviorunionis_proratedbooleanProration
Hide ParametersShow Parameters
invoice_behaviorunion
"BILL_IMMEDIATELY" | "BILL_ON_NEXT_COLLECTION_DATE"
Hide ParametersShow Parameters
"BILL_IMMEDIATELY"
"BILL_ON_NEXT_COLLECTION_DATE"
is_proratedboolean
quantity_schedulearray
Array<QuantitySchedule>

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

Hide ParametersShow Parameters
quantitynumber
starting_atstring
formatdate-time
ending_beforestring
optional
formatdate-time
starting_atstring
formatdate-time
subscription_ratebilling_frequencyunionproductProductSubscriptionRate
Hide ParametersShow Parameters
billing_frequencyunion
"MONTHLY" | "QUARTERLY" | "ANNUAL" | "WEEKLY"
Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
productidstringnamestringProduct
Hide ParametersShow Parameters
idstring
formatuuid
namestring
idstring
optional
formatuuid
custom_fieldsRecord<string, string>
optional
descriptionstring
optional
ending_beforestring
optional
formatdate-time
fiat_credit_type_idstring
optional
formatuuid
namestring
optional
total_contract_valuenumber
optional
uniqueness_keystring
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
import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const contract = await client.v2.contracts.retrieve({
  contract_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
  customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
});

console.log(contract.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"
  }
}