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

Retrieve

API Reference
V1
Contracts
Get a contract (v1)
v1.contracts.retrieve(ContractRetrieveParams**kwargs) -> dataDataContractRetrieveResponse
post/v1/contracts/get

This is the v1 endpoint to get a contract. New clients should implement using the v2 endpoint.

Parameters
contract_idstr
formatuuid
customer_idstr
formatuuid
include_balancebool
optional

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

include_ledgersbool
optional

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

Returns
ContractRetrieveResponseclass
Hide ParametersShow Parameters
dataidstramendmentslistcurrentContractWithoutAmendmentscustomer_idstrinitialContractWithoutAmendmentsarchived_atdatetimecustom_fieldsDict[str, str]customer_billing_provider_configurationDataCustomerBillingProviderConfigurationprepaid_balance_threshold_configurationDataPrepaidBalanceThresholdConfigurationpriorityfloatscheduled_charges_on_usage_invoicesliteralspend_threshold_configurationDataSpendThresholdConfigurationsubscriptionslistuniqueness_keystrData
Hide ParametersShow Parameters
idstr
formatuuid
amendmentslist
List[DataAmendment]
Hide ParametersShow Parameters
idstr
formatuuid
commitslist
List[idstrproductProducttypeliteralaccess_scheduleScheduleDurationamountfloatapplicable_contract_idslistapplicable_product_idslistapplicable_product_tagslistarchived_atdatetimebalancefloatcontractContractcustom_fieldsDict[str, str]descriptionstrhierarchy_configurationHierarchyConfigurationinvoice_contractInvoiceContractinvoice_scheduleSchedulePointInTimeledgerlistnamestrnetsuite_sales_order_idstrpriorityfloatrate_typeliteralrolled_over_fromRolledOverFromrollover_fractionfloatsalesforce_opportunity_idstrspecifierslistuniqueness_keystrCommit]
Hide ParametersShow Parameters
idstr
formatuuid
productidstrnamestrProduct
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.

amountfloat
optional

(DEPRECATED) Use access_schedule + invoice_schedule instead.

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

RFC 3339 timestamp indicating when the commit was archived. If not provided, the commit is not archived.

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.

contractidstrContract
optional
Hide ParametersShow Parameters
idstr
formatuuid
custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
descriptionstr
optional
hierarchy_configurationchild_accessHierarchyConfigurationChildAccessHierarchyConfiguration
optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters
child_accessHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
HierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
HierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
HierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
invoice_contractidstrInvoiceContract
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[Ledger]]

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

Hide ParametersShow Parameters
LedgerPrepaidCommitSegmentStartLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_SEGMENT_START"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_SEGMENT_START"
LedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryclass
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
LedgerPrepaidCommitRolloverLedgerEntryclass
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"
LedgerPrepaidCommitExpirationLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_EXPIRATION"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_EXPIRATION"
LedgerPrepaidCommitCanceledLedgerEntryclass
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
LedgerPrepaidCommitCreditedLedgerEntryclass
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
LedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryclass
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"
LedgerPostpaidCommitInitialBalanceLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
timestampdatetime
formatdate-time
typeliteral
Literal["POSTPAID_COMMIT_INITIAL_BALANCE"]
Hide ParametersShow Parameters
"POSTPAID_COMMIT_INITIAL_BALANCE"
LedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryclass
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
LedgerPostpaidCommitRolloverLedgerEntryclass
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"
LedgerPostpaidCommitTrueupLedgerEntryclass
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
LedgerPrepaidCommitManualLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
reasonstr
timestampdatetime
formatdate-time
typeliteral
Literal["PREPAID_COMMIT_MANUAL"]
Hide ParametersShow Parameters
"PREPAID_COMMIT_MANUAL"
LedgerPostpaidCommitManualLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
reasonstr
timestampdatetime
formatdate-time
typeliteral
Literal["POSTPAID_COMMIT_MANUAL"]
Hide ParametersShow Parameters
"POSTPAID_COMMIT_MANUAL"
LedgerPostpaidCommitExpirationLedgerEntryclass
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_idstrRolledOverFrom
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[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_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.

uniqueness_keystr
optional

Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or credit, a new record will not be created and the request will fail with a 409 error.

minLength1
maxLength128
created_atdatetime
formatdate-time
created_bystr
overrideslist
List[idstrstarting_atdatetimeapplicable_product_tagslistcredit_typeCreditTypeDataending_beforedatetimeentitledboolis_commit_specificboolis_proratedboolmultiplierfloatoverride_specifierslistoverride_tierslistoverwrite_rateOverwriteRatepricefloatpriorityfloatproductProductquantityfloatrate_typeliteraltargetliteraltierslisttypeliteralvalueDict[str, object]Override]
Hide ParametersShow Parameters
idstr
formatuuid
starting_atdatetime
formatdate-time
applicable_product_tagslist
optional
Optional[List[str]]
credit_typeCreditTypeData
optional
ending_beforedatetime
optional
formatdate-time
entitledbool
optional
is_commit_specificbool
optional
is_proratedbool
optional

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

multiplierfloat
optional
override_specifierslist
optional
Optional[List[OverrideSpecifier]]
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[OverrideTier]]
Hide ParametersShow Parameters
multiplierfloat
sizefloat
optional
overwrite_raterate_typeliteralcredit_typeCreditTypeDatacustom_rateDict[str, object]is_proratedboolpricefloatquantityfloattierslistOverwriteRate
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
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.

