Create
Create a contract
Create a new contract
Body Parameters
inclusive contract start time
The billing provider configuration associated with a contract. Provide either an ID or the provider and delivery method.
Hide ParametersShow Parameters
Do not specify if using billing_provider_configuration_id.
Hide ParametersShow Parameters
The Metronome ID of the billing provider configuration. Use when a customer has multiple configurations with the same billing provider and delivery method. Otherwise, specify the billing_provider and delivery_method.
Do not specify if using billing_provider_configuration_id.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Required: Schedule for distributing the commit to the customer. For "POSTPAID" commits only one schedule item is allowed and amount must match invoice_schedule total.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
RFC 3339 timestamp (exclusive)
RFC 3339 timestamp (inclusive)
Defaults to USD (cents) if not passed
(DEPRECATED) Use access_schedule and invoice_schedule instead.
Which products the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.
Which tags the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.
Used only in UI/API. It is not exposed to end customers.
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
Required for "POSTPAID" commits: the true up invoice will be generated at this time and only one schedule item is allowed; the total must match access_schedule amount. Optional for "PREPAID" commits: if not provided, this will be a "complimentary" commit with no invoice.
Hide ParametersShow Parameters
Defaults to USD (cents) if not passed.
This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice.
Enter the unit price and quantity for the charge or instead only send the amount. If amount is sent, the unit price is assumed to be the amount and quantity is inferred to be 1.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
RFC 3339 timestamp (exclusive).
Hide ParametersShow Parameters
RFC 3339 timestamp (inclusive).
Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.
Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.
Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified with quantity. If specified amount cannot be provided.
Either provide amount or provide both unit_price and quantity.
Hide ParametersShow Parameters
timestamp of the scheduled event
Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.
Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.
Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified with quantity. If specified amount cannot be provided.
displayed on invoices
This field's availability is dependent on your client's configuration.
optionally payment gate this commit
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
If multiple commits are applicable, the one with the lower priority will apply first.
Hide ParametersShow Parameters
Fraction of unused segments that will be rolled over. 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. 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.
A temporary ID for the commit that can be used to reference the commit for commit specific overrides.
Hide ParametersShow Parameters
Schedule for distributing the credit to the customer.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
RFC 3339 timestamp (exclusive)
RFC 3339 timestamp (inclusive)
Defaults to USD (cents) if not passed
Which products the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit applies to all products.
Which tags the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit applies to all products.
Used only in UI/API. It is not exposed to end customers.
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
displayed on invoices
This field's availability is dependent on your client's configuration.
If multiple credits are applicable, the one with the lower priority will apply first.
Hide ParametersShow Parameters
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.
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
Must provide either schedule_items or recurring_schedule.
Hide ParametersShow Parameters
Defaults to USD (cents) if not passed.
This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice.
Enter the unit price and quantity for the charge or instead only send the amount. If amount is sent, the unit price is assumed to be the amount and quantity is inferred to be 1.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
RFC 3339 timestamp (exclusive).
Hide ParametersShow Parameters
RFC 3339 timestamp (inclusive).
Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.
Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.
Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified with quantity. If specified amount cannot be provided.
Either provide amount or provide both unit_price and quantity.
Hide ParametersShow Parameters
timestamp of the scheduled event
Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.
Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.
Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified with quantity. If specified amount cannot be provided.
displayed on invoices
This field's availability is dependent on your client's configuration.
exclusive contract end time
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list prices automatically. EXPLICIT prioritization requires specifying priorities for each multiplier; the one with the lowest priority value will be prioritized first. If tiered overrides are used, prioritization must be explicit.
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
RFC 3339 timestamp indicating when the override will start applying (inclusive)
tags identifying products whose rates are being overridden. Cannot be used in conjunction with override_specifiers.
RFC 3339 timestamp indicating when the override will stop applying (exclusive)
Indicates whether the override should only apply to commits. Defaults to false. If true, you can specify relevant commits in override_specifiers by passing commit_ids. if you do not specify commit_ids, then the override will apply when consuming any prepaid or postpaid commit.
Required for MULTIPLIER type. Must be >=0.
Cannot be used in conjunction with product_id or applicable_product_tags. If provided, the override will apply to all products with the specified specifiers.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Can only be used for commit specific overrides. Must be used in conjunction with one of product_id, product_tags, pricing_group_values, or presentation_group_values. If provided, the override will only apply to the specified commits. If not provided, the override will apply to all commits.
A map of group names to values. The override will only apply to line items with the specified presentation group values.
A map of pricing group names to values. The override will only apply to products with the specified pricing group values.
If provided, the override will only apply to the product with the specified ID.
If provided, the override will only apply to products with all the specified tags.
Can only be used for commit specific overrides. Must be used in conjunction with one of product_id, product_tags, pricing_group_values, or presentation_group_values. If provided, the override will only apply to commits created by the specified recurring commit ids.
Can only be used for commit specific overrides. Must be used in conjunction with one of product_id, product_tags, pricing_group_values, or presentation_group_values. If provided, the override will only apply to credits created by the specified recurring credit ids.
Required for OVERWRITE type.
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.
Only set for TIERED rate_type.
Required for EXPLICIT multiplier prioritization scheme and all TIERED overrides. Under EXPLICIT prioritization, overwrites are prioritized first, and then tiered and multiplier overrides are prioritized by their priority value (lowest first). Must be > 0.
ID of the product whose rate is being overridden. Cannot be used in conjunction with override_specifiers.
Indicates whether the override applies to commit rates or list rates. Can only be used for overrides that have is_commit_specific set to true. Defaults to "LIST_RATE".
Hide ParametersShow Parameters
Required for TIERED type. Must have at least one tier.
Hide ParametersShow Parameters
Overwrites are prioritized over multipliers and tiered overrides.
Hide ParametersShow Parameters
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.
Priority of the contract.
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.
Selects the rate card linked to the specified alias as of the contract's start date.
Hide ParametersShow Parameters
The amount of commit to grant.
Hide ParametersShow Parameters
This field is required unless a subscription is attached via subscription_config.
Defines the length of the access schedule for each created commit/credit. The value represents the number of units. Unit defaults to "PERIODS", where the length of a period is determined by the recurrence_frequency.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Will be passed down to the individual commits
determines the start time for the first commit
Will be passed down to the individual commits
Will be passed down to the individual commits
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
Whether the created commits will use the commit rate or list rate
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. 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.
Attach a subscription to the recurring commit/credit.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Indicates whether a mid-period seat increase should be prorated.
ID of the subscription to configure on the recurring commit/credit.
If set to POOLED, allocation added per seat is pooled across the account.
Hide ParametersShow Parameters
A temporary ID that can be used to reference the recurring commit for commit specific overrides.
Hide ParametersShow Parameters
The amount of commit to grant.
Hide ParametersShow Parameters
This field is required unless a subscription is attached via subscription_config.
Defines the length of the access schedule for each created commit/credit. The value represents the number of units. Unit defaults to "PERIODS", where the length of a period is determined by the recurrence_frequency.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Will be passed down to the individual commits
determines the start time for the first commit
Will be passed down to the individual commits
Will be passed down to the individual commits
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
Whether the created commits will use the commit rate or list rate
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. 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.
Attach a subscription to the recurring commit/credit.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Indicates whether a mid-period seat increase should be prorated.
ID of the subscription to configure on the recurring commit/credit.
If set to POOLED, allocation added per seat is pooled across the account.
Hide ParametersShow Parameters
A temporary ID that can be used to reference the recurring commit for commit specific overrides.
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Must provide at least one of applicable_product_ids or applicable_product_tags.
Must provide at least one of applicable_product_ids or applicable_product_tags.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
Must provide either schedule_items or recurring_schedule.
Hide ParametersShow Parameters
Defaults to USD (cents) if not passed.
This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice.
Enter the unit price and quantity for the charge or instead only send the amount. If amount is sent, the unit price is assumed to be the amount and quantity is inferred to be 1.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
RFC 3339 timestamp (exclusive).
Hide ParametersShow Parameters
RFC 3339 timestamp (inclusive).
Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.
Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.
Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified with quantity. If specified amount cannot be provided.
Either provide amount or provide both unit_price and quantity.
Hide ParametersShow Parameters
timestamp of the scheduled event
Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.
Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.
Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified with quantity. If specified amount cannot be provided.
displayed on invoices
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.
Optional list of subscriptions to add to the contract.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The initial quantity for the subscription. It must be non-negative value.
Hide ParametersShow Parameters
Indicates how mid-period quantity adjustments are invoiced.
BILL_IMMEDIATELY: Only available when collection schedule is ADVANCE. The quantity increase will be billed immediately on the scheduled date.
BILL_ON_NEXT_COLLECTION_DATE: The quantity increase will be billed for in-arrears at the end of the period.
Hide ParametersShow Parameters
Indicates if the partial period will be prorated or charged a full amount.
Hide ParametersShow Parameters
Frequency to bill subscription with. Together with product_id, must match existing rate on the rate card.
Hide ParametersShow Parameters
Must be subscription type product
Exclusive end time for the subscription. If not provided, subscription inherits contract end date.
Inclusive start time for the subscription. If not provided, defaults to contract start date
A temporary ID used to reference the subscription in recurring commit/credit subscription configs created within the same payload.
This field's availability is dependent on your client's configuration.
Hide ParametersShow Parameters
This field's available values may vary based on your client's configuration.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Controls whether future trueup invoices are billed or removed. Default behavior is AS_IS if not specified.
Hide ParametersShow Parameters
Prevents the creation of duplicates. If a request to create a record is made with a previously used uniqueness key, a new record will not be created and the request will fail with a 409 error.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Required when using CUSTOM_DATE. This option lets you set a historical billing anchor date, aligning future billing cycles with a chosen cadence. For example, if a contract starts on 2024-09-15 and you set the anchor date to 2024-09-10 with a MONTHLY frequency, the first usage statement will cover 09-15 to 10-10. Subsequent statements will follow the 10th of each month.
If not provided, defaults to the first day of the month.
Hide ParametersShow Parameters
The date Metronome should start generating usage invoices. If unspecified, contract start date will be used. This is useful to set if you want to import historical invoices via our 'Create Historical Invoices' API rather than having Metronome automatically generate them.
Returns
curl https://api.metronome.com/v1/contracts/create \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
-d '{
"customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d",
"starting_at": "2020-01-01T00:00:00.000Z"
}'
{
"data": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
}