Shared
Shared
Shared
Base Usage Filter
ShowShow
Commit
ShowShow
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The schedule that the customer will gain access to the credits purposed with this commit.
(DEPRECATED) Use access_schedule + invoice_schedule instead.
RFC 3339 timestamp indicating when the commit was archived. If not provided, the commit is not archived.
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.
Hide ParametersShow Parameters
Optional configuration for commit hierarchy access control
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The contract that this commit will be billed on.
Hide ParametersShow Parameters
The schedule that the customer will be invoiced for this commit.
A list of ordered events that impact the balance of a commit. For example, an invoice deduction or a rollover.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
If multiple credits or commits are applicable, the one with the lower priority will apply first.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
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
If provided, the specifier will only apply to the product with the specified ID.
If provided, the specifier will only apply to products with all the specified tags.
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.
Contract Without Amendments
ShowShow
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The schedule that the customer will gain access to the credits purposed with this commit.
(DEPRECATED) Use access_schedule + invoice_schedule instead.
RFC 3339 timestamp indicating when the commit was archived. If not provided, the commit is not archived.
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.
Hide ParametersShow Parameters
Optional configuration for commit hierarchy access control
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The contract that this commit will be billed on.
Hide ParametersShow Parameters
The schedule that the customer will be invoiced for this commit.
A list of ordered events that impact the balance of a commit. For example, an invoice deduction or a rollover.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
If multiple credits or commits are applicable, the one with the lower priority will apply first.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
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
If provided, the specifier will only apply to the product with the specified ID.
If provided, the specifier will only apply to products with all the specified tags.
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.
Hide ParametersShow Parameters
Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.
Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.
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.
Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
Hide ParametersShow Parameters
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.
Hide ParametersShow Parameters
Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
displayed on invoices
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Contract usage statements follow a selected cadence based on this date.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The schedule that the customer will gain access to the credits.
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.
Hide ParametersShow Parameters
Optional configuration for credit hierarchy access control
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
A list of ordered events that impact the balance of a credit. For example, an invoice deduction or an expiration.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
If multiple credits or commits are applicable, the one with the lower priority will apply first.
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
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
If provided, the specifier will only apply to the product with the specified ID.
If provided, the specifier will only apply to products with all the specified tags.
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.
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
Either a parent configuration with a list of children or a child configuration with a single parent.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The single parent contract/customer for this child.
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The commit product that will be used to generate the line item for commit payment.
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.
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.
Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.
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
If provided, the specifier will only apply to the product with the specified ID.
If provided, the specifier will only apply to products with all the specified tags.
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.
Hide ParametersShow Parameters
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
Only applicable if using PRECALCULATED as your tax type.
Hide ParametersShow Parameters
Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule
Name of the tax to be applied. This may be used in an invoice line item description.
Only applicable if using STRIPE as your payment gate type.
Hide ParametersShow Parameters
If left blank, will default to INVOICE
Hide ParametersShow Parameters
Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.
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
Specify the amount the balance should be recharged to.
Specify the threshold amount for the contract. Each time the contract's prepaid balance lowers to this amount, a threshold charge will be initiated.
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.
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
Maximum amount for the term.
Quantity for the charge. Will be multiplied by unit_price to determine the amount.
Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified.
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
The amount of commit to grant.
Hide ParametersShow Parameters
The amount of time the created commits will be valid for
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Will be passed down to the individual commits
Hide ParametersShow Parameters
Whether the created commits will use the commit rate or list rate
Hide ParametersShow Parameters
Determines the start time for the first commit
Will be passed down to the individual commits
Will be passed down to the individual commits
Hide ParametersShow Parameters
Will be passed down to the individual commits
Determines when the contract will stop creating recurring commits. Optional
Optional configuration for recurring commit/credit hierarchy access control
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The amount the customer should be billed for the commit. Not required.
Hide ParametersShow Parameters
Displayed on invoices. Will be passed through to the individual commits
Will be passed down to the individual commits
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
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
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.
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
If provided, the specifier will only apply to the product with the specified ID.
If provided, the specifier will only apply to products with all the specified tags.
Attach a subscription to the recurring commit/credit.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Indicates whether a mid-period seat increase should be prorated.
Hide ParametersShow Parameters
The amount of commit to grant.
Hide ParametersShow Parameters
The amount of time the created commits will be valid for
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Will be passed down to the individual commits
Hide ParametersShow Parameters
Whether the created commits will use the commit rate or list rate
Hide ParametersShow Parameters
Determines the start time for the first commit
Will be passed down to the individual commits
Will be passed down to the individual commits
Hide ParametersShow Parameters
Will be passed down to the individual commits
Determines when the contract will stop creating recurring commits. Optional
Optional configuration for recurring commit/credit hierarchy access control
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Displayed on invoices. Will be passed through to the individual commits
Will be passed down to the individual commits
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
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
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.
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
If provided, the specifier will only apply to the product with the specified ID.
If provided, the specifier will only apply to products with all the specified tags.
Attach a subscription to the recurring commit/credit.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Indicates whether a mid-period seat increase should be prorated.
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
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
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The commit product that will be used to generate the line item for commit payment.
Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.
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.
Hide ParametersShow Parameters
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
Only applicable if using PRECALCULATED as your tax type.
Hide ParametersShow Parameters
Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule
Name of the tax to be applied. This may be used in an invoice line item description.
Only applicable if using STRIPE as your payment gate type.
Hide ParametersShow Parameters
If left blank, will default to INVOICE
Hide ParametersShow Parameters
Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.
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
Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Credit
ShowShow
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The schedule that the customer will gain access to the credits.
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.
Hide ParametersShow Parameters
Optional configuration for credit hierarchy access control
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
A list of ordered events that impact the balance of a credit. For example, an invoice deduction or an expiration.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
If multiple credits or commits are applicable, the one with the lower priority will apply first.
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
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
If provided, the specifier will only apply to the product with the specified ID.
If provided, the specifier will only apply to products with all the specified tags.
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.
Credit Type Data
ShowShow
Discount
ShowShow
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
Event Type Filter
An optional filtering rule to match the 'event_type' property of an event.
ShowShow
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.
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
ShowShow
Override
ShowShow
Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.
Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.
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.
Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
Hide ParametersShow Parameters
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.
Hide ParametersShow Parameters
Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.
Property Filter
ShowShow
The name of the event property.
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.
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.
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
ShowShow
Maximum amount for the term.
Quantity for the charge. Will be multiplied by unit_price to determine the amount.
Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified.
This field's availability is dependent on your client's configuration.
Rate
ShowShow
Hide ParametersShow Parameters
Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.
Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.
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.
if pricing groups are used, this will contain the values used to calculate the price
Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
Hide ParametersShow Parameters
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
ShowShow
Hide ParametersShow Parameters
displayed on invoices
This field's availability is dependent on your client's configuration.
Schedule Duration
ShowShow
Hide ParametersShow Parameters
Schedule Point In Time
ShowShow
This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice.