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

Shared

API Reference

Shared

Shared

Base Usage Filter
BaseUsageFilterclass
ShowShow
group_keystr
group_valueslist
List[str]
starting_atdatetime
optional
formatdate-time
Commit
Commitclass
ShowShow
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
Contract Without Amendments
ContractWithoutAmendmentsclass
ShowShow
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
transitionslist
List[Transition]
Hide ParametersShow Parameters
from_contract_idstr
formatuuid
to_contract_idstr
formatuuid
typeliteral
Literal["SUPERSEDE", "RENEWAL"]
Hide ParametersShow Parameters
"SUPERSEDE"
"RENEWAL"
usage_statement_schedulebilling_anchor_datedatetimefrequencyliteralUsageStatementSchedule
Hide ParametersShow Parameters
billing_anchor_datedatetime

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

formatdate-time
frequencyliteral
Literal["MONTHLY", "QUARTERLY", "ANNUAL", "WEEKLY"]
Hide ParametersShow Parameters
"MONTHLY"
"QUARTERLY"
"ANNUAL"
"WEEKLY"
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.

ending_beforedatetime
optional
formatdate-time
hierarchy_configurationHierarchyConfiguration
optional

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

Hide ParametersShow Parameters
HierarchyConfigurationParentHierarchyConfigurationclass
Hide ParametersShow Parameters
childrenlist
List[HierarchyConfigurationParentHierarchyConfigurationChild]

List of contracts that belong to this parent.

Hide ParametersShow Parameters
contract_idstr
formatuuid
customer_idstr
formatuuid
HierarchyConfigurationChildHierarchyConfigurationclass
Hide ParametersShow Parameters
parentcontract_idstrcustomer_idstrHierarchyConfigurationChildHierarchyConfigurationParent

The single parent contract/customer for this child.

Hide ParametersShow Parameters
contract_idstr
formatuuid
customer_idstr
formatuuid
namestr
optional
net_payment_terms_daysfloat
optional
netsuite_sales_order_idstr
optional

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

prepaid_balance_threshold_configurationcommitPrepaidBalanceThresholdConfigurationCommitis_enabledboolpayment_gate_configPrepaidBalanceThresholdConfigurationPaymentGateConfigrecharge_to_amountfloatthreshold_amountfloatcustom_credit_type_idstrPrepaidBalanceThresholdConfiguration
optional
Hide ParametersShow Parameters
commitproduct_idstrapplicable_product_idslistapplicable_product_tagslistdescriptionstrnamestrspecifierslistPrepaidBalanceThresholdConfigurationCommit
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[PrepaidBalanceThresholdConfigurationCommitSpecifier]]

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_configPrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigstripe_configPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigtax_typeliteralPrepaidBalanceThresholdConfigurationPaymentGateConfig
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_namestrPrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig
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]PrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfig
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
professional_serviceslist
optional
Optional[List[idstrmax_amountfloatproduct_idstrquantityfloatunit_pricefloatcustom_fieldsDict[str, str]descriptionstrnetsuite_sales_order_idstrProService]]

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

Hide ParametersShow Parameters
idstr
formatuuid
max_amountfloat

Maximum amount for the term.

product_idstr
formatuuid
quantityfloat

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

unit_pricefloat

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

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

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

rate_card_idstr
optional
formatuuid
recurring_commitslist
optional
Optional[List[RecurringCommit]]
Hide ParametersShow Parameters
idstr
formatuuid
access_amountcredit_type_idstrunit_pricefloatquantityfloatRecurringCommitAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters
credit_type_idstr
formatuuid
unit_pricefloat
quantityfloat
optional
commit_durationvaluefloatunitliteralRecurringCommitCommitDuration

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

productidstrnamestrRecurringCommitProduct
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

contractidstrRecurringCommitContract
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_accessRecurringCommitHierarchyConfigurationChildAccessRecurringCommitHierarchyConfiguration
optional

Optional configuration for recurring commit/credit hierarchy access control

Hide ParametersShow Parameters
child_accessRecurringCommitHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
RecurringCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
RecurringCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
RecurringCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idslist
List[str]
typeliteral
Literal["CONTRACT_IDS"]
Hide ParametersShow Parameters
"CONTRACT_IDS"
invoice_amountcredit_type_idstrquantityfloatunit_pricefloatRecurringCommitInvoiceAmount
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[RecurringCommitSpecifier]]

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_configRecurringCommitSubscriptionConfigApplySeatIncreaseConfigsubscription_idstrRecurringCommitSubscriptionConfig
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_proratedboolRecurringCommitSubscriptionConfigApplySeatIncreaseConfig
Hide ParametersShow Parameters
is_proratedbool

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

subscription_idstr
formatuuid
recurring_creditslist
optional
Optional[List[RecurringCredit]]
Hide ParametersShow Parameters
idstr
formatuuid
access_amountcredit_type_idstrunit_pricefloatquantityfloatRecurringCreditAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters
credit_type_idstr
formatuuid
unit_pricefloat
quantityfloat
optional
commit_durationvaluefloatunitliteralRecurringCreditCommitDuration

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

productidstrnamestrRecurringCreditProduct
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

contractidstrRecurringCreditContract
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_accessRecurringCreditHierarchyConfigurationChildAccessRecurringCreditHierarchyConfiguration
optional

Optional configuration for recurring commit/credit hierarchy access control

