Edit

API Reference

V2

Contracts

Edit a contract

client.V2.Contracts.Edit(ctx, body) (*DataIDV2ContractEditResponse, error)

post/v2/contracts/edit

Edit a contract. Contract editing must be enabled to use this endpoint.

Parameters

bodyContractIDfieldCustomerIDfieldAddCommitsfieldAddCreditsfieldAddDiscountsfieldAddOverridesfieldAddPrepaidBalanceThresholdConfigurationfieldAddProfessionalServicesfieldAddRecurringCommitsfieldAddRecurringCreditsfieldAddResellerRoyaltiesfieldAddScheduledChargesfieldAddSpendThresholdConfigurationfieldAddSubscriptionsfieldAllowContractEndingBeforeFinalizedInvoicefieldArchiveCommitsfieldArchiveCreditsfieldArchiveScheduledChargesfieldRemoveOverridesfieldUpdateCommitsfieldUpdateContractEndDatefieldUpdateContractNamefieldUpdateCreditsfieldUpdatePrepaidBalanceThresholdConfigurationfieldUpdateRecurringCommitsfieldUpdateRecurringCreditsfieldUpdateScheduledChargesfieldUpdateSpendThresholdConfigurationfieldUpdateSubscriptionsfieldV2ContractEditParams

Hide ParametersShow Parameters

ContractIDfield

param.Field[string]

ID of the contract being edited

formatuuid

CustomerIDfield

param.Field[string]

ID of the customer whose contract is being edited

formatuuid

AddCommitsfield

optional

param.Field[[]V2ContractEditParamsAddCommit]

Hide ParametersShow Parameters

ProductIDstring

formatuuid

TypeV2ContractEditParamsAddCommitsTypePrepaidV2ContractEditParamsAddCommitsTypeV2ContractEditParamsAddCommitsTypePostpaidV2ContractEditParamsAddCommitsTypeV2ContractEditParamsAddCommitsType

Hide ParametersShow Parameters

V2ContractEditParamsAddCommitsTypePrepaidconst

V2ContractEditParamsAddCommitsTypePrepaidV2ContractEditParamsAddCommitsTypeV2ContractEditParamsAddCommitsTypePostpaidV2ContractEditParamsAddCommitsTypeV2ContractEditParamsAddCommitsType

"PREPAID"

V2ContractEditParamsAddCommitsTypePostpaidconst

V2ContractEditParamsAddCommitsTypePrepaidV2ContractEditParamsAddCommitsTypeV2ContractEditParamsAddCommitsTypePostpaidV2ContractEditParamsAddCommitsTypeV2ContractEditParamsAddCommitsType

"POSTPAID"

AccessScheduleScheduleItemsarrayCreditTypeIDstringV2ContractEditParamsAddCommitsAccessSchedule

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

[]V2ContractEditParamsAddCommitsAccessScheduleScheduleItem

Hide ParametersShow Parameters

Amountfloat64

EndingBeforeTime

RFC 3339 timestamp (exclusive)

formatdate-time

StartingAtTime

RFC 3339 timestamp (inclusive)

formatdate-time

CreditTypeIDstring

optional

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.

HierarchyConfigurationChildAccessV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessV2ContractEditParamsAddCommitsHierarchyConfiguration

optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters

ChildAccessV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccess

Hide ParametersShow Parameters

V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

Hide ParametersShow Parameters

V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

"ALL"

V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

Hide ParametersShow Parameters

V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

"NONE"

V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

TypeV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

Hide ParametersShow Parameters

V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

V2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

"CONTRACT_IDS"

InvoiceScheduleCreditTypeIDstringDoNotInvoiceboolRecurringScheduleV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleScheduleItemsarrayV2ContractEditParamsAddCommitsInvoiceSchedule

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.

RecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionEndingBeforeTimeFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyStartingAtTimeAmountfloat64Quantityfloat64UnitPricefloat64V2ContractEditParamsAddCommitsInvoiceScheduleRecurringSchedule

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

AmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistribution

Hide ParametersShow Parameters

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedconst

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistribution

"DIVIDED"

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedRoundedconst

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistribution

"DIVIDED_ROUNDED"

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionEachconst

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleAmountDistribution

"EACH"

EndingBeforeTime

RFC 3339 timestamp (exclusive).

formatdate-time

FrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequency

Hide ParametersShow Parameters

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyMonthlyconst

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequency

"MONTHLY"

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyQuarterlyconst

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequency

"QUARTERLY"

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencySemiAnnualconst

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequency

"SEMI_ANNUAL"

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyAnnualconst

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequency

"ANNUAL"

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyWeeklyconst

V2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequencyV2ContractEditParamsAddCommitsInvoiceScheduleRecurringScheduleFrequency

"WEEKLY"

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

[]V2ContractEditParamsAddCommitsInvoiceScheduleScheduleItem

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.

PaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypePrecalculatedTaxConfigV2ContractEditParamsAddCommitsPaymentGateConfigPrecalculatedTaxConfigStripeConfigV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfig

optional

optionally payment gate this commit

Hide ParametersShow Parameters

PaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateType

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

V2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeNoneconst

V2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateType

"NONE"

V2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeStripeconst

V2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateType

"STRIPE"

V2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeExternalconst

V2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddCommitsPaymentGateConfigPaymentGateType

"EXTERNAL"

PrecalculatedTaxConfigTaxAmountfloat64TaxNamestringV2ContractEditParamsAddCommitsPaymentGateConfigPrecalculatedTaxConfig

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.

StripeConfigPaymentTypeV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeInvoiceMetadatamapV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentTypeV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

V2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentType

"INVOICE"

V2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

V2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddCommitsPaymentGateConfigStripeConfigPaymentType

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxType

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

V2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeNoneconst

V2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxType

"NONE"

V2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeStripeconst

V2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxType

"STRIPE"

V2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeAnrokconst

V2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxType

"ANROK"

V2ContractEditParamsAddCommitsPaymentGateConfigTaxTypePrecalculatedconst

V2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddCommitsPaymentGateConfigTaxTypeV2ContractEditParamsAddCommitsPaymentGateConfigTaxType

"PRECALCULATED"

Priorityfloat64

optional

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

RateTypeV2ContractEditParamsAddCommitsRateTypeCommitRateV2ContractEditParamsAddCommitsRateTypeV2ContractEditParamsAddCommitsRateTypeListRateV2ContractEditParamsAddCommitsRateTypeV2ContractEditParamsAddCommitsRateType

optional

Hide ParametersShow Parameters

V2ContractEditParamsAddCommitsRateTypeCommitRateconst

V2ContractEditParamsAddCommitsRateTypeCommitRateV2ContractEditParamsAddCommitsRateTypeV2ContractEditParamsAddCommitsRateTypeListRateV2ContractEditParamsAddCommitsRateTypeV2ContractEditParamsAddCommitsRateType

