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

Amend

API Reference
V1
Contracts
Amend a contract
v1.contracts.amend(**kwargs) -> dataIDContractAmendResponse
post/v1/contracts/amend

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
contract_idString

ID of the contract to amend

formatuuid
customer_idString

ID of the customer whose contract is to be amended

formatuuid
starting_atTime

inclusive start time for the amendment

formatdate-time
commitsarray
optional
Array[{ product_id, type, access_schedule, 15 more}]
Hide ParametersShow Parameters
product_idString
formatuuid
typeunion
:PREPAID | :POSTPAID
Hide ParametersShow Parameters
:PREPAID
:POSTPAID
access_scheduleobject
optional
{ schedule_items, credit_type_id}

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
schedule_itemsarray
Array[{ amount, ending_before, starting_at}]
Hide ParametersShow Parameters
amountFloat
ending_beforeTime

RFC 3339 timestamp (exclusive)

formatdate-time
starting_atTime

RFC 3339 timestamp (inclusive)

formatdate-time
credit_type_idString
optional

Defaults to USD (cents) if not passed

formatuuid
amountFloat
optional

(DEPRECATED) Use access_schedule and invoice_schedule instead.

applicable_product_idsarray
optional
Array[String]

Which products the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.

applicable_product_tagsarray
optional
Array[String]

Which tags the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.

custom_fieldshash
optional
Hash[Symbol, String]
descriptionString
optional

Used only in UI/API. It is not exposed to end customers.

hierarchy_configurationobject
optional
{ child_access}

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters
child_accessunion
{ type} | { type} | { contract_ids, type}
Hide ParametersShow Parameters
CommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeunion
:ALL
Hide ParametersShow Parameters
:ALL
CommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeunion
:NONE
Hide ParametersShow Parameters
:NONE
CommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idsarray
Array[String]
typeunion
:CONTRACT_IDS
Hide ParametersShow Parameters
:CONTRACT_IDS
invoice_scheduleobject
optional
{ credit_type_id, do_not_invoice, recurring_schedule, schedule_items}

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

Defaults to USD (cents) if not passed.

formatuuid
do_not_invoicebool
optional

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

recurring_scheduleobject
optional
{ amount_distribution, ending_before, frequency, 4 more}

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
amount_distributionunion
:DIVIDED | :DIVIDED_ROUNDED | :EACH
Hide ParametersShow Parameters
:DIVIDED
:DIVIDED_ROUNDED
:EACH
ending_beforeTime

RFC 3339 timestamp (exclusive).

formatdate-time
frequencyunion
:MONTHLY | :QUARTERLY | :SEMI_ANNUAL | :ANNUAL
Hide ParametersShow Parameters
:MONTHLY
:QUARTERLY
:SEMI_ANNUAL
:ANNUAL
starting_atTime

RFC 3339 timestamp (inclusive).

formatdate-time
amountFloat
optional

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.

quantityFloat
optional

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

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.

schedule_itemsarray
optional
Array[{ timestamp, amount, quantity, unit_price}]

Either provide amount or provide both unit_price and quantity.

Hide ParametersShow Parameters
timestampTime

timestamp of the scheduled event

formatdate-time
amountFloat
optional

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.

quantityFloat
optional

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

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.

nameString
optional

displayed on invoices

minLength1
netsuite_sales_order_idString
optional

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

payment_gate_configobject
optional
{ payment_gate_type, precalculated_tax_config, stripe_config, tax_type}

optionally payment gate this commit

Hide ParametersShow Parameters
payment_gate_typeunion
: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_configobject
optional
{ tax_amount, tax_name}

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

Name of the tax to be applied. This may be used in an invoice line item description.

stripe_configobject
optional
{ payment_type, invoice_metadata}

Only applicable if using STRIPE as your payment gate type.

Hide ParametersShow Parameters
payment_typeunion
:INVOICE | :PAYMENT_INTENT

If left blank, will default to INVOICE

Hide ParametersShow Parameters
:INVOICE
:PAYMENT_INTENT
invoice_metadatahash
optional
Hash[Symbol, String]

Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type.

