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

Get Edit History

API Reference
V2
Contracts
Get contract edit history
v2.contracts.get_edit_history(ContractGetEditHistoryParams**kwargs) -> datalistContractGetEditHistoryResponse
post/v2/contracts/getEditHistory

Get the edit history of a specific contract. Contract editing must be enabled to use this endpoint.

Parameters
contract_idstr
formatuuid
customer_idstr
formatuuid
Returns
ContractGetEditHistoryResponseclass
Hide ParametersShow Parameters
datalist
List[Data]
Hide ParametersShow Parameters
idstr
formatuuid
add_commitslist
optional
Optional[List[DataAddCommit]]
Hide ParametersShow Parameters
idstr
formatuuid
productidstrnamestrDataAddCommitProduct
Hide ParametersShow Parameters
idstr
formatuuid
namestr
typeliteral
Literal["PREPAID", "POSTPAID"]
Hide ParametersShow Parameters
"PREPAID"
"POSTPAID"
access_scheduleScheduleDuration
optional

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

applicable_product_idslist
optional
Optional[List[str]]
applicable_product_tagslist
optional
Optional[List[str]]
descriptionstr
optional
hierarchy_configurationchild_accessDataAddCommitHierarchyConfigurationChildAccessDataAddCommitHierarchyConfiguration
optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters
child_accessDataAddCommitHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
DataAddCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
DataAddCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
DataAddCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
invoice_scheduleSchedulePointInTime
optional

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

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"
rollover_fractionfloat
optional
salesforce_opportunity_idstr
optional

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

specifierslist
optional
Optional[List[DataAddCommitSpecifier]]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with applicable_product_ids or applicable_product_tags. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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

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

formatuuid
product_tagslist
optional
Optional[List[str]]

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

add_creditslist
optional
Optional[List[DataAddCredit]]
Hide ParametersShow Parameters
idstr
formatuuid
productidstrnamestrDataAddCreditProduct
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_product_idslist
optional
Optional[List[str]]
applicable_product_tagslist
optional
Optional[List[str]]
descriptionstr
optional
hierarchy_configurationchild_accessDataAddCreditHierarchyConfigurationChildAccessDataAddCreditHierarchyConfiguration
optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters
child_accessDataAddCreditHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
DataAddCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
DataAddCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
DataAddCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
namestr
optional
netsuite_sales_order_idstr
optional

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

priorityfloat
optional

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

salesforce_opportunity_idstr
optional

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

specifierslist
optional
Optional[List[DataAddCreditSpecifier]]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with applicable_product_ids or applicable_product_tags. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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

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

formatuuid
product_tagslist
optional
Optional[List[str]]

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

add_discountslist
optional
Optional[List[idstrproductProductscheduleSchedulePointInTimecustom_fieldsDict[str, str]namestrnetsuite_sales_order_idstrDiscount]]
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.

add_overrideslist
optional
Optional[List[DataAddOverride]]
Hide ParametersShow Parameters
idstr
formatuuid
starting_atdatetime
formatdate-time
applicable_product_tagslist
optional
Optional[List[str]]
ending_beforedatetime
optional
formatdate-time
entitledbool
optional
is_commit_specificbool
optional
multiplierfloat
optional
override_specifierslist
optional
Optional[List[DataAddOverrideOverrideSpecifier]]
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[DataAddOverrideOverrideTier]]
Hide ParametersShow Parameters
multiplierfloat
sizefloat
optional
overwrite_raterate_typeliteralcredit_typeCreditTypeDatacustom_rateDict[str, object]is_proratedboolpricefloatquantityfloattierslistDataAddOverrideOverwriteRate
optional
Hide ParametersShow Parameters
rate_typeliteral
Literal["FLAT", "PERCENTAGE", "SUBSCRIPTION", 2 more]
Hide ParametersShow Parameters
"FLAT"
"PERCENTAGE"
"SUBSCRIPTION"
"TIERED"
"CUSTOM"
credit_typeCreditTypeData
optional
custom_rateDict[str, object]
optional
Optional[Dict[str, object]]

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

is_proratedbool
optional

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

pricefloat
optional

Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.

quantityfloat
optional

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