priorityfloat
optional
productidstrnamestrProduct
optional
Hide ParametersShow Parameters
idstr
formatuuid
namestr
quantityfloat
optional

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

rate_typeliteral
optional
Optional[Literal["FLAT", "PERCENTAGE", "SUBSCRIPTION", 2 more]]
Hide ParametersShow Parameters
"FLAT"
"PERCENTAGE"
"SUBSCRIPTION"
"TIERED"
"CUSTOM"
targetliteral
optional
Optional[Literal["COMMIT_RATE", "LIST_RATE"]]
Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
tierslist
optional
Optional[List[pricefloatsizefloatTier]]

Only set for TIERED rate_type.

Hide ParametersShow Parameters
pricefloat
sizefloat
optional
typeliteral
optional
Optional[Literal["OVERWRITE", "MULTIPLIER", "TIERED"]]
Hide ParametersShow Parameters
"OVERWRITE"
"MULTIPLIER"
"TIERED"
valueDict[str, object]
optional
Optional[Dict[str, object]]

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

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
creditslist
optional
Optional[List[idstrproductProducttypeliteralaccess_scheduleScheduleDurationapplicable_contract_idslistapplicable_product_idslistapplicable_product_tagslistbalancefloatcontractContractcustom_fieldsDict[str, str]descriptionstrhierarchy_configurationHierarchyConfigurationledgerlistnamestrnetsuite_sales_order_idstrpriorityfloatrate_typeliteralsalesforce_opportunity_idstrspecifierslistuniqueness_keystrCredit]]
Hide ParametersShow Parameters
idstr
formatuuid
productidstrnamestrProduct
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.

contractidstrContract
optional
Hide ParametersShow Parameters
idstr
formatuuid
custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
descriptionstr
optional
hierarchy_configurationchild_accessHierarchyConfigurationChildAccessHierarchyConfiguration
optional

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters
child_accessHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
HierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
HierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
HierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
ledgerlist
optional
Optional[List[Ledger]]

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

Hide ParametersShow Parameters
LedgerCreditSegmentStartLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["CREDIT_SEGMENT_START"]
Hide ParametersShow Parameters
"CREDIT_SEGMENT_START"
LedgerCreditAutomatedInvoiceDeductionLedgerEntryclass
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
LedgerCreditExpirationLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
segment_idstr
formatuuid
timestampdatetime
formatdate-time
typeliteral
Literal["CREDIT_EXPIRATION"]
Hide ParametersShow Parameters
"CREDIT_EXPIRATION"
LedgerCreditCanceledLedgerEntryclass
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
LedgerCreditCreditedLedgerEntryclass
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
LedgerCreditManualLedgerEntryclass
Hide ParametersShow Parameters
amountfloat
reasonstr
timestampdatetime
formatdate-time
typeliteral
Literal["CREDIT_MANUAL"]
Hide ParametersShow Parameters
"CREDIT_MANUAL"
LedgerCreditSeatBasedAdjustmentLedgerEntryclass
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.

rate_typeliteral
optional
Optional[Literal["COMMIT_RATE", "LIST_RATE"]]
Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
salesforce_opportunity_idstr
optional

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