tax_typeunion
optional
: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
priorityFloat
optional

If multiple commits are applicable, the one with the lower priority will apply first.

rate_typeunion
optional
:COMMIT_RATE | :LIST_RATE
Hide ParametersShow Parameters
:COMMIT_RATE
:LIST_RATE
rollover_fractionFloat
optional

Fraction of unused segments that will be rolled over. Must be between 0 and 1.

specifiersarray
optional
Array[{ presentation_group_values, pricing_group_values, product_id, product_tags}]

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_valueshash
optional
Hash[Symbol, String]
pricing_group_valueshash
optional
Hash[Symbol, String]
product_idString
optional

If provided, the specifier will only apply to the product with the specified ID.

formatuuid
product_tagsarray
optional
Array[String]

If provided, the specifier will only apply to products with all the specified tags.

temporary_idString
optional

A temporary ID for the commit that can be used to reference the commit for commit specific overrides.

creditsarray
optional
Array[{ access_schedule, product_id, applicable_product_ids, 9 more}]
Hide ParametersShow Parameters
access_scheduleobject
{ schedule_items, credit_type_id}

Schedule for distributing the credit to the customer.

Hide ParametersShow Parameters
schedule_itemsarray
Array[{ amount, ending_before, starting_at}]
Hide ParametersShow Parameters
amountFloat
ending_beforeTime

RFC 3339 timestamp (exclusive)

formatdate-time
starting_atTime

RFC 3339 timestamp (inclusive)

formatdate-time
credit_type_idString
optional

Defaults to USD (cents) if not passed

formatuuid
product_idString
formatuuid
applicable_product_idsarray
optional
Array[String]

Which products the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit applies to all products.

applicable_product_tagsarray
optional
Array[String]

Which tags the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit applies to all products.

custom_fieldshash
optional
Hash[Symbol, String]
descriptionString
optional

Used only in UI/API. It is not exposed to end customers.

hierarchy_configurationobject
optional
{ child_access}

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters
child_accessunion
{ type} | { type} | { contract_ids, type}
Hide ParametersShow Parameters
CommitHierarchyChildAccessAllclass
Hide ParametersShow Parameters
typeunion
:ALL
Hide ParametersShow Parameters
:ALL
CommitHierarchyChildAccessNoneclass
Hide ParametersShow Parameters
typeunion
:NONE
Hide ParametersShow Parameters
:NONE
CommitHierarchyChildAccessContractIDsclass
Hide ParametersShow Parameters
contract_idsarray
Array[String]
typeunion
:CONTRACT_IDS
Hide ParametersShow Parameters
:CONTRACT_IDS
nameString
optional

displayed on invoices

minLength1
netsuite_sales_order_idString
optional

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

priorityFloat
optional

If multiple credits are applicable, the one with the lower priority will apply first.

rate_typeunion
optional
:COMMIT_RATE | :LIST_RATE
Hide ParametersShow Parameters
:COMMIT_RATE
:LIST_RATE
specifiersarray
optional
Array[{ presentation_group_values, pricing_group_values, product_id, product_tags}]

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_valueshash
optional
Hash[Symbol, String]
pricing_group_valueshash
optional
Hash[Symbol, String]
product_idString
optional

If provided, the specifier will only apply to the product with the specified ID.

formatuuid
product_tagsarray
optional
Array[String]

If provided, the specifier will only apply to products with all the specified tags.

custom_fieldshash
optional
Hash[Symbol, String]
discountsarray
optional
Array[{ product_id, schedule, custom_fields, 2 more}]

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

Hide ParametersShow Parameters
product_idString
formatuuid
scheduleobject
{ credit_type_id, do_not_invoice, recurring_schedule, schedule_items}

Must provide either schedule_items or recurring_schedule.

Hide ParametersShow Parameters
credit_type_idString
optional

Defaults to USD (cents) if not passed.

formatuuid
do_not_invoicebool
optional

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

