Amend
Amend a contract
Amendments will be replaced by Contract editing. New clients should implement using the editContract endpoint. Read more about the migration to contract editing here and reach out to your Metronome representative for more details. Once contract editing is enabled, access to this endpoint will be removed.
Parameters
ID of the contract to amend
ID of the customer whose contract is to be amended
inclusive start time for the amendment
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.
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
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.
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
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.
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
Use null to indicate that the existing end timestamp should be removed.
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.
This field's availability is dependent on your client's configuration.
Returns
Hide ParametersShow Parameters
from datetime import datetime
from metronome import Metronome
client = Metronome(
bearer_token="My Bearer Token",
)
response = client.v1.contracts.amend(
contract_id="d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
customer_id="13117714-3f05-48e5-a6e9-a66093f13b4d",
starting_at=datetime.fromisoformat("2020-01-01T00:00:00.000"),
)
print(response.data)
{
"data": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
}