"COMMIT_RATE"

V2ContractEditParamsAddCommitsRateTypeListRateconst

V2ContractEditParamsAddCommitsRateTypeCommitRateV2ContractEditParamsAddCommitsRateTypeV2ContractEditParamsAddCommitsRateTypeListRateV2ContractEditParamsAddCommitsRateTypeV2ContractEditParamsAddCommitsRateType

"LIST_RATE"

RolloverFractionfloat64

optional

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

Specifiersarray

optional

[]V2ContractEditParamsAddCommitsSpecifier

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. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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.

AddCreditsfield

optional

param.Field[[]V2ContractEditParamsAddCredit]

Hide ParametersShow Parameters

AccessScheduleScheduleItemsarrayCreditTypeIDstringV2ContractEditParamsAddCreditsAccessSchedule

Schedule for distributing the credit to the customer.

Hide ParametersShow Parameters

ScheduleItemsarray

[]V2ContractEditParamsAddCreditsAccessScheduleScheduleItem

Hide ParametersShow Parameters

Amountfloat64

EndingBeforeTime

RFC 3339 timestamp (exclusive)

formatdate-time

StartingAtTime

RFC 3339 timestamp (inclusive)

formatdate-time

CreditTypeIDstring

optional

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.

HierarchyConfigurationChildAccessV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessV2ContractEditParamsAddCreditsHierarchyConfiguration

optional

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters

ChildAccessV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccess

Hide ParametersShow Parameters

V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

Hide ParametersShow Parameters

V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

"ALL"

V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

Hide ParametersShow Parameters

V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

"NONE"

V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

TypeV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

Hide ParametersShow Parameters

V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

V2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

"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.

RateTypeV2ContractEditParamsAddCreditsRateTypeCommitRateV2ContractEditParamsAddCreditsRateTypeV2ContractEditParamsAddCreditsRateTypeListRateV2ContractEditParamsAddCreditsRateTypeV2ContractEditParamsAddCreditsRateType

optional

Hide ParametersShow Parameters

V2ContractEditParamsAddCreditsRateTypeCommitRateconst

V2ContractEditParamsAddCreditsRateTypeCommitRateV2ContractEditParamsAddCreditsRateTypeV2ContractEditParamsAddCreditsRateTypeListRateV2ContractEditParamsAddCreditsRateTypeV2ContractEditParamsAddCreditsRateType

"COMMIT_RATE"

V2ContractEditParamsAddCreditsRateTypeListRateconst

V2ContractEditParamsAddCreditsRateTypeCommitRateV2ContractEditParamsAddCreditsRateTypeV2ContractEditParamsAddCreditsRateTypeListRateV2ContractEditParamsAddCreditsRateTypeV2ContractEditParamsAddCreditsRateType

"LIST_RATE"

Specifiersarray

optional

[]V2ContractEditParamsAddCreditsSpecifier

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. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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.

AddDiscountsfield

optional

param.Field[[]V2ContractEditParamsAddDiscount]

Hide ParametersShow Parameters

ProductIDstring

formatuuid

ScheduleCreditTypeIDstringDoNotInvoiceboolRecurringScheduleV2ContractEditParamsAddDiscountsScheduleRecurringScheduleScheduleItemsarrayV2ContractEditParamsAddDiscountsSchedule

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.

RecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionEndingBeforeTimeFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyStartingAtTimeAmountfloat64Quantityfloat64UnitPricefloat64V2ContractEditParamsAddDiscountsScheduleRecurringSchedule

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

AmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistribution

Hide ParametersShow Parameters

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionDividedconst

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistribution

"DIVIDED"

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionDividedRoundedconst

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistribution

"DIVIDED_ROUNDED"

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionEachconst

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddDiscountsScheduleRecurringScheduleAmountDistribution

"EACH"

EndingBeforeTime

RFC 3339 timestamp (exclusive).

formatdate-time

FrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequency

Hide ParametersShow Parameters

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyMonthlyconst

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequency

"MONTHLY"

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyQuarterlyconst

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequency

"QUARTERLY"

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencySemiAnnualconst

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequency

"SEMI_ANNUAL"

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyAnnualconst

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequency

"ANNUAL"

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyWeeklyconst

V2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequencyV2ContractEditParamsAddDiscountsScheduleRecurringScheduleFrequency

"WEEKLY"

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

[]V2ContractEditParamsAddDiscountsScheduleScheduleItem

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.

AddOverridesfield

optional

param.Field[[]V2ContractEditParamsAddOverride]

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

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.

Multiplierfloat64

optional

Required for MULTIPLIER type. Must be >=0.

OverrideSpecifiersarray

optional

[]V2ContractEditParamsAddOverridesOverrideSpecifier

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

BillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyMonthlyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyQuarterlyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyAnnualV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyWeeklyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequency

optional

Hide ParametersShow Parameters

V2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyMonthlyconst

V2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyMonthlyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyQuarterlyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyAnnualV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyWeeklyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequency

"MONTHLY"

V2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyQuarterlyconst

V2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyMonthlyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyQuarterlyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyAnnualV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyWeeklyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequency

"QUARTERLY"

V2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyAnnualconst

V2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyMonthlyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyQuarterlyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyAnnualV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyWeeklyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequency

"ANNUAL"

V2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyWeeklyconst

V2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyMonthlyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyQuarterlyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyAnnualV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyWeeklyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequencyV2ContractEditParamsAddOverridesOverrideSpecifiersBillingFrequency

"WEEKLY"

CommitIDsarray

optional

[]string

If provided, the override will only apply to the specified commits. Can only be used for commit specific overrides. 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. Can only be used for multiplier overrides.

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 commits created by the specified recurring credit ids.

OverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeCreditTypeIDstringCustomRatemapIsProratedboolPricefloat64Quantityfloat64TiersarrayV2ContractEditParamsAddOverridesOverwriteRate

optional

Required for OVERWRITE type.

Hide ParametersShow Parameters

RateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeFlatV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypePercentageV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeSubscriptionV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeTieredV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeCustomV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateType

Hide ParametersShow Parameters

V2ContractEditParamsAddOverridesOverwriteRateRateTypeFlatconst

V2ContractEditParamsAddOverridesOverwriteRateRateTypeFlatV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypePercentageV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeSubscriptionV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeTieredV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeCustomV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateType

"FLAT"

V2ContractEditParamsAddOverridesOverwriteRateRateTypePercentageconst

V2ContractEditParamsAddOverridesOverwriteRateRateTypeFlatV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypePercentageV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeSubscriptionV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeTieredV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeCustomV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateType

"PERCENTAGE"

V2ContractEditParamsAddOverridesOverwriteRateRateTypeSubscriptionconst