recurring_scheduleobject
optional
{ amount_distribution, ending_before, frequency, 4 more}

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
amount_distributionunion
:DIVIDED | :DIVIDED_ROUNDED | :EACH
Hide ParametersShow Parameters
:DIVIDED
:DIVIDED_ROUNDED
:EACH
ending_beforeTime

RFC 3339 timestamp (exclusive).

formatdate-time
frequencyunion
:MONTHLY | :QUARTERLY | :SEMI_ANNUAL | :ANNUAL
Hide ParametersShow Parameters
:MONTHLY
:QUARTERLY
:SEMI_ANNUAL
:ANNUAL
starting_atTime

RFC 3339 timestamp (inclusive).

formatdate-time
amountFloat
optional

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.

quantityFloat
optional

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

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.

schedule_itemsarray
optional
Array[{ timestamp, amount, quantity, unit_price}]

Either provide amount or provide both unit_price and quantity.

Hide ParametersShow Parameters
timestampTime

timestamp of the scheduled event

formatdate-time
amountFloat
optional

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.

quantityFloat
optional

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

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.

custom_fieldshash
optional
Hash[Symbol, String]
nameString
optional

displayed on invoices

minLength1
netsuite_sales_order_idString
optional

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

netsuite_sales_order_idString
optional

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

overridesarray
optional
Array[{ starting_at, applicable_product_tags, ending_before, 10 more}]
Hide ParametersShow Parameters
starting_atTime

RFC 3339 timestamp indicating when the override will start applying (inclusive)

formatdate-time
applicable_product_tagsarray
optional
Array[String]

tags identifying products whose rates are being overridden. Cannot be used in conjunction with override_specifiers.

ending_beforeTime
optional

RFC 3339 timestamp indicating when the override will stop applying (exclusive)

formatdate-time
entitledbool
optional
is_commit_specificbool
optional

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.

multiplierFloat
optional

Required for MULTIPLIER type. Must be >=0.

override_specifiersarray
optional
Array[{ billing_frequency, commit_ids, presentation_group_values, 5 more}]

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
billing_frequencyunion
optional
:MONTHLY | :QUARTERLY | :ANNUAL | :WEEKLY
Hide ParametersShow Parameters
:MONTHLY
:QUARTERLY
:ANNUAL
:WEEKLY
commit_idsarray
optional
Array[String]

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.

presentation_group_valueshash
optional
Hash[Symbol, String]

A map of group names to values. The override will only apply to line items with the specified presentation group values.

pricing_group_valueshash
optional
Hash[Symbol, String]

A map of pricing group names to values. The override will only apply to products with the specified pricing group values.

product_idString
optional

If provided, the override will only apply to the product with the specified ID.

formatuuid
product_tagsarray
optional
Array[String]

If provided, the override will only apply to products with all the specified tags.

recurring_commit_idsarray
optional
Array[String]

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.

recurring_credit_idsarray
optional
Array[String]

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.

overwrite_rateobject
optional
{ rate_type, credit_type_id, custom_rate, 4 more}

Required for OVERWRITE type.

Hide ParametersShow Parameters
rate_typeunion
:FLAT | :PERCENTAGE | :SUBSCRIPTION | 2 more
Hide ParametersShow Parameters
:FLAT
:PERCENTAGE
:SUBSCRIPTION
:TIERED
:CUSTOM
credit_type_idString
optional
formatuuid
custom_ratehash
optional
Hash[Symbol, untyped]

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.

tiersarray
optional
Array[priceFloatsizeFloatTier]

Only set for TIERED rate_type.

Hide ParametersShow Parameters
priceFloat
sizeFloat
optional
priorityFloat
optional

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.

product_idString
optional

ID of the product whose rate is being overridden. Cannot be used in conjunction with override_specifiers.

formatuuid
targetunion
optional
:COMMIT_RATE | :LIST_RATE

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
:COMMIT_RATE
:LIST_RATE
tiersarray
optional
Array[{ multiplier, size}]

Required for TIERED type. Must have at least one tier.

