Amend

Amend a contract

client.V1.Contracts.Amend(ctx, body) (*, error)

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

body

Hide ParametersShow Parameters

ContractIDfield

param.Field[string]

ID of the contract to amend

formatuuid

CustomerIDfield

param.Field[string]

ID of the customer whose contract is to be amended

formatuuid

StartingAtfield

param.Field[Time]

inclusive start time for the amendment

formatdate-time

Commitsfield

optional

param.Field[[]V1ContractAmendParamsCommit]

Hide ParametersShow Parameters

ProductIDstring

formatuuid

Type

Hide ParametersShow Parameters

V1ContractAmendParamsCommitsTypePrepaidconst

"PREPAID"

V1ContractAmendParamsCommitsTypePostpaidconst

"POSTPAID"

AccessSchedule

optional

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

ScheduleItemsarray

[]V1ContractAmendParamsCommitsAccessScheduleScheduleItem

Hide ParametersShow Parameters

Amountfloat64

EndingBeforeTime

RFC 3339 timestamp (exclusive)

formatdate-time

StartingAtTime

RFC 3339 timestamp (inclusive)

formatdate-time

CreditTypeIDstring

optional

Defaults to USD (cents) if not passed

formatuuid

Amountfloat64

optional

(DEPRECATED) Use access_schedule and invoice_schedule instead.

ApplicableProductIDsarray

optional

[]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.

ApplicableProductTagsarray

optional

[]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.

CustomFieldsmap

optional

map[string, string]

Descriptionstring

optional

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

HierarchyConfiguration

optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V1ContractAmendParamsCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V1ContractAmendParamsCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V1ContractAmendParamsCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V1ContractAmendParamsCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V1ContractAmendParamsCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V1ContractAmendParamsCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

InvoiceSchedule

optional

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

CreditTypeIDstring

optional

Defaults to USD (cents) if not passed.

formatuuid

DoNotInvoicebool

optional

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

RecurringSchedule

optional

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

AmountDistribution

Hide ParametersShow Parameters

V1ContractAmendParamsCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedconst

"DIVIDED"

V1ContractAmendParamsCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedRoundedconst

"DIVIDED_ROUNDED"

V1ContractAmendParamsCommitsInvoiceScheduleRecurringScheduleAmountDistributionEachconst

"EACH"

EndingBeforeTime

RFC 3339 timestamp (exclusive).

formatdate-time

Frequency

Hide ParametersShow Parameters

V1ContractAmendParamsCommitsInvoiceScheduleRecurringScheduleFrequencyMonthlyconst

"MONTHLY"

V1ContractAmendParamsCommitsInvoiceScheduleRecurringScheduleFrequencyQuarterlyconst

"QUARTERLY"

V1ContractAmendParamsCommitsInvoiceScheduleRecurringScheduleFrequencySemiAnnualconst

"SEMI_ANNUAL"

V1ContractAmendParamsCommitsInvoiceScheduleRecurringScheduleFrequencyAnnualconst

"ANNUAL"

StartingAtTime

RFC 3339 timestamp (inclusive).

formatdate-time

Amountfloat64

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.

Quantityfloat64

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.

UnitPricefloat64

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.

ScheduleItemsarray

optional

[]V1ContractAmendParamsCommitsInvoiceScheduleScheduleItem

Either provide amount or provide both unit_price and quantity.

Hide ParametersShow Parameters

TimestampTime

timestamp of the scheduled event

formatdate-time

Amountfloat64

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.

Quantityfloat64

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.

UnitPricefloat64

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

NetsuiteSalesOrderIDstring

optional

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

PaymentGateConfig

optional

optionally payment gate this commit

Hide ParametersShow Parameters

PaymentGateType

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

V1ContractAmendParamsCommitsPaymentGateConfigPaymentGateTypeNoneconst

"NONE"

V1ContractAmendParamsCommitsPaymentGateConfigPaymentGateTypeStripeconst

"STRIPE"

V1ContractAmendParamsCommitsPaymentGateConfigPaymentGateTypeExternalconst

"EXTERNAL"

PrecalculatedTaxConfig

optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

TaxAmountfloat64

Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule

TaxNamestring

optional

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

StripeConfig

optional

Only applicable if using STRIPE as your payment gate type.

Hide ParametersShow Parameters

PaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V1ContractAmendParamsCommitsPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

"INVOICE"

V1ContractAmendParamsCommitsPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxType

optional

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