Hide ParametersShow Parameters
child_accessRecurringCreditHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
RecurringCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeliteral
Literal["ALL"]
Hide ParametersShow Parameters
"ALL"
RecurringCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeliteral
Literal["NONE"]
Hide ParametersShow Parameters
"NONE"
RecurringCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsclass
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[RecurringCreditSpecifier]]

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_configRecurringCreditSubscriptionConfigApplySeatIncreaseConfigsubscription_idstrRecurringCreditSubscriptionConfig
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_proratedboolRecurringCreditSubscriptionConfigApplySeatIncreaseConfig
Hide ParametersShow Parameters
is_proratedbool

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

subscription_idstr
formatuuid
reseller_royaltieslist
optional
Optional[List[ResellerRoyalty]]

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

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

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

scheduled_charges_on_usage_invoicesliteral
optional
Optional[Literal["ALL"]]

Determines which scheduled and commit charges to consolidate onto the Contract's usage invoice. The charge's timestamp must match the usage invoice's ending_before date for consolidation to occur. This field cannot be modified after a Contract has been created. If this field is omitted, charges will appear on a separate invoice from usage charges.

Hide ParametersShow Parameters
"ALL"
spend_threshold_configurationcommitSpendThresholdConfigurationCommitis_enabledboolpayment_gate_configSpendThresholdConfigurationPaymentGateConfigthreshold_amountfloatSpendThresholdConfiguration
optional
Hide ParametersShow Parameters
commitproduct_idstrdescriptionstrnamestrSpendThresholdConfigurationCommit
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_configSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigstripe_configSpendThresholdConfigurationPaymentGateConfigStripeConfigtax_typeliteralSpendThresholdConfigurationPaymentGateConfig
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_namestrSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig
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]SpendThresholdConfigurationPaymentGateConfigStripeConfig
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.

total_contract_valuefloat
optional

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

usage_filtercurrentBaseUsageFilterinitialBaseUsageFilterupdateslistUsageFilter
optional
Hide ParametersShow Parameters
currentBaseUsageFilter
initialgroup_keystrgroup_valuesliststarting_atdatetimeBaseUsageFilter
updateslist
List[UsageFilterUpdate]
Hide ParametersShow Parameters
group_keystr
group_valueslist
List[str]
starting_atdatetime
formatdate-time
Credit
Creditclass
ShowShow
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
Credit Type Data
CreditTypeDataclass
ShowShow
idstr
formatuuid
namestr
Discount
Discountclass
ShowShow
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.

Event Type Filter
EventTypeFilterclass

An optional filtering rule to match the 'event_type' property of an event.

ShowShow
in_valueslist
optional
Optional[List[str]]

A list of event types that are explicitly included in the billable metric. If specified, only events of these types will match the billable metric. Must be non-empty if present.

not_in_valueslist
optional
Optional[List[str]]

A list of event types that are explicitly excluded from the billable metric. If specified, events of these types will not match the billable metric. Must be non-empty if present.

ID
IDclass
ShowShow
idstr
formatuuid
Override
Overrideclass
ShowShow
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.

Property Filter
PropertyFilterclass
ShowShow
namestr

The name of the event property.

existsbool
optional

Determines whether the property must exist in the event. If true, only events with this property will pass the filter. If false, only events without this property will pass the filter. If null or omitted, the existence of the property is optional.

in_valueslist
optional
Optional[List[str]]

Specifies the allowed values for the property to match an event. An event will pass the filter only if its property value is included in this list. If undefined, all property values will pass the filter. Must be non-empty if present.

not_in_valueslist
optional
Optional[List[str]]

Specifies the values that prevent an event from matching the filter. An event will not pass the filter if its property value is included in this list. If null or empty, all property values will pass the filter. Must be non-empty if present.

Pro Service
ProServiceclass
ShowShow
idstr
formatuuid
max_amountfloat

Maximum amount for the term.

product_idstr
formatuuid
quantityfloat

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

unit_pricefloat

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

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

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

Rate
Rateclass
ShowShow
rate_typeliteral
Literal["FLAT", "PERCENTAGE", "SUBSCRIPTION", 2 more]
Hide ParametersShow Parameters
"FLAT"
"PERCENTAGE"
"SUBSCRIPTION"
"CUSTOM"
"TIERED"
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.

pricing_group_valuesDict[str, str]
optional
Optional[Dict[str, str]]

if pricing groups are used, this will contain the values used to calculate the price

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

Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed using list prices rather than the standard rates for this product on the contract.

Scheduled Charge
ScheduledChargeclass
ShowShow
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.

Schedule Duration
ScheduleDurationclass
ShowShow
schedule_itemslist
List[ScheduleItem]
Hide ParametersShow Parameters
idstr
formatuuid
amountfloat
ending_beforedatetime
formatdate-time
starting_atdatetime
formatdate-time
credit_typeCreditTypeData
optional
Schedule Point In Time
SchedulePointInTimeclass
ShowShow
credit_typeCreditTypeData
optional
do_not_invoicebool
optional

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

schedule_itemslist
optional
Optional[List[ScheduleItem]]
Hide ParametersShow Parameters
idstr
formatuuid
amountfloat
quantityfloat
timestampdatetime
formatdate-time
unit_pricefloat
invoice_idstr
optional
formatuuid
Tier
Tierclass
ShowShow
pricefloat
sizefloat
optional