tierslist
optional
Optional[List[pricefloatsizefloatTier]]

Only set for TIERED rate_type.

Hide ParametersShow Parameters
pricefloat
sizefloat
optional
priorityfloat
optional
productidstrnamestrDataAddOverrideProduct
optional
Hide ParametersShow Parameters
idstr
formatuuid
namestr
targetliteral
optional
Optional[Literal["COMMIT_RATE", "LIST_RATE"]]
Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
typeliteral
optional
Optional[Literal["OVERWRITE", "MULTIPLIER", "TIERED"]]
Hide ParametersShow Parameters
"OVERWRITE"
"MULTIPLIER"
"TIERED"
add_prepaid_balance_threshold_configurationcommitDataAddPrepaidBalanceThresholdConfigurationCommitis_enabledboolpayment_gate_configDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigrecharge_to_amountfloatthreshold_amountfloatcustom_credit_type_idstrDataAddPrepaidBalanceThresholdConfiguration
optional
Hide ParametersShow Parameters
commitproduct_idstrapplicable_product_idslistapplicable_product_tagslistdescriptionstrnamestrspecifierslistDataAddPrepaidBalanceThresholdConfigurationCommit
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[DataAddPrepaidBalanceThresholdConfigurationCommitSpecifier]]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with applicable_product_ids or applicable_product_tags. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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

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

formatuuid
product_tagslist
optional
Optional[List[str]]

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

is_enabledbool

When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.

payment_gate_configpayment_gate_typeliteralprecalculated_tax_configDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigstripe_configDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigtax_typeliteralDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfig
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_namestrDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig
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]DataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfig
optional

Only applicable if using STRIPE as your payment gateway type.

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

If left blank, will default to INVOICE

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

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

tax_typeliteral
optional
Optional[Literal["NONE", "STRIPE", "ANROK", "PRECALCULATED"]]

Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.

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

Specify the amount the balance should be recharged to.

threshold_amountfloat

Specify the threshold amount for the contract. Each time the contract's balance lowers to this amount, a threshold charge will be initiated.

custom_credit_type_idstr
optional

If provided, the threshold, recharge-to amount, and the resulting threshold commit amount will be in terms of this credit type instead of the fiat currency.

formatuuid
add_pro_serviceslist
optional
Optional[List[idstrmax_amountfloatproduct_idstrquantityfloatunit_pricefloatcustom_fieldsDict[str, str]descriptionstrnetsuite_sales_order_idstrProService]]
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.

add_recurring_commitslist
optional
Optional[List[DataAddRecurringCommit]]
Hide ParametersShow Parameters
idstr
formatuuid
access_amountcredit_type_idstrunit_pricefloatquantityfloatDataAddRecurringCommitAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters
credit_type_idstr
formatuuid
unit_pricefloat
quantityfloat
optional
commit_durationvaluefloatunitliteralDataAddRecurringCommitCommitDuration

The amount of time the created commits will be valid for

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

Will be passed down to the individual commits

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

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

Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
starting_atdatetime

Determines the start time for the first commit

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

Will be passed down to the individual commits

applicable_product_tagslist
optional
Optional[List[str]]

Will be passed down to the individual commits

contractidstrDataAddRecurringCommitContract
optional
Hide ParametersShow Parameters
idstr
formatuuid
descriptionstr
optional

Will be passed down to the individual commits

ending_beforedatetime
optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time
hierarchy_configurationchild_accessDataAddRecurringCommitHierarchyConfigurationChildAccessDataAddRecurringCommitHierarchyConfiguration
optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters
child_accessDataAddRecurringCommitHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
DataAddRecurringCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
DataAddRecurringCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
DataAddRecurringCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
invoice_amountcredit_type_idstrquantityfloatunit_pricefloatDataAddRecurringCommitInvoiceAmount
optional

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

Hide ParametersShow Parameters
credit_type_idstr
formatuuid
quantityfloat
unit_pricefloat
namestr
optional

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

netsuite_sales_order_idstr
optional

Will be passed down to the individual commits

prorationliteral
optional
Optional[Literal["NONE", "FIRST", "LAST", "FIRST_AND_LAST"]]