V1ContractAmendParamsCommitsPaymentGateConfigTaxTypeNoneconst

"NONE"

V1ContractAmendParamsCommitsPaymentGateConfigTaxTypeStripeconst

"STRIPE"

V1ContractAmendParamsCommitsPaymentGateConfigTaxTypeAnrokconst

"ANROK"

V1ContractAmendParamsCommitsPaymentGateConfigTaxTypePrecalculatedconst

"PRECALCULATED"

Priorityfloat64

optional

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

RateType

optional

Hide ParametersShow Parameters

V1ContractAmendParamsCommitsRateTypeCommitRateconst

"COMMIT_RATE"

V1ContractAmendParamsCommitsRateTypeListRateconst

"LIST_RATE"

RolloverFractionfloat64

optional

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

Specifiersarray

optional

[]V1ContractAmendParamsCommitsSpecifier

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

PresentationGroupValuesmap

optional

map[string, string]

PricingGroupValuesmap

optional

map[string, string]

ProductIDstring

optional

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

formatuuid

ProductTagsarray

optional

[]string

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

TemporaryIDstring

optional

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

Creditsfield

optional

param.Field[[]V1ContractAmendParamsCredit]

Hide ParametersShow Parameters

AccessSchedule

Schedule for distributing the credit to the customer.

Hide ParametersShow Parameters

ScheduleItemsarray

[]V1ContractAmendParamsCreditsAccessScheduleScheduleItem

Hide ParametersShow Parameters

Amountfloat64

EndingBeforeTime

RFC 3339 timestamp (exclusive)

formatdate-time

StartingAtTime

RFC 3339 timestamp (inclusive)

formatdate-time

CreditTypeIDstring

optional

Defaults to USD (cents) if not passed

formatuuid

ProductIDstring

formatuuid

ApplicableProductIDsarray

optional

[]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.

ApplicableProductTagsarray

optional

[]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.

CustomFieldsmap

optional

map[string, string]

Descriptionstring

optional

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

HierarchyConfiguration

optional

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V1ContractAmendParamsCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V1ContractAmendParamsCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V1ContractAmendParamsCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V1ContractAmendParamsCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V1ContractAmendParamsCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V1ContractAmendParamsCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

Namestring

optional

displayed on invoices

minLength1

NetsuiteSalesOrderIDstring

optional

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

Priorityfloat64

optional

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

RateType

optional

Hide ParametersShow Parameters

V1ContractAmendParamsCreditsRateTypeCommitRateconst

"COMMIT_RATE"

V1ContractAmendParamsCreditsRateTypeListRateconst

"LIST_RATE"

Specifiersarray

optional

[]V1ContractAmendParamsCreditsSpecifier

Hide ParametersShow Parameters

PresentationGroupValuesmap

optional

map[string, string]

PricingGroupValuesmap

optional

map[string, string]

ProductIDstring

optional

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

formatuuid

ProductTagsarray

optional

[]string

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

CustomFieldsfield

optional

param.Field[map[string, string]]

Discountsfield

optional

param.Field[[]V1ContractAmendParamsDiscount]

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

Hide ParametersShow Parameters

ProductIDstring

formatuuid

Schedule

Must provide either schedule_items or recurring_schedule.

Hide ParametersShow Parameters

CreditTypeIDstring

optional

Defaults to USD (cents) if not passed.

formatuuid

DoNotInvoicebool

optional

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

RecurringSchedule

optional

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

AmountDistribution

Hide ParametersShow Parameters

V1ContractAmendParamsDiscountsScheduleRecurringScheduleAmountDistributionDividedconst

"DIVIDED"

V1ContractAmendParamsDiscountsScheduleRecurringScheduleAmountDistributionDividedRoundedconst

"DIVIDED_ROUNDED"

V1ContractAmendParamsDiscountsScheduleRecurringScheduleAmountDistributionEachconst

"EACH"

EndingBeforeTime

RFC 3339 timestamp (exclusive).

formatdate-time

Frequency

Hide ParametersShow Parameters

V1ContractAmendParamsDiscountsScheduleRecurringScheduleFrequencyMonthlyconst

"MONTHLY"

V1ContractAmendParamsDiscountsScheduleRecurringScheduleFrequencyQuarterlyconst

"QUARTERLY"

V1ContractAmendParamsDiscountsScheduleRecurringScheduleFrequencySemiAnnualconst

"SEMI_ANNUAL"

V1ContractAmendParamsDiscountsScheduleRecurringScheduleFrequencyAnnualconst

