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

Contracts

API Reference
V1

Contracts

Contracts

Add a manual balance entry
post/v1/contracts/addManualBalanceLedgerEntry
Amend a contract
post/v1/contracts/amend
Archive a contract
post/v1/contracts/archive
Create a contract
post/v1/contracts/create
Create historical invoices
post/v1/contracts/createHistoricalInvoices
List customer contracts (v1)
post/v1/contracts/list
List balances
post/v1/contracts/customerBalances/list
Get a contract (v1)
post/v1/contracts/get
Get the rate schedule for a contract
post/v1/contracts/getContractRateSchedule
Get subscription quantity history
post/v1/contracts/getSubscriptionQuantityHistory
Schedule ProService invoice
post/v1/contracts/scheduleProServicesInvoice
Set a contract usage filter
post/v1/contracts/setUsageFilter
Update the contract end date
post/v1/contracts/updateEndDate

ContractsNamed Schedules

Get a rate card's named schedule
post/v1/contract-pricing/rate-cards/getNamedSchedule
Update a rate card's named schedule
post/v1/contract-pricing/rate-cards/updateNamedSchedule

ContractsProducts

Archive a product
post/v1/contract-pricing/products/archive
Create a product
post/v1/contract-pricing/products/create
List products
post/v1/contract-pricing/products/list
Get a product
post/v1/contract-pricing/products/get
Update a product
post/v1/contract-pricing/products/update
Product List Item State
ProductListItemStateobject
ShowShow
created_atstring
formatdate-time
created_bystring
namestring
billable_metric_idstring
optional
composite_product_idsarray of string
optional
composite_tagsarray of string
optional
exclude_free_usageboolean
optional
is_refundableboolean
optional

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

netsuite_internal_item_idstring
optional

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

netsuite_overage_item_idstring
optional

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

presentation_group_keyarray of string
optional

For USAGE products only. Groups usage line items on invoices. The superset of values in the pricing group key and presentation group key must be set as one compound group key on the billable metric.

pricing_group_keyarray of string
optional

For USAGE products only. If set, pricing for this product will be determined for each pricing_group_key value, as opposed to the product as a whole. The superset of values in the pricing group key and presentation group key must be set as one compound group key on the billable metric.

quantity_conversionconversion_factornumberoperationenumnamestringQuantityConversion
optional

Optional. Only valid for USAGE products. If provided, the quantity will be converted using the provided conversion factor and operation. For example, if the operation is "multiply" and the conversion factor is 100, then the quantity will be multiplied by 100. This can be used in cases where data is sent in one unit and priced in another. For example, data could be sent in MB and priced in GB. In this case, the conversion factor would be 1024 and the operation would be "divide".

quantity_roundingdecimal_placesnumberrounding_methodenumQuantityRounding
optional

Optional. Only valid for USAGE products. If provided, the quantity will be rounded using the provided rounding method and decimal places. For example, if the method is "round up" and the decimal places is 0, then the quantity will be rounded up to the nearest integer.

starting_atstring
optional
formatdate-time
tagsarray of string
optional
Quantity Conversion
QuantityConversionobject

Optional. Only valid for USAGE products. If provided, the quantity will be converted using the provided conversion factor and operation. For example, if the operation is "multiply" and the conversion factor is 100, then the quantity will be multiplied by 100. This can be used in cases where data is sent in one unit and priced in another. For example, data could be sent in MB and priced in GB. In this case, the conversion factor would be 1024 and the operation would be "divide".

ShowShow
conversion_factornumber

The factor to multiply or divide the quantity by.

operationenum
"MULTIPLY" OR "DIVIDE"

The operation to perform on the quantity

Hide ParametersShow Parameters
"MULTIPLY"
"DIVIDE"
namestring
optional

Optional name for this conversion.

Quantity Rounding
QuantityRoundingobject

Optional. Only valid for USAGE products. If provided, the quantity will be rounded using the provided rounding method and decimal places. For example, if the method is "round up" and the decimal places is 0, then the quantity will be rounded up to the nearest integer.

ShowShow
decimal_placesnumber
minimum0
rounding_methodenum
"ROUND_UP" OR "ROUND_DOWN" OR "ROUND_HALF_UP"
Hide ParametersShow Parameters
"ROUND_UP"
"ROUND_DOWN"
"ROUND_HALF_UP"

ContractsRate Cards

Archive a rate card
post/v1/contract-pricing/rate-cards/archive
Create a rate card
post/v1/contract-pricing/rate-cards/create
List rate cards
post/v1/contract-pricing/rate-cards/list
Get a rate card
post/v1/contract-pricing/rate-cards/get
Get a rate schedule
post/v1/contract-pricing/rate-cards/getRateSchedule
Update a rate card
post/v1/contract-pricing/rate-cards/update

ContractsRate CardsNamed Schedules

Get a contract's named schedule
post/v1/contracts/getNamedSchedule
Update a contract's named schedule
post/v1/contracts/updateNamedSchedule

ContractsRate CardsProduct Orders

Set the rate card products order
post/v1/contract-pricing/rate-cards/setRateCardProductsOrder
Update the rate card products order
post/v1/contract-pricing/rate-cards/moveRateCardProducts

ContractsRate CardsRates

Add a rate
post/v1/contract-pricing/rate-cards/addRate
Add rates
post/v1/contract-pricing/rate-cards/addRates
Get rates
post/v1/contract-pricing/rate-cards/getRates