Determines whether the first and last commit will be prorated. If not provided, the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).

Hide ParametersShow Parameters
"NONE"
"FIRST"
"LAST"
"FIRST_AND_LAST"
recurrence_frequencyliteral
optional
Optional[Literal["MONTHLY", "QUARTERLY", "ANNUAL", "WEEKLY"]]

The frequency at which the recurring commits will be created. If not provided: - The commits will be created on the usage invoice frequency. If provided: - The period defined in the duration will correspond to this frequency. - Commits will be created aligned with the recurring commit's starting_at rather than the usage invoice dates.

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

Will be passed down to the individual commits. This controls how much of an individual unexpired commit will roll over upon contract transition. Must be between 0 and 1.

specifierslist
optional
Optional[List[DataAddRecurringCommitSpecifier]]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown.

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

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

formatuuid
product_tagslist
optional
Optional[List[str]]

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

subscription_configallocationliteralapply_seat_increase_configDataAddRecurringCommitSubscriptionConfigApplySeatIncreaseConfigsubscription_idstrDataAddRecurringCommitSubscriptionConfig
optional

Attach a subscription to the recurring commit/credit.

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

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

subscription_idstr
formatuuid
add_recurring_creditslist
optional
Optional[List[DataAddRecurringCredit]]
Hide ParametersShow Parameters
idstr
formatuuid
access_amountcredit_type_idstrunit_pricefloatquantityfloatDataAddRecurringCreditAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters
credit_type_idstr
formatuuid
unit_pricefloat
quantityfloat
optional
commit_durationvaluefloatunitliteralDataAddRecurringCreditCommitDuration

The amount of time the created commits will be valid for

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

Will be passed down to the individual commits

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

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

Hide ParametersShow Parameters
"COMMIT_RATE"
"LIST_RATE"
starting_atdatetime

Determines the start time for the first commit

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

Will be passed down to the individual commits

applicable_product_tagslist
optional
Optional[List[str]]

Will be passed down to the individual commits

contractidstrDataAddRecurringCreditContract
optional
Hide ParametersShow Parameters
idstr
formatuuid
descriptionstr
optional

Will be passed down to the individual commits

ending_beforedatetime
optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time
hierarchy_configurationchild_accessDataAddRecurringCreditHierarchyConfigurationChildAccessDataAddRecurringCreditHierarchyConfiguration
optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters
child_accessDataAddRecurringCreditHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
DataAddRecurringCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
DataAddRecurringCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
DataAddRecurringCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
namestr
optional

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

netsuite_sales_order_idstr
optional

Will be passed down to the individual commits

prorationliteral
optional
Optional[Literal["NONE", "FIRST", "LAST", "FIRST_AND_LAST"]]

Determines whether the first and last commit will be prorated. If not provided, the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).

Hide ParametersShow Parameters
"NONE"
"FIRST"
"LAST"
"FIRST_AND_LAST"
recurrence_frequencyliteral
optional
Optional[Literal["MONTHLY", "QUARTERLY", "ANNUAL", "WEEKLY"]]

The frequency at which the recurring commits will be created. If not provided: - The commits will be created on the usage invoice frequency. If provided: - The period defined in the duration will correspond to this frequency. - Commits will be created aligned with the recurring commit's starting_at rather than the usage invoice dates.

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

Will be passed down to the individual commits. This controls how much of an individual unexpired commit will roll over upon contract transition. Must be between 0 and 1.

specifierslist
optional
Optional[List[DataAddRecurringCreditSpecifier]]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown.

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

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

formatuuid
product_tagslist
optional
Optional[List[str]]

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

subscription_configallocationliteralapply_seat_increase_configDataAddRecurringCreditSubscriptionConfigApplySeatIncreaseConfigsubscription_idstrDataAddRecurringCreditSubscriptionConfig
optional

Attach a subscription to the recurring commit/credit.

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

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