"ANNUAL"

StartingAtTime

RFC 3339 timestamp (inclusive).

formatdate-time

Amountfloat64

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.

Quantityfloat64

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.

UnitPricefloat64

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.

ScheduleItemsarray

optional

[]V1ContractAmendParamsDiscountsScheduleScheduleItem

Either provide amount or provide both unit_price and quantity.

Hide ParametersShow Parameters

TimestampTime

timestamp of the scheduled event

formatdate-time

Amountfloat64

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.

Quantityfloat64

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.

UnitPricefloat64

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.

CustomFieldsmap

optional

map[string, string]

Namestring

optional

displayed on invoices

minLength1

NetsuiteSalesOrderIDstring

optional

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

NetsuiteSalesOrderIDfield

optional

param.Field[string]

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

Overridesfield

optional

param.Field[[]V1ContractAmendParamsOverride]

Hide ParametersShow Parameters

StartingAtTime

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

formatdate-time

ApplicableProductTagsarray

optional

[]string

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

EndingBeforeTime

optional

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

formatdate-time

Entitledbool

optional

IsCommitSpecificbool

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.

Multiplierfloat64

optional

Required for MULTIPLIER type. Must be >=0.

OverrideSpecifiersarray

optional

[]V1ContractAmendParamsOverridesOverrideSpecifier

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

BillingFrequency

optional

Hide ParametersShow Parameters

V1ContractAmendParamsOverridesOverrideSpecifiersBillingFrequencyMonthlyconst

"MONTHLY"

V1ContractAmendParamsOverridesOverrideSpecifiersBillingFrequencyQuarterlyconst

"QUARTERLY"

V1ContractAmendParamsOverridesOverrideSpecifiersBillingFrequencyAnnualconst

"ANNUAL"

V1ContractAmendParamsOverridesOverrideSpecifiersBillingFrequencyWeeklyconst

"WEEKLY"

CommitIDsarray

optional

[]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.

PresentationGroupValuesmap

optional

map[string, string]

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

PricingGroupValuesmap

optional

map[string, string]

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

ProductIDstring

optional

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

formatuuid

ProductTagsarray

optional

[]string

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

RecurringCommitIDsarray

optional

[]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.

RecurringCreditIDsarray

optional

[]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.

OverwriteRate

optional

Required for OVERWRITE type.

Hide ParametersShow Parameters

RateType

Hide ParametersShow Parameters

V1ContractAmendParamsOverridesOverwriteRateRateTypeFlatconst

"FLAT"

V1ContractAmendParamsOverridesOverwriteRateRateTypePercentageconst

"PERCENTAGE"

V1ContractAmendParamsOverridesOverwriteRateRateTypeSubscriptionconst

"SUBSCRIPTION"

V1ContractAmendParamsOverridesOverwriteRateRateTypeTieredconst

"TIERED"

V1ContractAmendParamsOverridesOverwriteRateRateTypeCustomconst

"CUSTOM"

CreditTypeIDstring

optional

formatuuid

CustomRatemap

optional

map[string, unknown]

Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.

IsProratedbool

optional

Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.

Pricefloat64

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.

Quantityfloat64

optional

Default quantity. For SUBSCRIPTION rate_type, this must be >=0.

Tiersarray

optional

[]

Only set for TIERED rate_type.

Hide ParametersShow Parameters

Pricefloat64

Sizefloat64

optional

Priorityfloat64

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.

ProductIDstring

optional

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

formatuuid

Target

optional

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

V1ContractAmendParamsOverridesTargetCommitRateconst

"COMMIT_RATE"

V1ContractAmendParamsOverridesTargetListRateconst

"LIST_RATE"

Tiersarray

optional

[]V1ContractAmendParamsOverridesTier

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

Hide ParametersShow Parameters

Multiplierfloat64

Sizefloat64

optional

Type

optional

Overwrites are prioritized over multipliers and tiered overrides.

Hide ParametersShow Parameters

V1ContractAmendParamsOverridesTypeOverwriteconst

"OVERWRITE"

V1ContractAmendParamsOverridesTypeMultiplierconst

"MULTIPLIER"

V1ContractAmendParamsOverridesTypeTieredconst

"TIERED"

ProfessionalServicesfield

optional

param.Field[[]V1ContractAmendParamsProfessionalService]

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

Hide ParametersShow Parameters

MaxAmountfloat64

Maximum amount for the term.

ProductIDstring