V2ContractEditParamsAddOverridesOverwriteRateRateTypeFlatV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypePercentageV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeSubscriptionV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeTieredV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeCustomV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateType

"SUBSCRIPTION"

V2ContractEditParamsAddOverridesOverwriteRateRateTypeTieredconst

V2ContractEditParamsAddOverridesOverwriteRateRateTypeFlatV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypePercentageV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeSubscriptionV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeTieredV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeCustomV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateType

"TIERED"

V2ContractEditParamsAddOverridesOverwriteRateRateTypeCustomconst

V2ContractEditParamsAddOverridesOverwriteRateRateTypeFlatV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypePercentageV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeSubscriptionV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeTieredV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateTypeCustomV2ContractEditParamsAddOverridesOverwriteRateRateTypeV2ContractEditParamsAddOverridesOverwriteRateRateType

"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

[]Pricefloat64Sizefloat64Tier

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

formatuuid

TargetV2ContractEditParamsAddOverridesTargetCommitRateV2ContractEditParamsAddOverridesTargetV2ContractEditParamsAddOverridesTargetListRateV2ContractEditParamsAddOverridesTargetV2ContractEditParamsAddOverridesTarget

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

V2ContractEditParamsAddOverridesTargetCommitRateconst

V2ContractEditParamsAddOverridesTargetCommitRateV2ContractEditParamsAddOverridesTargetV2ContractEditParamsAddOverridesTargetListRateV2ContractEditParamsAddOverridesTargetV2ContractEditParamsAddOverridesTarget

"COMMIT_RATE"

V2ContractEditParamsAddOverridesTargetListRateconst

V2ContractEditParamsAddOverridesTargetCommitRateV2ContractEditParamsAddOverridesTargetV2ContractEditParamsAddOverridesTargetListRateV2ContractEditParamsAddOverridesTargetV2ContractEditParamsAddOverridesTarget

"LIST_RATE"

Tiersarray

optional

[]V2ContractEditParamsAddOverridesTier

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

Hide ParametersShow Parameters

Multiplierfloat64

Sizefloat64

optional

TypeV2ContractEditParamsAddOverridesTypeOverwriteV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesTypeMultiplierV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesTypeTieredV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesType

optional

Overwrites are prioritized over multipliers and tiered overrides.

Hide ParametersShow Parameters

V2ContractEditParamsAddOverridesTypeOverwriteconst

V2ContractEditParamsAddOverridesTypeOverwriteV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesTypeMultiplierV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesTypeTieredV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesType

"OVERWRITE"

V2ContractEditParamsAddOverridesTypeMultiplierconst

V2ContractEditParamsAddOverridesTypeOverwriteV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesTypeMultiplierV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesTypeTieredV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesType

"MULTIPLIER"

V2ContractEditParamsAddOverridesTypeTieredconst

V2ContractEditParamsAddOverridesTypeOverwriteV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesTypeMultiplierV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesTypeTieredV2ContractEditParamsAddOverridesTypeV2ContractEditParamsAddOverridesType

"TIERED"

AddPrepaidBalanceThresholdConfigurationfield

optional

param.Field[V2ContractEditParamsAddPrepaidBalanceThresholdConfiguration]

Hide ParametersShow Parameters

CommitProductIDstringApplicableProductIDsarrayApplicableProductTagsarrayDescriptionstringNamestringSpecifiersarrayV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationCommit

Hide ParametersShow Parameters

ProductIDstring

The commit product that will be used to generate the line item for commit payment.

ApplicableProductIDsarray

optional

[]string

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.

ApplicableProductTagsarray

optional

[]string

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.

Descriptionstring

optional

Namestring

optional

Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.

Specifiersarray

optional

[]V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationCommitSpecifier

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. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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.

IsEnabledbool

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.

PaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypePrecalculatedTaxConfigV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigStripeConfigV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfig

Hide ParametersShow Parameters

PaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType

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

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType

"NONE"

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType

"STRIPE"

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType

"EXTERNAL"

PrecalculatedTaxConfigTaxAmountfloat64TaxNamestringV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig

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.

StripeConfigPaymentTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceMetadatamapV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

"INVOICE"

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType

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

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType

"NONE"

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType

"STRIPE"

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType

"ANROK"

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

V2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType

"PRECALCULATED"

RechargeToAmountfloat64

Specify the amount the balance should be recharged to.

ThresholdAmountfloat64

Specify the threshold amount for the contract. Each time the contract's balance lowers to this amount, a threshold charge will be initiated.

CustomCreditTypeIDstring

optional

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.

formatuuid

AddProfessionalServicesfield

optional

param.Field[[]V2ContractEditParamsAddProfessionalService]

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.

AddRecurringCommitsfield

optional

param.Field[[]V2ContractEditParamsAddRecurringCommit]

Hide ParametersShow Parameters

AccessAmountCreditTypeIDstringUnitPricefloat64Quantityfloat64V2ContractEditParamsAddRecurringCommitsAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters

CreditTypeIDstring

formatuuid

UnitPricefloat64

Quantityfloat64

optional

This field is required unless a subscription is attached via subscription_config.

CommitDurationValuefloat64UnitV2ContractEditParamsAddRecurringCommitsCommitDurationUnitV2ContractEditParamsAddRecurringCommitsCommitDuration

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

Valuefloat64

UnitV2ContractEditParamsAddRecurringCommitsCommitDurationUnitPeriodsV2ContractEditParamsAddRecurringCommitsCommitDurationUnitV2ContractEditParamsAddRecurringCommitsCommitDurationUnit

optional

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCommitsCommitDurationUnitPeriodsconst

V2ContractEditParamsAddRecurringCommitsCommitDurationUnitPeriodsV2ContractEditParamsAddRecurringCommitsCommitDurationUnitV2ContractEditParamsAddRecurringCommitsCommitDurationUnit

"PERIODS"

Priorityfloat64

Will be passed down to the individual commits

ProductIDstring

formatuuid

StartingAtTime

determines the start time for the first commit

formatdate-time

ApplicableProductIDsarray

optional

[]string

Will be passed down to the individual commits

ApplicableProductTagsarray

optional

[]string

Will be passed down to the individual commits

Descriptionstring

optional

Will be passed down to the individual commits

EndingBeforeTime

optional

Determines when the contract will stop creating recurring commits. optional

formatdate-time

HierarchyConfigurationChildAccessV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessV2ContractEditParamsAddRecurringCommitsHierarchyConfiguration

optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters

ChildAccessV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccess

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

"ALL"

V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

"NONE"

V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

TypeV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

V2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

"CONTRACT_IDS"

InvoiceAmountCreditTypeIDstringQuantityfloat64UnitPricefloat64V2ContractEditParamsAddRecurringCommitsInvoiceAmount