subscription_idstr
formatuuid
add_reseller_royaltieslist
optional
Optional[List[DataAddResellerRoyalty]]
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"
applicable_product_idslist
optional
Optional[List[str]]
applicable_product_tagslist
optional
Optional[List[str]]
aws_account_numberstr
optional
aws_offer_idstr
optional
aws_payer_reference_idstr
optional
ending_beforedatetime
optional
formatdate-time
fractionfloat
optional
gcp_account_idstr
optional
gcp_offer_idstr
optional
netsuite_reseller_idstr
optional
reseller_contract_valuefloat
optional
starting_atdatetime
optional
formatdate-time
add_scheduled_chargeslist
optional
Optional[List[DataAddScheduledCharge]]
Hide ParametersShow Parameters
idstr
formatuuid
productidstrnamestrDataAddScheduledChargeProduct
Hide ParametersShow Parameters
idstr
formatuuid
namestr
schedulecredit_typeCreditTypeDatado_not_invoiceboolschedule_itemslistSchedulePointInTime
namestr
optional

displayed on invoices

minLength1
netsuite_sales_order_idstr
optional

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

add_spend_threshold_configurationcommitDataAddSpendThresholdConfigurationCommitis_enabledboolpayment_gate_configDataAddSpendThresholdConfigurationPaymentGateConfigthreshold_amountfloatDataAddSpendThresholdConfiguration
optional
Hide ParametersShow Parameters
commitproduct_idstrdescriptionstrnamestrDataAddSpendThresholdConfigurationCommit
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_configDataAddSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigstripe_configDataAddSpendThresholdConfigurationPaymentGateConfigStripeConfigtax_typeliteralDataAddSpendThresholdConfigurationPaymentGateConfig
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_namestrDataAddSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig
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]DataAddSpendThresholdConfigurationPaymentGateConfigStripeConfig
optional

Only applicable if using STRIPE as your payment gateway type.

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

If left blank, will default to INVOICE

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

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

tax_typeliteral
optional
Optional[Literal["NONE", "STRIPE", "ANROK", "PRECALCULATED"]]

Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.

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

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

add_subscriptionslist
optional
Optional[List[DataAddSubscription]]

List of subscriptions on the contract.

Hide ParametersShow Parameters
collection_scheduleliteral
Literal["ADVANCE", "ARREARS"]
Hide ParametersShow Parameters
"ADVANCE"
"ARREARS"
prorationinvoice_behaviorliteralis_proratedboolDataAddSubscriptionProration
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[DataAddSubscriptionQuantitySchedule]

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_frequencyliteralproductDataAddSubscriptionSubscriptionRateProductDataAddSubscriptionSubscriptionRate
Hide ParametersShow Parameters
billing_frequencyliteral
Literal["MONTHLY", "QUARTERLY", "ANNUAL", "WEEKLY"]
Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
productidstrnamestrDataAddSubscriptionSubscriptionRateProduct
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
add_usage_filterslist
optional
Optional[List[DataAddUsageFilter]]
Hide ParametersShow Parameters
group_keystr
group_valueslist
List[str]
starting_atdatetime

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

formatdate-time
ending_beforedatetime
optional

This will match contract ending_before value if usage filter is active until the end of the contract. It will be undefined if the contract is open-ended.

formatdate-time
archive_commitslist
optional
Optional[List[DataArchiveCommit]]
Hide ParametersShow Parameters
idstr
formatuuid
archive_creditslist
optional
Optional[List[DataArchiveCredit]]
Hide ParametersShow Parameters
idstr
formatuuid
archive_scheduled_chargeslist
optional
Optional[List[DataArchiveScheduledCharge]]
Hide ParametersShow Parameters
idstr
formatuuid
remove_overrideslist
optional
Optional[List[DataRemoveOverride]]
Hide ParametersShow Parameters
idstr
formatuuid
timestampdatetime
optional
formatdate-time
update_commitslist
optional
Optional[List[DataUpdateCommit]]
Hide ParametersShow Parameters
idstr
formatuuid
access_scheduleadd_schedule_itemslistremove_schedule_itemslistupdate_schedule_itemslistDataUpdateCommitAccessSchedule
optional
Hide ParametersShow Parameters
add_schedule_itemslist
optional
Optional[List[DataUpdateCommitAccessScheduleAddScheduleItem]]
Hide ParametersShow Parameters
amountfloat
ending_beforedatetime

RFC 3339 timestamp (exclusive)

formatdate-time
starting_atdatetime