Hide ParametersShow Parameters
multiplierFloat
sizeFloat
optional
typeunion
optional
:OVERWRITE | :MULTIPLIER | :TIERED

Overwrites are prioritized over multipliers and tiered overrides.

Hide ParametersShow Parameters
:OVERWRITE
:MULTIPLIER
:TIERED
professional_servicesarray
optional
Array[{ max_amount, product_id, quantity, 4 more}]

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

Hide ParametersShow Parameters
max_amountFloat

Maximum amount for the term.

product_idString
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_fieldshash
optional
Hash[Symbol, String]
descriptionString
optional
netsuite_sales_order_idString
optional

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

reseller_royaltiesarray
optional
Array[{ reseller_type, applicable_product_ids, applicable_product_tags, 7 more}]

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

Hide ParametersShow Parameters
reseller_typeunion
:AWS | :AWS_PRO_SERVICE | :GCP | :GCP_PRO_SERVICE
Hide ParametersShow Parameters
:AWS
:AWS_PRO_SERVICE
:GCP
:GCP_PRO_SERVICE
applicable_product_idsarray
optional
Array[String]

Must provide at least one of applicable_product_ids or applicable_product_tags.

applicable_product_tagsarray
optional
Array[String]

Must provide at least one of applicable_product_ids or applicable_product_tags.

aws_optionsobject
optional
{ aws_account_number, aws_offer_id, aws_payer_reference_id}
Hide ParametersShow Parameters
aws_account_numberString
optional
aws_offer_idString
optional
aws_payer_reference_idString
optional
ending_beforeTime
optional

Use null to indicate that the existing end timestamp should be removed.

formatdate-time
fractionFloat
optional
gcp_optionsobject
optional
{ gcp_account_id, gcp_offer_id}
Hide ParametersShow Parameters
gcp_account_idString
optional
gcp_offer_idString
optional
netsuite_reseller_idString
optional
reseller_contract_valueFloat
optional
starting_atTime
optional
formatdate-time
salesforce_opportunity_idString
optional

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

scheduled_chargesarray
optional
Array[{ product_id, schedule, name, netsuite_sales_order_id}]
Hide ParametersShow Parameters
product_idString
formatuuid
scheduleobject
{ credit_type_id, do_not_invoice, recurring_schedule, schedule_items}

Must provide either schedule_items or recurring_schedule.

Hide ParametersShow Parameters
credit_type_idString
optional

Defaults to USD (cents) if not passed.

formatuuid
do_not_invoicebool
optional

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

recurring_scheduleobject
optional
{ amount_distribution, ending_before, frequency, 4 more}

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
amount_distributionunion
:DIVIDED | :DIVIDED_ROUNDED | :EACH
Hide ParametersShow Parameters
:DIVIDED
:DIVIDED_ROUNDED
:EACH
ending_beforeTime

RFC 3339 timestamp (exclusive).

formatdate-time
frequencyunion
:MONTHLY | :QUARTERLY | :SEMI_ANNUAL | :ANNUAL
Hide ParametersShow Parameters
:MONTHLY
:QUARTERLY
:SEMI_ANNUAL
:ANNUAL
starting_atTime

RFC 3339 timestamp (inclusive).

formatdate-time
amountFloat
optional

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.

quantityFloat
optional

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

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.

schedule_itemsarray
optional
Array[{ timestamp, amount, quantity, unit_price}]

Either provide amount or provide both unit_price and quantity.

Hide ParametersShow Parameters
timestampTime

timestamp of the scheduled event

formatdate-time
amountFloat
optional

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.

quantityFloat
optional

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

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.

nameString
optional

displayed on invoices

minLength1
netsuite_sales_order_idString
optional

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

total_contract_valueFloat
optional

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

Returns
ContractAmendResponseclass
Hide ParametersShow Parameters
dataidStringID
require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

response = metronome.v1.contracts.amend(
  contract_id: "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc",
  customer_id: "13117714-3f05-48e5-a6e9-a66093f13b4d",
  starting_at: "2020-01-01T00:00:00.000Z"
)

puts(response)
200 Example
{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}