optional

The amount the customer should be billed for the commit. Not required.

Hide ParametersShow Parameters

CreditTypeIDstring

formatuuid

Quantityfloat64

UnitPricefloat64

Namestring

optional

displayed on invoices. will be passed through to the individual commits

minLength1

NetsuiteSalesOrderIDstring

optional

Will be passed down to the individual commits

ProrationV2ContractEditParamsAddRecurringCommitsProrationNoneV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationFirstV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationLastV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationFirstAndLastV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProration

optional

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

V2ContractEditParamsAddRecurringCommitsProrationNoneconst

V2ContractEditParamsAddRecurringCommitsProrationNoneV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationFirstV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationLastV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationFirstAndLastV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProration

"NONE"

V2ContractEditParamsAddRecurringCommitsProrationFirstconst

V2ContractEditParamsAddRecurringCommitsProrationNoneV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationFirstV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationLastV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationFirstAndLastV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProration

"FIRST"

V2ContractEditParamsAddRecurringCommitsProrationLastconst

V2ContractEditParamsAddRecurringCommitsProrationNoneV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationFirstV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationLastV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationFirstAndLastV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProration

"LAST"

V2ContractEditParamsAddRecurringCommitsProrationFirstAndLastconst

V2ContractEditParamsAddRecurringCommitsProrationNoneV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationFirstV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationLastV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProrationFirstAndLastV2ContractEditParamsAddRecurringCommitsProrationV2ContractEditParamsAddRecurringCommitsProration

"FIRST_AND_LAST"

RateTypeV2ContractEditParamsAddRecurringCommitsRateTypeCommitRateV2ContractEditParamsAddRecurringCommitsRateTypeV2ContractEditParamsAddRecurringCommitsRateTypeListRateV2ContractEditParamsAddRecurringCommitsRateTypeV2ContractEditParamsAddRecurringCommitsRateType

optional

Whether the created commits will use the commit rate or list rate

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCommitsRateTypeCommitRateconst

V2ContractEditParamsAddRecurringCommitsRateTypeCommitRateV2ContractEditParamsAddRecurringCommitsRateTypeV2ContractEditParamsAddRecurringCommitsRateTypeListRateV2ContractEditParamsAddRecurringCommitsRateTypeV2ContractEditParamsAddRecurringCommitsRateType

"COMMIT_RATE"

V2ContractEditParamsAddRecurringCommitsRateTypeListRateconst

V2ContractEditParamsAddRecurringCommitsRateTypeCommitRateV2ContractEditParamsAddRecurringCommitsRateTypeV2ContractEditParamsAddRecurringCommitsRateTypeListRateV2ContractEditParamsAddRecurringCommitsRateTypeV2ContractEditParamsAddRecurringCommitsRateType

"LIST_RATE"

RecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyMonthlyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyQuarterlyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyAnnualV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyWeeklyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequency

optional

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

V2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyMonthlyconst

V2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyMonthlyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyQuarterlyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyAnnualV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyWeeklyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequency

"MONTHLY"

V2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyQuarterlyconst

V2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyMonthlyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyQuarterlyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyAnnualV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyWeeklyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequency

"QUARTERLY"

V2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyAnnualconst

V2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyMonthlyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyQuarterlyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyAnnualV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyWeeklyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequency

"ANNUAL"

V2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyWeeklyconst

V2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyMonthlyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyQuarterlyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyAnnualV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyWeeklyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequencyV2ContractEditParamsAddRecurringCommitsRecurrenceFrequency

"WEEKLY"

RolloverFractionfloat64

optional

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.

Specifiersarray

optional

[]V2ContractEditParamsAddRecurringCommitsSpecifier

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. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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.

SubscriptionConfigApplySeatIncreaseConfigV2ContractEditParamsAddRecurringCommitsSubscriptionConfigApplySeatIncreaseConfigSubscriptionIDstringAllocationV2ContractEditParamsAddRecurringCommitsSubscriptionConfigAllocationV2ContractEditParamsAddRecurringCommitsSubscriptionConfig

optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters

ApplySeatIncreaseConfigIsProratedboolV2ContractEditParamsAddRecurringCommitsSubscriptionConfigApplySeatIncreaseConfig

Hide ParametersShow Parameters

IsProratedbool

Indicates whether a mid-period seat increase should be prorated.

SubscriptionIDstring

ID of the subscription to configure on the recurring commit/credit.

AllocationV2ContractEditParamsAddRecurringCommitsSubscriptionConfigAllocationPooledV2ContractEditParamsAddRecurringCommitsSubscriptionConfigAllocationV2ContractEditParamsAddRecurringCommitsSubscriptionConfigAllocation

optional

If set to POOLED, allocation added per seat is pooled across the account.

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCommitsSubscriptionConfigAllocationPooledconst

V2ContractEditParamsAddRecurringCommitsSubscriptionConfigAllocationPooledV2ContractEditParamsAddRecurringCommitsSubscriptionConfigAllocationV2ContractEditParamsAddRecurringCommitsSubscriptionConfigAllocation

"POOLED"

TemporaryIDstring

optional

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

AddRecurringCreditsfield

optional

param.Field[[]V2ContractEditParamsAddRecurringCredit]

Hide ParametersShow Parameters

AccessAmountCreditTypeIDstringUnitPricefloat64Quantityfloat64V2ContractEditParamsAddRecurringCreditsAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters

CreditTypeIDstring

formatuuid

UnitPricefloat64

Quantityfloat64

optional

This field is required unless a subscription is attached via subscription_config.

CommitDurationValuefloat64UnitV2ContractEditParamsAddRecurringCreditsCommitDurationUnitV2ContractEditParamsAddRecurringCreditsCommitDuration

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

Valuefloat64

UnitV2ContractEditParamsAddRecurringCreditsCommitDurationUnitPeriodsV2ContractEditParamsAddRecurringCreditsCommitDurationUnitV2ContractEditParamsAddRecurringCreditsCommitDurationUnit

optional

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCreditsCommitDurationUnitPeriodsconst

V2ContractEditParamsAddRecurringCreditsCommitDurationUnitPeriodsV2ContractEditParamsAddRecurringCreditsCommitDurationUnitV2ContractEditParamsAddRecurringCreditsCommitDurationUnit

"PERIODS"

Priorityfloat64

Will be passed down to the individual commits

ProductIDstring

formatuuid

StartingAtTime

determines the start time for the first commit

formatdate-time

ApplicableProductIDsarray

optional

[]string

Will be passed down to the individual commits

ApplicableProductTagsarray

optional

[]string

Will be passed down to the individual commits

Descriptionstring

optional

Will be passed down to the individual commits

EndingBeforeTime

optional

Determines when the contract will stop creating recurring commits. optional