specifierslist
optional
Optional[List[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_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.

uniqueness_keystr
optional

Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or credit, a new record will not be created and the request will fail with a 409 error.

minLength1
maxLength128
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.

netsuite_sales_order_idstr
optional

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

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.

reseller_royaltieslist
optional
Optional[List[DataAmendmentResellerRoyalty]]

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"
aws_account_numberstr
optional
aws_offer_idstr
optional
aws_payer_reference_idstr
optional
ending_beforedatetime
optional
formatdate-time
fractionfloat
optional
gcp_account_idstr
optional
gcp_offer_idstr
optional
netsuite_reseller_idstr
optional
reseller_contract_valuefloat
optional
starting_atdatetime
optional
formatdate-time
salesforce_opportunity_idstr
optional

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

currentcommitslistcreated_atdatetimecreated_bystroverrideslistscheduled_chargesliststarting_atdatetimetransitionslistusage_statement_scheduleUsageStatementSchedulecreditslistdiscountslistending_beforedatetimehierarchy_configurationHierarchyConfigurationnamestrnet_payment_terms_daysfloatnetsuite_sales_order_idstrprepaid_balance_threshold_configurationPrepaidBalanceThresholdConfigurationprofessional_serviceslistrate_card_idstrrecurring_commitslistrecurring_creditslistreseller_royaltieslistsalesforce_opportunity_idstrscheduled_charges_on_usage_invoicesliteralspend_threshold_configurationSpendThresholdConfigurationtotal_contract_valuefloatusage_filterUsageFilterContractWithoutAmendments
customer_idstr
formatuuid
initialcommitslistcreated_atdatetimecreated_bystroverrideslistscheduled_chargesliststarting_atdatetimetransitionslistusage_statement_scheduleUsageStatementSchedulecreditslistdiscountslistending_beforedatetimehierarchy_configurationHierarchyConfigurationnamestrnet_payment_terms_daysfloatnetsuite_sales_order_idstrprepaid_balance_threshold_configurationPrepaidBalanceThresholdConfigurationprofessional_serviceslistrate_card_idstrrecurring_commitslistrecurring_creditslistreseller_royaltieslistsalesforce_opportunity_idstrscheduled_charges_on_usage_invoicesliteralspend_threshold_configurationSpendThresholdConfigurationtotal_contract_valuefloatusage_filterUsageFilterContractWithoutAmendments
archived_atdatetime
optional

RFC 3339 timestamp indicating when the contract was archived. If not returned, the contract is not archived.

formatdate-time
custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
customer_billing_provider_configurationbilling_providerliteraldelivery_methodliteralidstrconfigurationDict[str, object]DataCustomerBillingProviderConfiguration
optional

The billing provider configuration associated with a contract.

Hide ParametersShow Parameters
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"
idstr
optional
formatuuid
configurationDict[str, object]
optional
Optional[Dict[str, object]]

Configuration for the billing provider. The structure of this object is specific to the billing provider.

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.

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 gate 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 prepaid 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.

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 gate 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
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",
)
contract = client.v1.contracts.retrieve(
    contract_id="d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
    customer_id="13117714-3f05-48e5-a6e9-a66093f13b4d",
)
print(contract.data)
200 Example
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "amendments": [
      {
        "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"
              }
            },
            "amount": 0,
            "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"
                ]
              }
            ],
            "uniqueness_key": "x"
          }
        ],
        "created_at": "2019-12-27T18:11:19.117Z",
        "created_by": "created_by",
        "overrides": [
          {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "starting_at": "2019-12-27T18:11:19.117Z",
            "applicable_product_tags": [
              "string"
            ],
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "ending_before": "2019-12-27T18:11:19.117Z",
            "entitled": true,
            "is_commit_specific": true,
            "is_prorated": 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
                }
              ]
            },
            "price": 0,
            "priority": 0,
            "product": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "quantity": 0,
            "rate_type": "FLAT",
            "target": "COMMIT_RATE",
            "tiers": [
              {
                "price": 0,
                "size": 0
              }
            ],
            "type": "OVERWRITE",
            "value": {
              "foo": "bar"
            }
          }
        ],
        "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",
        "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,
            "rate_type": "COMMIT_RATE",
            "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"
                ]
              }
            ],
            "uniqueness_key": "x"
          }
        ],
        "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"
          }
        ],
        "netsuite_sales_order_id": "netsuite_sales_order_id",
        "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"
          }
        ],
        "reseller_royalties": [
          {
            "reseller_type": "AWS",
            "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",
            "fraction": 0,
            "gcp_account_id": "gcp_account_id",
            "gcp_offer_id": "gcp_offer_id",
            "netsuite_reseller_id": "netsuite_reseller_id",
            "reseller_contract_value": 0,
            "starting_at": "2019-12-27T18:11:19.117Z"
          }
        ],
        "salesforce_opportunity_id": "salesforce_opportunity_id"
      }
    ],
    "current": {
      "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"
            }
          },
          "amount": 0,
          "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"
              ]
            }
          ],
          "uniqueness_key": "x"
        }
      ],
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "overrides": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "starting_at": "2019-12-27T18:11:19.117Z",
          "applicable_product_tags": [
            "string"
          ],
          "credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "ending_before": "2019-12-27T18:11:19.117Z",
          "entitled": true,
          "is_commit_specific": true,
          "is_prorated": 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
              }
            ]
          },
          "price": 0,
          "priority": 0,
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "quantity": 0,
          "rate_type": "FLAT",
          "target": "COMMIT_RATE",
          "tiers": [
            {
              "price": 0,
              "size": 0
            }
          ],
          "type": "OVERWRITE",
          "value": {
            "foo": "bar"
          }
        }
      ],
      "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_statement_schedule": {
        "billing_anchor_date": "2019-12-27T18:11:19.117Z",
        "frequency": "MONTHLY"
      },
      "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,
          "rate_type": "COMMIT_RATE",
          "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"
              ]
            }
          ],
          "uniqueness_key": "x"
        }
      ],
      "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",
      "hierarchy_configuration": {
        "children": [
          {
            "contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          }
        ]
      },
      "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"
      },
      "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": [
        {
          "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
      },
      "total_contract_value": 0,
      "usage_filter": {
        "current": {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z"
        },
        "initial": {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z"
        },
        "updates": [
          {
            "group_key": "group_key",
            "group_values": [
              "string"
            ],
            "starting_at": "2019-12-27T18:11:19.117Z"
          }
        ]
      }
    },
    "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "initial": {
      "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"
            }
          },
          "amount": 0,
          "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"
              ]
            }
          ],
          "uniqueness_key": "x"
        }
      ],
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "overrides": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "starting_at": "2019-12-27T18:11:19.117Z",
          "applicable_product_tags": [
            "string"
          ],
          "credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "ending_before": "2019-12-27T18:11:19.117Z",
          "entitled": true,
          "is_commit_specific": true,
          "is_prorated": 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
              }
            ]
          },
          "price": 0,
          "priority": 0,
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "quantity": 0,
          "rate_type": "FLAT",
          "target": "COMMIT_RATE",
          "tiers": [
            {
              "price": 0,
              "size": 0
            }
          ],
          "type": "OVERWRITE",
          "value": {
            "foo": "bar"
          }
        }
      ],
      "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_statement_schedule": {
        "billing_anchor_date": "2019-12-27T18:11:19.117Z",
        "frequency": "MONTHLY"
      },
      "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,
          "rate_type": "COMMIT_RATE",
          "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"
              ]
            }
          ],
          "uniqueness_key": "x"
        }
      ],
      "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",
      "hierarchy_configuration": {
        "children": [
          {
            "contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          }
        ]
      },
      "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"
      },
      "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": [
        {
          "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
      },
      "total_contract_value": 0,
      "usage_filter": {
        "current": {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z"
        },
        "initial": {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z"
        },
        "updates": [
          {
            "group_key": "group_key",
            "group_values": [
              "string"
            ],
            "starting_at": "2019-12-27T18:11:19.117Z"
          }
        ]
      }
    },
    "archived_at": "2019-12-27T18:11:19.117Z",
    "custom_fields": {
      "foo": "string"
    },
    "customer_billing_provider_configuration": {
      "billing_provider": "aws_marketplace",
      "delivery_method": "direct_to_billing_provider",
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "configuration": {
        "foo": "bar"
      }
    },
    "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,
    "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"
      }
    ],
    "uniqueness_key": "x"
  }
}