RFC 3339 timestamp (inclusive)

formatdate-time
remove_schedule_itemslist
optional
Optional[List[DataUpdateCommitAccessScheduleRemoveScheduleItem]]
Hide ParametersShow Parameters
idstr
formatuuid
update_schedule_itemslist
optional
Optional[List[DataUpdateCommitAccessScheduleUpdateScheduleItem]]
Hide ParametersShow Parameters
idstr
formatuuid
amountfloat
optional
ending_beforedatetime
optional

RFC 3339 timestamp (exclusive)

formatdate-time
starting_atdatetime
optional

RFC 3339 timestamp (inclusive)

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

Which products the 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 commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.

hierarchy_configurationchild_accessDataUpdateCommitHierarchyConfigurationChildAccessDataUpdateCommitHierarchyConfiguration
optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters
child_accessDataUpdateCommitHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
DataUpdateCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
DataUpdateCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
DataUpdateCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
invoice_scheduleadd_schedule_itemslistremove_schedule_itemslistupdate_schedule_itemslistDataUpdateCommitInvoiceSchedule
optional
Hide ParametersShow Parameters
add_schedule_itemslist
optional
Optional[List[DataUpdateCommitInvoiceScheduleAddScheduleItem]]
Hide ParametersShow Parameters
timestampdatetime
formatdate-time
amountfloat
optional
quantityfloat
optional
unit_pricefloat
optional
remove_schedule_itemslist
optional
Optional[List[DataUpdateCommitInvoiceScheduleRemoveScheduleItem]]
Hide ParametersShow Parameters
idstr
formatuuid
update_schedule_itemslist
optional
Optional[List[DataUpdateCommitInvoiceScheduleUpdateScheduleItem]]
Hide ParametersShow Parameters
idstr
formatuuid
amountfloat
optional
quantityfloat
optional
timestampdatetime
optional
formatdate-time
unit_pricefloat
optional
namestr
optional
netsuite_sales_order_idstr
optional
priorityfloat
optional

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

product_idstr
optional
formatuuid
rollover_fractionfloat
optional
specifierslist
optional
Optional[List[DataUpdateCommitSpecifier]]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with applicable_product_ids or applicable_product_tags. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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

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

formatuuid
product_tagslist
optional
Optional[List[str]]

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

update_contract_end_datedatetime
optional
formatdate-time
update_contract_namestr
optional

Value to update the contract name to. If not provided, the contract name will remain unchanged.

update_creditslist
optional
Optional[List[DataUpdateCredit]]
Hide ParametersShow Parameters
idstr
formatuuid
access_scheduleadd_schedule_itemslistremove_schedule_itemslistupdate_schedule_itemslistDataUpdateCreditAccessSchedule
optional
Hide ParametersShow Parameters
add_schedule_itemslist
optional
Optional[List[DataUpdateCreditAccessScheduleAddScheduleItem]]
Hide ParametersShow Parameters
amountfloat
ending_beforedatetime

RFC 3339 timestamp (exclusive)

formatdate-time
starting_atdatetime

RFC 3339 timestamp (inclusive)

formatdate-time
remove_schedule_itemslist
optional
Optional[List[DataUpdateCreditAccessScheduleRemoveScheduleItem]]
Hide ParametersShow Parameters
idstr
formatuuid
update_schedule_itemslist
optional
Optional[List[DataUpdateCreditAccessScheduleUpdateScheduleItem]]
Hide ParametersShow Parameters
idstr
formatuuid
amountfloat
optional
ending_beforedatetime
optional

RFC 3339 timestamp (exclusive)

formatdate-time
starting_atdatetime
optional

RFC 3339 timestamp (inclusive)

formatdate-time
hierarchy_configurationchild_accessDataUpdateCreditHierarchyConfigurationChildAccessDataUpdateCreditHierarchyConfiguration
optional

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters
child_accessDataUpdateCreditHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
DataUpdateCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
DataUpdateCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
DataUpdateCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
namestr
optional
netsuite_sales_order_idstr
optional
priorityfloat
optional

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