formatdate-time

HierarchyConfigurationChildAccessV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessV2ContractEditParamsAddRecurringCreditsHierarchyConfiguration

optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters

ChildAccessV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccess

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

"ALL"

V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

"NONE"

V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

TypeV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

V2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

"CONTRACT_IDS"

Namestring

optional

displayed on invoices. will be passed through to the individual commits

minLength1

NetsuiteSalesOrderIDstring

optional

Will be passed down to the individual commits

ProrationV2ContractEditParamsAddRecurringCreditsProrationNoneV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationFirstV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationLastV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationFirstAndLastV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProration

optional

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

V2ContractEditParamsAddRecurringCreditsProrationNoneconst

V2ContractEditParamsAddRecurringCreditsProrationNoneV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationFirstV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationLastV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationFirstAndLastV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProration

"NONE"

V2ContractEditParamsAddRecurringCreditsProrationFirstconst

V2ContractEditParamsAddRecurringCreditsProrationNoneV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationFirstV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationLastV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationFirstAndLastV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProration

"FIRST"

V2ContractEditParamsAddRecurringCreditsProrationLastconst

V2ContractEditParamsAddRecurringCreditsProrationNoneV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationFirstV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationLastV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationFirstAndLastV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProration

"LAST"

V2ContractEditParamsAddRecurringCreditsProrationFirstAndLastconst

V2ContractEditParamsAddRecurringCreditsProrationNoneV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationFirstV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationLastV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProrationFirstAndLastV2ContractEditParamsAddRecurringCreditsProrationV2ContractEditParamsAddRecurringCreditsProration

"FIRST_AND_LAST"

RateTypeV2ContractEditParamsAddRecurringCreditsRateTypeCommitRateV2ContractEditParamsAddRecurringCreditsRateTypeV2ContractEditParamsAddRecurringCreditsRateTypeListRateV2ContractEditParamsAddRecurringCreditsRateTypeV2ContractEditParamsAddRecurringCreditsRateType

optional

Whether the created commits will use the commit rate or list rate

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCreditsRateTypeCommitRateconst

V2ContractEditParamsAddRecurringCreditsRateTypeCommitRateV2ContractEditParamsAddRecurringCreditsRateTypeV2ContractEditParamsAddRecurringCreditsRateTypeListRateV2ContractEditParamsAddRecurringCreditsRateTypeV2ContractEditParamsAddRecurringCreditsRateType

"COMMIT_RATE"

V2ContractEditParamsAddRecurringCreditsRateTypeListRateconst

V2ContractEditParamsAddRecurringCreditsRateTypeCommitRateV2ContractEditParamsAddRecurringCreditsRateTypeV2ContractEditParamsAddRecurringCreditsRateTypeListRateV2ContractEditParamsAddRecurringCreditsRateTypeV2ContractEditParamsAddRecurringCreditsRateType

"LIST_RATE"

RecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyMonthlyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyQuarterlyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyAnnualV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyWeeklyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequency

optional

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

V2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyMonthlyconst

V2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyMonthlyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyQuarterlyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyAnnualV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyWeeklyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequency

"MONTHLY"

V2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyQuarterlyconst

V2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyMonthlyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyQuarterlyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyAnnualV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyWeeklyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequency

"QUARTERLY"

V2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyAnnualconst

V2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyMonthlyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyQuarterlyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyAnnualV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyWeeklyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequency

"ANNUAL"

V2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyWeeklyconst

V2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyMonthlyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyQuarterlyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyAnnualV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyWeeklyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequencyV2ContractEditParamsAddRecurringCreditsRecurrenceFrequency

"WEEKLY"

RolloverFractionfloat64

optional

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.

Specifiersarray

optional

[]V2ContractEditParamsAddRecurringCreditsSpecifier

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. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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.

SubscriptionConfigApplySeatIncreaseConfigV2ContractEditParamsAddRecurringCreditsSubscriptionConfigApplySeatIncreaseConfigSubscriptionIDstringAllocationV2ContractEditParamsAddRecurringCreditsSubscriptionConfigAllocationV2ContractEditParamsAddRecurringCreditsSubscriptionConfig

optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters

ApplySeatIncreaseConfigIsProratedboolV2ContractEditParamsAddRecurringCreditsSubscriptionConfigApplySeatIncreaseConfig

Hide ParametersShow Parameters

IsProratedbool

Indicates whether a mid-period seat increase should be prorated.

SubscriptionIDstring

ID of the subscription to configure on the recurring commit/credit.

AllocationV2ContractEditParamsAddRecurringCreditsSubscriptionConfigAllocationPooledV2ContractEditParamsAddRecurringCreditsSubscriptionConfigAllocationV2ContractEditParamsAddRecurringCreditsSubscriptionConfigAllocation

optional

If set to POOLED, allocation added per seat is pooled across the account.

Hide ParametersShow Parameters

V2ContractEditParamsAddRecurringCreditsSubscriptionConfigAllocationPooledconst

V2ContractEditParamsAddRecurringCreditsSubscriptionConfigAllocationPooledV2ContractEditParamsAddRecurringCreditsSubscriptionConfigAllocationV2ContractEditParamsAddRecurringCreditsSubscriptionConfigAllocation

"POOLED"

TemporaryIDstring

optional

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

AddResellerRoyaltiesfield

optional

param.Field[[]V2ContractEditParamsAddResellerRoyalty]

Hide ParametersShow Parameters

ResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsProServiceV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpProServiceV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerType

Hide ParametersShow Parameters

V2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsconst

V2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsProServiceV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpProServiceV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerType

"AWS"

V2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsProServiceconst

V2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsProServiceV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpProServiceV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerType

"AWS_PRO_SERVICE"

V2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpconst

V2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsProServiceV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpProServiceV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerType

"GCP"

V2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpProServiceconst

V2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeAwsProServiceV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerTypeGcpProServiceV2ContractEditParamsAddResellerRoyaltiesResellerTypeV2ContractEditParamsAddResellerRoyaltiesResellerType

"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.

AwsOptionsAwsAccountNumberstringAwsOfferIDstringAwsPayerReferenceIDstringV2ContractEditParamsAddResellerRoyaltiesAwsOptions

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

GcpOptionsGcpAccountIDstringGcpOfferIDstringV2ContractEditParamsAddResellerRoyaltiesGcpOptions

optional

Hide ParametersShow Parameters

GcpAccountIDstring

optional

GcpOfferIDstring

optional

NetsuiteResellerIDstring

optional

ResellerContractValuefloat64

optional

StartingAtTime

optional

formatdate-time

AddScheduledChargesfield

optional

param.Field[[]V2ContractEditParamsAddScheduledCharge]

Hide ParametersShow Parameters

ProductIDstring

formatuuid