formatuuid

Quantityfloat64

Quantity for the charge. Will be multiplied by unit_price to determine the amount.

UnitPricefloat64

Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified.

CustomFieldsmap

optional

map[string, string]

Descriptionstring

optional

NetsuiteSalesOrderIDstring

optional

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

ResellerRoyaltiesfield

optional

param.Field[[]V1ContractAmendParamsResellerRoyalty]

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

Hide ParametersShow Parameters

ResellerType

Hide ParametersShow Parameters

V1ContractAmendParamsResellerRoyaltiesResellerTypeAwsconst

"AWS"

V1ContractAmendParamsResellerRoyaltiesResellerTypeAwsProServiceconst

"AWS_PRO_SERVICE"

V1ContractAmendParamsResellerRoyaltiesResellerTypeGcpconst

"GCP"

V1ContractAmendParamsResellerRoyaltiesResellerTypeGcpProServiceconst

"GCP_PRO_SERVICE"

ApplicableProductIDsarray

optional

[]string

Must provide at least one of applicable_product_ids or applicable_product_tags.

ApplicableProductTagsarray

optional

[]string

Must provide at least one of applicable_product_ids or applicable_product_tags.

AwsOptions

optional

Hide ParametersShow Parameters

AwsAccountNumberstring

optional

AwsOfferIDstring

optional

AwsPayerReferenceIDstring

optional

EndingBeforeTime

optional

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

formatdate-time

Fractionfloat64

optional

GcpOptions

optional

Hide ParametersShow Parameters

GcpAccountIDstring

optional

GcpOfferIDstring

optional

NetsuiteResellerIDstring

optional

ResellerContractValuefloat64

optional

StartingAtTime

optional

formatdate-time

SalesforceOpportunityIDfield

optional

param.Field[string]

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

ScheduledChargesfield

optional

param.Field[[]V1ContractAmendParamsScheduledCharge]

Hide ParametersShow Parameters

ProductIDstring

formatuuid

Schedule

Must provide either schedule_items or recurring_schedule.

Hide ParametersShow Parameters

CreditTypeIDstring

optional

Defaults to USD (cents) if not passed.

formatuuid

DoNotInvoicebool

optional

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

RecurringSchedule

optional

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

AmountDistribution

Hide ParametersShow Parameters

V1ContractAmendParamsScheduledChargesScheduleRecurringScheduleAmountDistributionDividedconst

"DIVIDED"

V1ContractAmendParamsScheduledChargesScheduleRecurringScheduleAmountDistributionDividedRoundedconst

"DIVIDED_ROUNDED"

V1ContractAmendParamsScheduledChargesScheduleRecurringScheduleAmountDistributionEachconst

"EACH"

EndingBeforeTime

RFC 3339 timestamp (exclusive).

formatdate-time

Frequency

Hide ParametersShow Parameters

V1ContractAmendParamsScheduledChargesScheduleRecurringScheduleFrequencyMonthlyconst

"MONTHLY"

V1ContractAmendParamsScheduledChargesScheduleRecurringScheduleFrequencyQuarterlyconst

"QUARTERLY"

V1ContractAmendParamsScheduledChargesScheduleRecurringScheduleFrequencySemiAnnualconst

"SEMI_ANNUAL"

V1ContractAmendParamsScheduledChargesScheduleRecurringScheduleFrequencyAnnualconst

"ANNUAL"

StartingAtTime

RFC 3339 timestamp (inclusive).

formatdate-time

Amountfloat64

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.

Quantityfloat64

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.

UnitPricefloat64

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.

ScheduleItemsarray

optional

[]V1ContractAmendParamsScheduledChargesScheduleScheduleItem

Either provide amount or provide both unit_price and quantity.

Hide ParametersShow Parameters

TimestampTime

timestamp of the scheduled event

formatdate-time

Amountfloat64

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.

Quantityfloat64

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.

UnitPricefloat64

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

NetsuiteSalesOrderIDstring

optional

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

TotalContractValuefield

optional

param.Field[float64]

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

Returns

V1ContractAmendResponsestruct

Hide ParametersShow Parameters

Data

package main

import (
  "context"
  "fmt"
  "time"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.V1.Contracts.Amend(context.TODO(), metronome.V1ContractAmendParams{
    ContractID: metronome.F("d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"),
    CustomerID: metronome.F("13117714-3f05-48e5-a6e9-a66093f13b4d"),
    StartingAt: metronome.F(time.Now()),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}