rollover_fractionfloat
optional
update_discountslist
optional
Optional[List[DataUpdateDiscount]]
Hide ParametersShow Parameters
idstr
formatuuid
custom_fieldsDict[str, str]
optional
Optional[Dict[str, str]]
namestr
optional
netsuite_sales_order_idstr
optional
schedulecredit_type_idstrdo_not_invoiceboolrecurring_scheduleDataUpdateDiscountScheduleRecurringScheduleschedule_itemslistDataUpdateDiscountSchedule
optional

Must provide either schedule_items or recurring_schedule.

Hide ParametersShow Parameters
credit_type_idstr
optional

Defaults to USD (cents) if not passed.

formatuuid
do_not_invoicebool
optional

This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice.

recurring_scheduleamount_distributionliteralending_beforedatetimefrequencyliteralstarting_atdatetimeamountfloatquantityfloatunit_pricefloatDataUpdateDiscountScheduleRecurringSchedule
optional

Enter the unit price and quantity for the charge or instead only send the amount. If amount is sent, the unit price is assumed to be the amount and quantity is inferred to be 1.

Hide ParametersShow Parameters
amount_distributionliteral
Literal["DIVIDED", "DIVIDED_ROUNDED", "EACH"]
Hide ParametersShow Parameters
"DIVIDED"
"DIVIDED_ROUNDED"
"EACH"
ending_beforedatetime

RFC 3339 timestamp (exclusive).

formatdate-time
frequencyliteral
Literal["MONTHLY", "QUARTERLY", "SEMI_ANNUAL", 2 more]
Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"SEMI_ANNUAL"
"ANNUAL"
"WEEKLY"
starting_atdatetime

RFC 3339 timestamp (inclusive).

formatdate-time
amountfloat
optional

Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.

quantityfloat
optional

Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.

unit_pricefloat
optional

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

schedule_itemslist
optional
Optional[List[DataUpdateDiscountScheduleScheduleItem]]

Either provide amount or provide both unit_price and quantity.

Hide ParametersShow Parameters
timestampdatetime

timestamp of the scheduled event

formatdate-time
amountfloat
optional

Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.

quantityfloat
optional

Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.

unit_pricefloat
optional

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

update_prepaid_balance_threshold_configurationcommitDataUpdatePrepaidBalanceThresholdConfigurationCommitcustom_credit_type_idstris_enabledboolpayment_gate_configDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigrecharge_to_amountfloatthreshold_amountfloatDataUpdatePrepaidBalanceThresholdConfiguration
optional
Hide ParametersShow Parameters
commitapplicable_product_idslistapplicable_product_tagslistdescriptionstrnamestrproduct_idstrspecifierslistDataUpdatePrepaidBalanceThresholdConfigurationCommit
optional
Hide ParametersShow Parameters
applicable_product_idslist
optional
Optional[List[str]]

Which products the threshold commit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the commit applies to all products.

applicable_product_tagslist
optional
Optional[List[str]]

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

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.

product_idstr
optional

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

specifierslist
optional
Optional[List[DataUpdatePrepaidBalanceThresholdConfigurationCommitSpecifier]]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with applicable_product_ids or applicable_product_tags. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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

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

formatuuid
product_tagslist
optional
Optional[List[str]]

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

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

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_configDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigstripe_configDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigtax_typeliteralDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfig
optional
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_namestrDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig
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]DataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfig
optional

Only applicable if using STRIPE as your payment gateway type.

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

If left blank, will default to INVOICE

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

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

tax_typeliteral
optional
Optional[Literal["NONE", "STRIPE", "ANROK", "PRECALCULATED"]]

Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.

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

Specify the amount the balance should be recharged to.

threshold_amountfloat
optional

Specify the threshold amount for the contract. Each time the contract's balance lowers to this amount, a threshold charge will be initiated.