ScheduleCreditTypeIDstringDoNotInvoiceboolRecurringScheduleV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleScheduleItemsarrayV2ContractEditParamsAddScheduledChargesSchedule

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.

RecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionEndingBeforeTimeFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyStartingAtTimeAmountfloat64Quantityfloat64UnitPricefloat64V2ContractEditParamsAddScheduledChargesScheduleRecurringSchedule

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

AmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistribution

Hide ParametersShow Parameters

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionDividedconst

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistribution

"DIVIDED"

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionDividedRoundedconst

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistribution

"DIVIDED_ROUNDED"

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionEachconst

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionDividedV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionDividedRoundedV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionEachV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistributionV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleAmountDistribution

"EACH"

EndingBeforeTime

RFC 3339 timestamp (exclusive).

formatdate-time

FrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequency

Hide ParametersShow Parameters

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyMonthlyconst

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequency

"MONTHLY"

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyQuarterlyconst

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequency

"QUARTERLY"

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencySemiAnnualconst

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequency

"SEMI_ANNUAL"

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyAnnualconst

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequency

"ANNUAL"

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyWeeklyconst

V2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyMonthlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyQuarterlyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencySemiAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyAnnualV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyWeeklyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequencyV2ContractEditParamsAddScheduledChargesScheduleRecurringScheduleFrequency

"WEEKLY"

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

[]V2ContractEditParamsAddScheduledChargesScheduleScheduleItem

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.

AddSpendThresholdConfigurationfield

optional

param.Field[V2ContractEditParamsAddSpendThresholdConfiguration]

Hide ParametersShow Parameters

CommitProductIDstringDescriptionstringNamestringV2ContractEditParamsAddSpendThresholdConfigurationCommit

Hide ParametersShow Parameters

ProductIDstring

The commit product that will be used to generate the line item for commit payment.

Descriptionstring

optional

Namestring

optional

Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.

IsEnabledbool

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.

PaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypePrecalculatedTaxConfigV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigStripeConfigV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfig

Hide ParametersShow Parameters

PaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateType

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

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateType

"NONE"

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateType

"STRIPE"

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPaymentGateType

"EXTERNAL"

PrecalculatedTaxConfigTaxAmountfloat64TaxNamestringV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig

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.

StripeConfigPaymentTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceMetadatamapV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

"INVOICE"

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxType

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

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxType

"NONE"

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxType

"STRIPE"

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxType

"ANROK"

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

V2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsAddSpendThresholdConfigurationPaymentGateConfigTaxType

"PRECALCULATED"

ThresholdAmountfloat64

Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.

AddSubscriptionsfield

optional

param.Field[[]V2ContractEditParamsAddSubscription]

Optional list of subscriptions to add to the contract.

Hide ParametersShow Parameters

CollectionScheduleV2ContractEditParamsAddSubscriptionsCollectionScheduleAdvanceV2ContractEditParamsAddSubscriptionsCollectionScheduleV2ContractEditParamsAddSubscriptionsCollectionScheduleArrearsV2ContractEditParamsAddSubscriptionsCollectionScheduleV2ContractEditParamsAddSubscriptionsCollectionSchedule

Hide ParametersShow Parameters

V2ContractEditParamsAddSubscriptionsCollectionScheduleAdvanceconst

V2ContractEditParamsAddSubscriptionsCollectionScheduleAdvanceV2ContractEditParamsAddSubscriptionsCollectionScheduleV2ContractEditParamsAddSubscriptionsCollectionScheduleArrearsV2ContractEditParamsAddSubscriptionsCollectionScheduleV2ContractEditParamsAddSubscriptionsCollectionSchedule

"ADVANCE"

V2ContractEditParamsAddSubscriptionsCollectionScheduleArrearsconst

V2ContractEditParamsAddSubscriptionsCollectionScheduleAdvanceV2ContractEditParamsAddSubscriptionsCollectionScheduleV2ContractEditParamsAddSubscriptionsCollectionScheduleArrearsV2ContractEditParamsAddSubscriptionsCollectionScheduleV2ContractEditParamsAddSubscriptionsCollectionSchedule

"ARREARS"

InitialQuantityfloat64

ProrationInvoiceBehaviorV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorIsProratedboolV2ContractEditParamsAddSubscriptionsProration

Hide ParametersShow Parameters

InvoiceBehaviorV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorBillImmediatelyV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorBillOnNextCollectionDateV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorV2ContractEditParamsAddSubscriptionsProrationInvoiceBehavior

optional

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

V2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorBillImmediatelyconst

V2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorBillImmediatelyV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorBillOnNextCollectionDateV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorV2ContractEditParamsAddSubscriptionsProrationInvoiceBehavior

"BILL_IMMEDIATELY"

V2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorBillOnNextCollectionDateconst

V2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorBillImmediatelyV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorBillOnNextCollectionDateV2ContractEditParamsAddSubscriptionsProrationInvoiceBehaviorV2ContractEditParamsAddSubscriptionsProrationInvoiceBehavior

"BILL_ON_NEXT_COLLECTION_DATE"

IsProratedbool

optional

Indicates if the partial period will be prorated or charged a full amount.

SubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyProductIDstringV2ContractEditParamsAddSubscriptionsSubscriptionRate

Hide ParametersShow Parameters

BillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyMonthlyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyQuarterlyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyAnnualV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyWeeklyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequency

Frequency to bill subscription with. Together with product_id, must match existing rate on the rate card.

Hide ParametersShow Parameters

V2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyMonthlyconst

V2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyMonthlyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyQuarterlyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyAnnualV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyWeeklyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequency

"MONTHLY"

V2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyQuarterlyconst

V2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyMonthlyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyQuarterlyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyAnnualV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyWeeklyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequency

"QUARTERLY"

V2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyAnnualconst

V2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyMonthlyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyQuarterlyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyAnnualV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyWeeklyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequency

"ANNUAL"

V2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyWeeklyconst

V2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyMonthlyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyQuarterlyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyAnnualV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyWeeklyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequencyV2ContractEditParamsAddSubscriptionsSubscriptionRateBillingFrequency

"WEEKLY"

ProductIDstring

Must be subscription type product

formatuuid

CustomFieldsmap

optional

map[string, string]

Descriptionstring

optional

EndingBeforeTime

optional

Exclusive end time for the subscription. If not provided, subscription inherits contract end date.

formatdate-time

Namestring

optional

StartingAtTime

optional

Inclusive start time for the subscription. If not provided, defaults to contract start date

formatdate-time

TemporaryIDstring

optional

A temporary ID used to reference the subscription in recurring commit/credit subscription configs created within the same payload.

AllowContractEndingBeforeFinalizedInvoicefield

optional

param.Field[bool]