update_recurring_commitslist
optional
Optional[List[DataUpdateRecurringCommit]]
Hide ParametersShow Parameters
idstr
formatuuid
access_amountquantityfloatunit_pricefloatDataUpdateRecurringCommitAccessAmount
optional
Hide ParametersShow Parameters
quantityfloat
optional
unit_pricefloat
optional
ending_beforedatetime
optional
formatdate-time
invoice_amountquantityfloatunit_pricefloatDataUpdateRecurringCommitInvoiceAmount
optional
Hide ParametersShow Parameters
quantityfloat
optional
unit_pricefloat
optional
update_recurring_creditslist
optional
Optional[List[DataUpdateRecurringCredit]]
Hide ParametersShow Parameters
idstr
formatuuid
access_amountquantityfloatunit_pricefloatDataUpdateRecurringCreditAccessAmount
optional
Hide ParametersShow Parameters
quantityfloat
optional
unit_pricefloat
optional
ending_beforedatetime
optional
formatdate-time
update_refund_invoiceslist
optional
Optional[List[DataUpdateRefundInvoice]]
Hide ParametersShow Parameters
datedatetime
formatdate-time
invoice_idstr
formatuuid
update_scheduled_chargeslist
optional
Optional[List[DataUpdateScheduledCharge]]
Hide ParametersShow Parameters
idstr
formatuuid
invoice_scheduleadd_schedule_itemslistremove_schedule_itemslistupdate_schedule_itemslistDataUpdateScheduledChargeInvoiceSchedule
optional
Hide ParametersShow Parameters
add_schedule_itemslist
optional
Optional[List[DataUpdateScheduledChargeInvoiceScheduleAddScheduleItem]]
Hide ParametersShow Parameters
timestampdatetime
formatdate-time
amountfloat
optional
quantityfloat
optional
unit_pricefloat
optional
remove_schedule_itemslist
optional
Optional[List[DataUpdateScheduledChargeInvoiceScheduleRemoveScheduleItem]]
Hide ParametersShow Parameters
idstr
formatuuid
update_schedule_itemslist
optional
Optional[List[DataUpdateScheduledChargeInvoiceScheduleUpdateScheduleItem]]
Hide ParametersShow Parameters
idstr
formatuuid
amountfloat
optional
quantityfloat
optional
timestampdatetime
optional
formatdate-time
unit_pricefloat
optional
namestr
optional
netsuite_sales_order_idstr
optional
update_spend_threshold_configurationcommitDataUpdateSpendThresholdConfigurationCommitis_enabledboolpayment_gate_configDataUpdateSpendThresholdConfigurationPaymentGateConfigthreshold_amountfloatDataUpdateSpendThresholdConfiguration
optional
Hide ParametersShow Parameters
commitdescriptionstrnamestrproduct_idstrDataUpdateSpendThresholdConfigurationCommit
optional
Hide ParametersShow Parameters
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.

product_idstr
optional

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

is_enabledbool
optional

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_configDataUpdateSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigstripe_configDataUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigtax_typeliteralDataUpdateSpendThresholdConfigurationPaymentGateConfig
optional
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_namestrDataUpdateSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig
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]DataUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfig
optional

Only applicable if using STRIPE as your payment gateway type.

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

If left blank, will default to INVOICE

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

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

tax_typeliteral
optional
Optional[Literal["NONE", "STRIPE", "ANROK", "PRECALCULATED"]]

Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.

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

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

update_subscriptionslist
optional
Optional[List[DataUpdateSubscription]]

Optional list of subscriptions to update.

Hide ParametersShow Parameters
idstr
formatuuid
ending_beforedatetime
optional
formatdate-time
quantity_updateslist
optional
Optional[List[DataUpdateSubscriptionQuantityUpdate]]
Hide ParametersShow Parameters
starting_atdatetime
formatdate-time
quantityfloat
optional
quantity_deltafloat
optional
from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
response = client.v2.contracts.get_edit_history(
    contract_id="d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
    customer_id="13117714-3f05-48e5-a6e9-a66093f13b4d",
)
print(response.data)
200 Example
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "add_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_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "description": "description",
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "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"
              }
            ]
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "priority": 0,
          "rate_type": "COMMIT_RATE",
          "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"
              ]
            }
          ]
        }
      ],
      "add_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_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "description": "description",
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "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"
              ]
            }
          ]
        }
      ],
      "add_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"
        }
      ],
      "add_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"
        }
      ],
      "add_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"
      },
      "add_pro_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"
        }
      ],
      "add_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"
          }
        }
      ],
      "add_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"
          }
        }
      ],
      "add_reseller_royalties": [
        {
          "reseller_type": "AWS",
          "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",
          "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"
        }
      ],
      "add_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"
              }
            ]
          },
          "name": "x",
          "netsuite_sales_order_id": "netsuite_sales_order_id"
        }
      ],
      "add_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
      },
      "add_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"
        }
      ],
      "add_usage_filters": [
        {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z",
          "ending_before": "2019-12-27T18:11:19.117Z"
        }
      ],
      "archive_commits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "archive_credits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "archive_scheduled_charges": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "remove_overrides": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "timestamp": "2019-12-27T18:11:19.117Z",
      "update_commits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_schedule": {
            "add_schedule_items": [
              {
                "amount": 0,
                "ending_before": "2019-12-27T18:11:19.117Z",
                "starting_at": "2019-12-27T18:11:19.117Z"
              }
            ],
            "remove_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ],
            "update_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"
              }
            ]
          },
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "invoice_schedule": {
            "add_schedule_items": [
              {
                "timestamp": "2019-12-27T18:11:19.117Z",
                "amount": 0,
                "quantity": 0,
                "unit_price": 0
              }
            ],
            "remove_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ],
            "update_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "quantity": 0,
                "timestamp": "2019-12-27T18:11:19.117Z",
                "unit_price": 0
              }
            ]
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "priority": 0,
          "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "rollover_fraction": 0,
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ]
        }
      ],
      "update_contract_end_date": "2019-12-27T18:11:19.117Z",
      "update_contract_name": "update_contract_name",
      "update_credits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_schedule": {
            "add_schedule_items": [
              {
                "amount": 0,
                "ending_before": "2019-12-27T18:11:19.117Z",
                "starting_at": "2019-12-27T18:11:19.117Z"
              }
            ],
            "remove_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ],
            "update_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"
              }
            ]
          },
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "priority": 0,
          "rollover_fraction": 0
        }
      ],
      "update_discounts": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "custom_fields": {
            "foo": "string"
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "schedule": {
            "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "do_not_invoice": true,
            "recurring_schedule": {
              "amount_distribution": "DIVIDED",
              "ending_before": "2019-12-27T18:11:19.117Z",
              "frequency": "MONTHLY",
              "starting_at": "2019-12-27T18:11:19.117Z",
              "amount": 0,
              "quantity": 0,
              "unit_price": 0
            },
            "schedule_items": [
              {
                "timestamp": "2019-12-27T18:11:19.117Z",
                "amount": 0,
                "quantity": 0,
                "unit_price": 0
              }
            ]
          }
        }
      ],
      "update_prepaid_balance_threshold_configuration": {
        "commit": {
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "description": "description",
          "name": "name",
          "product_id": "product_id",
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ]
        },
        "custom_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "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
      },
      "update_recurring_commits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_amount": {
            "quantity": 0,
            "unit_price": 0
          },
          "ending_before": "2019-12-27T18:11:19.117Z",
          "invoice_amount": {
            "quantity": 0,
            "unit_price": 0
          }
        }
      ],
      "update_recurring_credits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_amount": {
            "quantity": 0,
            "unit_price": 0
          },
          "ending_before": "2019-12-27T18:11:19.117Z"
        }
      ],
      "update_refund_invoices": [
        {
          "date": "2019-12-27T18:11:19.117Z",
          "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "update_scheduled_charges": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "invoice_schedule": {
            "add_schedule_items": [
              {
                "timestamp": "2019-12-27T18:11:19.117Z",
                "amount": 0,
                "quantity": 0,
                "unit_price": 0
              }
            ],
            "remove_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ],
            "update_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "quantity": 0,
                "timestamp": "2019-12-27T18:11:19.117Z",
                "unit_price": 0
              }
            ]
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id"
        }
      ],
      "update_spend_threshold_configuration": {
        "commit": {
          "description": "description",
          "name": "name",
          "product_id": "product_id"
        },
        "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
      },
      "update_subscriptions": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "ending_before": "2019-12-27T18:11:19.117Z",
          "quantity_updates": [
            {
              "starting_at": "2019-12-27T18:11:19.117Z",
              "quantity": 0,
              "quantity_delta": 0
            }
          ]
        }
      ]
    }
  ]
}