If true, allows setting the contract end date earlier than the end_timestamp of existing finalized invoices. Finalized invoices will be unchanged; if you want to incorporate the new end date, you can void and regenerate finalized usage invoices. Defaults to true.

ArchiveCommitsfield

optional

param.Field[[]V2ContractEditParamsArchiveCommit]

IDs of commits to archive

Hide ParametersShow Parameters

IDstring

formatuuid

ArchiveCreditsfield

optional

param.Field[[]V2ContractEditParamsArchiveCredit]

IDs of credits to archive

Hide ParametersShow Parameters

IDstring

formatuuid

ArchiveScheduledChargesfield

optional

param.Field[[]V2ContractEditParamsArchiveScheduledCharge]

IDs of scheduled charges to archive

Hide ParametersShow Parameters

IDstring

formatuuid

RemoveOverridesfield

optional

param.Field[[]V2ContractEditParamsRemoveOverride]

IDs of overrides to remove

Hide ParametersShow Parameters

IDstring

formatuuid

UpdateCommitsfield

optional

param.Field[[]V2ContractEditParamsUpdateCommit]

Hide ParametersShow Parameters

CommitIDstring

formatuuid

AccessScheduleAddScheduleItemsarrayRemoveScheduleItemsarrayUpdateScheduleItemsarrayV2ContractEditParamsUpdateCommitsAccessSchedule

optional

Hide ParametersShow Parameters

AddScheduleItemsarray

optional

[]V2ContractEditParamsUpdateCommitsAccessScheduleAddScheduleItem

Hide ParametersShow Parameters

Amountfloat64

EndingBeforeTime

formatdate-time

StartingAtTime

formatdate-time

RemoveScheduleItemsarray

optional

[]V2ContractEditParamsUpdateCommitsAccessScheduleRemoveScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

UpdateScheduleItemsarray

optional

[]V2ContractEditParamsUpdateCommitsAccessScheduleUpdateScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

Amountfloat64

optional

EndingBeforeTime

optional

formatdate-time

StartingAtTime

optional

formatdate-time

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.

HierarchyConfigurationChildAccessV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessV2ContractEditParamsUpdateCommitsHierarchyConfiguration

optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters

ChildAccessV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccess

Hide ParametersShow Parameters

V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

Hide ParametersShow Parameters

V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

"ALL"

V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

Hide ParametersShow Parameters

V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

"NONE"

V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

TypeV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

Hide ParametersShow Parameters

V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

V2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

"CONTRACT_IDS"

InvoiceScheduleAddScheduleItemsarrayRemoveScheduleItemsarrayUpdateScheduleItemsarrayV2ContractEditParamsUpdateCommitsInvoiceSchedule

optional

Hide ParametersShow Parameters

AddScheduleItemsarray

optional

[]V2ContractEditParamsUpdateCommitsInvoiceScheduleAddScheduleItem

Hide ParametersShow Parameters

TimestampTime

formatdate-time

Amountfloat64

optional

Quantityfloat64

optional

UnitPricefloat64

optional

RemoveScheduleItemsarray

optional

[]V2ContractEditParamsUpdateCommitsInvoiceScheduleRemoveScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

UpdateScheduleItemsarray

optional

[]V2ContractEditParamsUpdateCommitsInvoiceScheduleUpdateScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

Amountfloat64

optional

Quantityfloat64

optional

TimestampTime

optional

formatdate-time

UnitPricefloat64

optional

NetsuiteSalesOrderIDstring

optional

Priorityfloat64

optional

ProductIDstring

optional

formatuuid

RolloverFractionfloat64

optional

UpdateContractEndDatefield

optional

param.Field[Time]

RFC 3339 timestamp indicating when the contract will end (exclusive).

formatdate-time

UpdateContractNamefield

optional

param.Field[string]

Value to update the contract name to. If not provided, the contract name will remain unchanged.

UpdateCreditsfield

optional

param.Field[[]V2ContractEditParamsUpdateCredit]

Hide ParametersShow Parameters

CreditIDstring

formatuuid

AccessScheduleAddScheduleItemsarrayRemoveScheduleItemsarrayUpdateScheduleItemsarrayV2ContractEditParamsUpdateCreditsAccessSchedule

optional

Hide ParametersShow Parameters

AddScheduleItemsarray

optional

[]V2ContractEditParamsUpdateCreditsAccessScheduleAddScheduleItem

Hide ParametersShow Parameters

Amountfloat64

EndingBeforeTime

formatdate-time

StartingAtTime

formatdate-time

RemoveScheduleItemsarray

optional

[]V2ContractEditParamsUpdateCreditsAccessScheduleRemoveScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

UpdateScheduleItemsarray

optional

[]V2ContractEditParamsUpdateCreditsAccessScheduleUpdateScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

Amountfloat64

optional

EndingBeforeTime

optional

formatdate-time

StartingAtTime

optional

formatdate-time

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.

HierarchyConfigurationChildAccessV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessV2ContractEditParamsUpdateCreditsHierarchyConfiguration

optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters

ChildAccessV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccess

Hide ParametersShow Parameters

V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

Hide ParametersShow Parameters

V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType

"ALL"

V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

TypeV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

Hide ParametersShow Parameters

V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType

"NONE"

V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

TypeV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

Hide ParametersShow Parameters

V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

V2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeV2ContractEditParamsUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType

"CONTRACT_IDS"

NetsuiteSalesOrderIDstring

optional

Priorityfloat64

optional

ProductIDstring

optional

formatuuid

UpdatePrepaidBalanceThresholdConfigurationfield

optional

param.Field[V2ContractEditParamsUpdatePrepaidBalanceThresholdConfiguration]

Hide ParametersShow Parameters

CommitApplicableProductIDsarrayApplicableProductTagsarrayDescriptionstringNamestringProductIDstringSpecifiersarrayV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationCommit

optional

Hide ParametersShow Parameters

ApplicableProductIDsarray

optional

[]string

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

ApplicableProductTagsarray

optional

[]string

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

Descriptionstring

optional

Namestring

optional

Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.

ProductIDstring

optional

The commit product that will be used to generate the line item for commit payment.

Specifiersarray

optional

[]V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationCommitSpecifier

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. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

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.

CustomCreditTypeIDstring

optional

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.

formatuuid

IsEnabledbool

optional

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.

PaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypePrecalculatedTaxConfigV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigStripeConfigV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfig

optional

Hide ParametersShow Parameters

PaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType

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

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType

"NONE"

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType

"STRIPE"

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType

"EXTERNAL"

PrecalculatedTaxConfigTaxAmountfloat64TaxNamestringV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig

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.

StripeConfigPaymentTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceMetadatamapV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

"INVOICE"

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType

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

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType

"NONE"

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType

"STRIPE"

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType

"ANROK"

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

V2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType

"PRECALCULATED"

RechargeToAmountfloat64

optional

Specify the amount the balance should be recharged to.

ThresholdAmountfloat64

optional

Specify the threshold amount for the contract. Each time the contract's balance lowers to this amount, a threshold charge will be initiated.

UpdateRecurringCommitsfield

optional

param.Field[[]V2ContractEditParamsUpdateRecurringCommit]

Edits to these recurring commits will only affect commits whose access schedules has not started. Expired commits, and commits with an active access schedule will remain unchanged.

Hide ParametersShow Parameters

RecurringCommitIDstring

formatuuid

AccessAmountQuantityfloat64UnitPricefloat64V2ContractEditParamsUpdateRecurringCommitsAccessAmount

optional

Hide ParametersShow Parameters

Quantityfloat64

optional

UnitPricefloat64

optional

EndingBeforeTime

optional

formatdate-time

InvoiceAmountQuantityfloat64UnitPricefloat64V2ContractEditParamsUpdateRecurringCommitsInvoiceAmount

optional

Hide ParametersShow Parameters

Quantityfloat64

optional

UnitPricefloat64

optional

UpdateRecurringCreditsfield

optional

param.Field[[]V2ContractEditParamsUpdateRecurringCredit]

Edits to these recurring credits will only affect credits whose access schedules has not started. Expired credits, and credits with an active access schedule will remain unchanged.

Hide ParametersShow Parameters

RecurringCreditIDstring

formatuuid

AccessAmountQuantityfloat64UnitPricefloat64V2ContractEditParamsUpdateRecurringCreditsAccessAmount

optional

Hide ParametersShow Parameters

Quantityfloat64

optional

UnitPricefloat64

optional

EndingBeforeTime

optional

formatdate-time

UpdateScheduledChargesfield

optional

param.Field[[]V2ContractEditParamsUpdateScheduledCharge]

Hide ParametersShow Parameters

ScheduledChargeIDstring

formatuuid

InvoiceScheduleAddScheduleItemsarrayRemoveScheduleItemsarrayUpdateScheduleItemsarrayV2ContractEditParamsUpdateScheduledChargesInvoiceSchedule

optional

Hide ParametersShow Parameters

AddScheduleItemsarray

optional

[]V2ContractEditParamsUpdateScheduledChargesInvoiceScheduleAddScheduleItem

Hide ParametersShow Parameters

TimestampTime

formatdate-time

Amountfloat64

optional

Quantityfloat64

optional

UnitPricefloat64

optional

RemoveScheduleItemsarray

optional

[]V2ContractEditParamsUpdateScheduledChargesInvoiceScheduleRemoveScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

UpdateScheduleItemsarray

optional

[]V2ContractEditParamsUpdateScheduledChargesInvoiceScheduleUpdateScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

Amountfloat64

optional

Quantityfloat64

optional

TimestampTime

optional

formatdate-time

UnitPricefloat64

optional

NetsuiteSalesOrderIDstring

optional

UpdateSpendThresholdConfigurationfield

optional

param.Field[V2ContractEditParamsUpdateSpendThresholdConfiguration]

Hide ParametersShow Parameters

CommitDescriptionstringNamestringProductIDstringV2ContractEditParamsUpdateSpendThresholdConfigurationCommit

optional

Hide ParametersShow Parameters

Descriptionstring

optional

Namestring

optional

Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name.

ProductIDstring

optional

The commit product that will be used to generate the line item for commit payment.

IsEnabledbool

optional

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.

PaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypePrecalculatedTaxConfigV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigStripeConfigV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfig

optional

Hide ParametersShow Parameters

PaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateType

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

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateType

"NONE"

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateType

"STRIPE"

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateType

"EXTERNAL"

PrecalculatedTaxConfigTaxAmountfloat64TaxNamestringV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig

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.

StripeConfigPaymentTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceMetadatamapV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

"INVOICE"

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxType

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

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxType

"NONE"

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxType

"STRIPE"

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxType

"ANROK"

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

V2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeV2ContractEditParamsUpdateSpendThresholdConfigurationPaymentGateConfigTaxType

"PRECALCULATED"

ThresholdAmountfloat64

optional

Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated.

UpdateSubscriptionsfield

optional

param.Field[[]V2ContractEditParamsUpdateSubscription]

Optional list of subscriptions to update.

Hide ParametersShow Parameters

SubscriptionIDstring

formatuuid

EndingBeforeTime

optional

formatdate-time

QuantityUpdatesarray

optional

[]V2ContractEditParamsUpdateSubscriptionsQuantityUpdate

Quantity changes are applied on the effective date based on the order which they are sent. For example, if I scheduled the quantity to be 12 on May 21 and then scheduled a quantity delta change of -1, the result from that day would be 11.

Hide ParametersShow Parameters

StartingAtTime

formatdate-time

Quantityfloat64

optional

The new quantity for the subscription. Must be provided if quantity_delta is not provided. Must be non-negative.

QuantityDeltafloat64

optional

The delta to add to the subscription's quantity. Must be provided if quantity is not provided. Can't be zero. It also can't result in a negative quantity on the subscription.

Returns

V2ContractEditResponsestruct

Hide ParametersShow Parameters

DataIDstringID

HTTPTypeScriptPythonGoRubyTerraform

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.V2.Contracts.Edit(context.TODO(), metronome.V2ContractEditParams{
    ContractID: metronome.F("d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"),
    CustomerID: metronome.F("13117714-3f05-48e5-a6e9-a66093f13b4d"),
    AddOverrides: metronome.F([]metronome.V2ContractEditParamsAddOverride{metronome.V2ContractEditParamsAddOverride{
      Type: metronome.F(metronome.V2ContractEditParamsAddOverridesTypeMultiplier),
      StartingAt: metronome.F(time.Now()),
      ProductID: metronome.F("d4fc086c-d8e5-4091-a235-fbba5da4ec14"),
      Multiplier: metronome.F(2.000000),
      Priority: metronome.F(100.000000),
    }}),
    AddScheduledCharges: metronome.F([]metronome.V2ContractEditParamsAddScheduledCharge{metronome.V2ContractEditParamsAddScheduledCharge{
      ProductID: metronome.F("2e30f074-d04c-412e-a134-851ebfa5ceb2"),
      Schedule: metronome.F(metronome.V2ContractEditParamsAddScheduledChargesSchedule{
        ScheduleItems: metronome.F([]metronome.V2ContractEditParamsAddScheduledChargesScheduleScheduleItem{metronome.V2ContractEditParamsAddScheduledChargesScheduleScheduleItem{
          Timestamp: metronome.F(time.Now()),
          UnitPrice: metronome.F(1000000.000000),
          Quantity: metronome.F(1.000000),
        }}),
      }),
    }}),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

200 Example

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