Get Edit History

API Reference

Contracts

Get contract edit history

client.V2.Contracts.GetEditHistory(ctx, body) (*, error)

post/v2/contracts/getEditHistory

Get the edit history of a specific contract. Contract editing must be enabled to use this endpoint.

Parameters

body

Hide ParametersShow Parameters

ContractIDfield

param.Field[string]

formatuuid

CustomerIDfield

param.Field[string]

formatuuid

Returns

V2ContractGetEditHistoryResponsestruct

Hide ParametersShow Parameters

Dataarray

[]V2ContractGetEditHistoryResponseData

Hide ParametersShow Parameters

IDstring

formatuuid

AddCommitsarray

optional

[]V2ContractGetEditHistoryResponseDataAddCommit

Hide ParametersShow Parameters

IDstring

formatuuid

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCommitsTypePrepaidconst

"PREPAID"

V2ContractGetEditHistoryResponseDataAddCommitsTypePostpaidconst

"POSTPAID"

AccessSchedule

optional

The schedule that the customer will gain access to the credits purposed with this commit.

ApplicableProductIDsarray

optional

[]string

ApplicableProductTagsarray

optional

[]string

Descriptionstring

optional

HierarchyConfiguration

optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V2ContractGetEditHistoryResponseDataAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

InvoiceSchedule

optional

The schedule that the customer will be invoiced for this commit.

Namestring

optional

NetsuiteSalesOrderIDstring

optional

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

Priorityfloat64

optional

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

RateType

optional

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCommitsRateTypeCommitRateconst

"COMMIT_RATE"

V2ContractGetEditHistoryResponseDataAddCommitsRateTypeListRateconst

"LIST_RATE"

RolloverFractionfloat64

optional

SalesforceOpportunityIDstring

optional

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

Specifiersarray

optional

[]V2ContractGetEditHistoryResponseDataAddCommitsSpecifier

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.

AddCreditsarray

optional

[]V2ContractGetEditHistoryResponseDataAddCredit

Hide ParametersShow Parameters

IDstring

formatuuid

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCreditsTypeCreditconst

"CREDIT"

AccessSchedule

optional

The schedule that the customer will gain access to the credits.

ApplicableProductIDsarray

optional

[]string

ApplicableProductTagsarray

optional

[]string

Descriptionstring

optional

HierarchyConfiguration

optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V2ContractGetEditHistoryResponseDataAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

Namestring

optional

NetsuiteSalesOrderIDstring

optional

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

Priorityfloat64

optional

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

SalesforceOpportunityIDstring

optional

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

Specifiersarray

optional

[]V2ContractGetEditHistoryResponseDataAddCreditsSpecifier

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.

AddDiscountsarray

optional

[]

Hide ParametersShow Parameters

IDstring

formatuuid

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Schedule

CustomFieldsmap

optional

map[string, string]

Namestring

optional

minLength1

NetsuiteSalesOrderIDstring

optional

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

AddOverridesarray

optional

[]V2ContractGetEditHistoryResponseDataAddOverride

Hide ParametersShow Parameters

IDstring

formatuuid

StartingAtTime

formatdate-time

ApplicableProductTagsarray

optional

[]string

EndingBeforeTime

optional

formatdate-time

Entitledbool

optional

IsCommitSpecificbool

optional

Multiplierfloat64

optional

OverrideSpecifiersarray

optional

[]V2ContractGetEditHistoryResponseDataAddOverridesOverrideSpecifier

Hide ParametersShow Parameters

BillingFrequency

optional

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddOverridesOverrideSpecifiersBillingFrequencyMonthlyconst

"MONTHLY"

V2ContractGetEditHistoryResponseDataAddOverridesOverrideSpecifiersBillingFrequencyQuarterlyconst

"QUARTERLY"

V2ContractGetEditHistoryResponseDataAddOverridesOverrideSpecifiersBillingFrequencyAnnualconst

"ANNUAL"

V2ContractGetEditHistoryResponseDataAddOverridesOverrideSpecifiersBillingFrequencyWeeklyconst

"WEEKLY"

CommitIDsarray

optional

[]string

PresentationGroupValuesmap

optional

map[string, string]

PricingGroupValuesmap

optional

map[string, string]

ProductIDstring

optional

formatuuid

ProductTagsarray

optional

[]string

RecurringCommitIDsarray

optional

[]string

RecurringCreditIDsarray

optional

[]string

OverrideTiersarray

optional

[]V2ContractGetEditHistoryResponseDataAddOverridesOverrideTier

Hide ParametersShow Parameters

Multiplierfloat64

Sizefloat64

optional

OverwriteRate

optional

Hide ParametersShow Parameters

RateType

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddOverridesOverwriteRateRateTypeFlatconst

"FLAT"

V2ContractGetEditHistoryResponseDataAddOverridesOverwriteRateRateTypePercentageconst

"PERCENTAGE"

V2ContractGetEditHistoryResponseDataAddOverridesOverwriteRateRateTypeSubscriptionconst

"SUBSCRIPTION"

V2ContractGetEditHistoryResponseDataAddOverridesOverwriteRateRateTypeTieredconst

"TIERED"

V2ContractGetEditHistoryResponseDataAddOverridesOverwriteRateRateTypeCustomconst

"CUSTOM"

CreditType

optional

CustomRatemap

optional

map[string, unknown]

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

IsProratedbool

optional

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

Pricefloat64

optional

Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.

Quantityfloat64

optional

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

Tiersarray

optional

[]

Only set for TIERED rate_type.

Hide ParametersShow Parameters

Pricefloat64

Sizefloat64

optional

Priorityfloat64

optional

Product

optional

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Target

optional

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddOverridesTargetCommitRateconst

"COMMIT_RATE"

V2ContractGetEditHistoryResponseDataAddOverridesTargetListRateconst

"LIST_RATE"

Type

optional

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddOverridesTypeOverwriteconst

"OVERWRITE"

V2ContractGetEditHistoryResponseDataAddOverridesTypeMultiplierconst

"MULTIPLIER"

V2ContractGetEditHistoryResponseDataAddOverridesTypeTieredconst

"TIERED"

AddPrepaidBalanceThresholdConfiguration

optional

Hide ParametersShow Parameters

Commit

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

[]V2ContractGetEditHistoryResponseDataAddPrepaidBalanceThresholdConfigurationCommitSpecifier

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.

PaymentGateConfig

Hide ParametersShow Parameters

PaymentGateType

Gate access to the commit balance based on successful collection of payment. Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to facilitate payment using your own payment integration. Select NONE if you do not wish to payment gate the commit balance.

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

"STRIPE"

V2ContractGetEditHistoryResponseDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

"EXTERNAL"

PrecalculatedTaxConfig

optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

TaxAmountfloat64

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

TaxNamestring

optional

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

StripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

"INVOICE"

V2ContractGetEditHistoryResponseDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxType

optional

Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

"STRIPE"

V2ContractGetEditHistoryResponseDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

"ANROK"

V2ContractGetEditHistoryResponseDataAddPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

"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

AddProServicesarray

optional

[]

Hide ParametersShow Parameters

IDstring

formatuuid

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.

AddRecurringCommitsarray

optional

[]V2ContractGetEditHistoryResponseDataAddRecurringCommit

Hide ParametersShow Parameters

IDstring

formatuuid

AccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters

CreditTypeIDstring

formatuuid

UnitPricefloat64

Quantityfloat64

optional

CommitDuration

The amount of time the created commits will be valid for

Hide ParametersShow Parameters

Valuefloat64

Unit

optional

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCommitsCommitDurationUnitPeriodsconst

"PERIODS"

Priorityfloat64

Will be passed down to the individual commits

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

RateType

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

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCommitsRateTypeCommitRateconst

"COMMIT_RATE"

V2ContractGetEditHistoryResponseDataAddRecurringCommitsRateTypeListRateconst

"LIST_RATE"

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

Contract

optional

Hide ParametersShow Parameters

IDstring

formatuuid

Descriptionstring

optional

Will be passed down to the individual commits

EndingBeforeTime

optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time

HierarchyConfiguration

optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V2ContractGetEditHistoryResponseDataAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

InvoiceAmount

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

NetsuiteSalesOrderIDstring

optional

Will be passed down to the individual commits

Proration

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

V2ContractGetEditHistoryResponseDataAddRecurringCommitsProrationNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataAddRecurringCommitsProrationFirstconst

"FIRST"

V2ContractGetEditHistoryResponseDataAddRecurringCommitsProrationLastconst

"LAST"

V2ContractGetEditHistoryResponseDataAddRecurringCommitsProrationFirstAndLastconst

"FIRST_AND_LAST"

RecurrenceFrequency

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

V2ContractGetEditHistoryResponseDataAddRecurringCommitsRecurrenceFrequencyMonthlyconst

"MONTHLY"

V2ContractGetEditHistoryResponseDataAddRecurringCommitsRecurrenceFrequencyQuarterlyconst

"QUARTERLY"

V2ContractGetEditHistoryResponseDataAddRecurringCommitsRecurrenceFrequencyAnnualconst

"ANNUAL"

V2ContractGetEditHistoryResponseDataAddRecurringCommitsRecurrenceFrequencyWeeklyconst

"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

[]V2ContractGetEditHistoryResponseDataAddRecurringCommitsSpecifier

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.

SubscriptionConfig

optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters

Allocation

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCommitsSubscriptionConfigAllocationIndividualconst

"INDIVIDUAL"

V2ContractGetEditHistoryResponseDataAddRecurringCommitsSubscriptionConfigAllocationPooledconst

"POOLED"

ApplySeatIncreaseConfig

Hide ParametersShow Parameters

IsProratedbool

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

SubscriptionIDstring

formatuuid

AddRecurringCreditsarray

optional

[]V2ContractGetEditHistoryResponseDataAddRecurringCredit

Hide ParametersShow Parameters

IDstring

formatuuid

AccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters

CreditTypeIDstring

formatuuid

UnitPricefloat64

Quantityfloat64

optional

CommitDuration

The amount of time the created commits will be valid for

Hide ParametersShow Parameters

Valuefloat64

Unit

optional

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCreditsCommitDurationUnitPeriodsconst

"PERIODS"

Priorityfloat64

Will be passed down to the individual commits

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

RateType

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

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCreditsRateTypeCommitRateconst

"COMMIT_RATE"

V2ContractGetEditHistoryResponseDataAddRecurringCreditsRateTypeListRateconst

"LIST_RATE"

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

Contract

optional

Hide ParametersShow Parameters

IDstring

formatuuid

Descriptionstring

optional

Will be passed down to the individual commits

EndingBeforeTime

optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time

HierarchyConfiguration

optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V2ContractGetEditHistoryResponseDataAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

Namestring

optional

Displayed on invoices. Will be passed through to the individual commits

NetsuiteSalesOrderIDstring

optional

Will be passed down to the individual commits

Proration

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

V2ContractGetEditHistoryResponseDataAddRecurringCreditsProrationNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataAddRecurringCreditsProrationFirstconst

"FIRST"

V2ContractGetEditHistoryResponseDataAddRecurringCreditsProrationLastconst

"LAST"

V2ContractGetEditHistoryResponseDataAddRecurringCreditsProrationFirstAndLastconst

"FIRST_AND_LAST"

RecurrenceFrequency

optional

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCreditsRecurrenceFrequencyMonthlyconst

"MONTHLY"

V2ContractGetEditHistoryResponseDataAddRecurringCreditsRecurrenceFrequencyQuarterlyconst

"QUARTERLY"

V2ContractGetEditHistoryResponseDataAddRecurringCreditsRecurrenceFrequencyAnnualconst

"ANNUAL"

V2ContractGetEditHistoryResponseDataAddRecurringCreditsRecurrenceFrequencyWeeklyconst

"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

[]V2ContractGetEditHistoryResponseDataAddRecurringCreditsSpecifier

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.

SubscriptionConfig

optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters

Allocation

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddRecurringCreditsSubscriptionConfigAllocationIndividualconst

"INDIVIDUAL"

V2ContractGetEditHistoryResponseDataAddRecurringCreditsSubscriptionConfigAllocationPooledconst

"POOLED"

ApplySeatIncreaseConfig

Hide ParametersShow Parameters

IsProratedbool

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

SubscriptionIDstring

formatuuid

AddResellerRoyaltiesarray

optional

[]V2ContractGetEditHistoryResponseDataAddResellerRoyalty

Hide ParametersShow Parameters

ResellerType

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddResellerRoyaltiesResellerTypeAwsconst

"AWS"

V2ContractGetEditHistoryResponseDataAddResellerRoyaltiesResellerTypeAwsProServiceconst

"AWS_PRO_SERVICE"

V2ContractGetEditHistoryResponseDataAddResellerRoyaltiesResellerTypeGcpconst

"GCP"

V2ContractGetEditHistoryResponseDataAddResellerRoyaltiesResellerTypeGcpProServiceconst

"GCP_PRO_SERVICE"

ApplicableProductIDsarray

optional

[]string

ApplicableProductTagsarray

optional

[]string

AwsAccountNumberstring

optional

AwsOfferIDstring

optional

AwsPayerReferenceIDstring

optional

EndingBeforeTime

optional

formatdate-time

Fractionfloat64

optional

GcpAccountIDstring

optional

GcpOfferIDstring

optional

NetsuiteResellerIDstring

optional

ResellerContractValuefloat64

optional

StartingAtTime

optional

formatdate-time

AddScheduledChargesarray

optional

[]V2ContractGetEditHistoryResponseDataAddScheduledCharge

Hide ParametersShow Parameters

IDstring

formatuuid

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Schedule

Namestring

optional

displayed on invoices

minLength1

NetsuiteSalesOrderIDstring

optional

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

AddSpendThresholdConfiguration

optional

Hide ParametersShow Parameters

Commit

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.

PaymentGateConfig

Hide ParametersShow Parameters

PaymentGateType

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

"STRIPE"

V2ContractGetEditHistoryResponseDataAddSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

"EXTERNAL"

PrecalculatedTaxConfig

optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

TaxAmountfloat64

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

TaxNamestring

optional

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

StripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

"INVOICE"

V2ContractGetEditHistoryResponseDataAddSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxType

optional

Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataAddSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

"STRIPE"

V2ContractGetEditHistoryResponseDataAddSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

"ANROK"

V2ContractGetEditHistoryResponseDataAddSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

"PRECALCULATED"

ThresholdAmountfloat64

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

AddSubscriptionsarray

optional

[]V2ContractGetEditHistoryResponseDataAddSubscription

List of subscriptions on the contract.

Hide ParametersShow Parameters

CollectionSchedule

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddSubscriptionsCollectionScheduleAdvanceconst

"ADVANCE"

V2ContractGetEditHistoryResponseDataAddSubscriptionsCollectionScheduleArrearsconst

"ARREARS"

Proration

Hide ParametersShow Parameters

InvoiceBehavior

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddSubscriptionsProrationInvoiceBehaviorBillImmediatelyconst

"BILL_IMMEDIATELY"

V2ContractGetEditHistoryResponseDataAddSubscriptionsProrationInvoiceBehaviorBillOnNextCollectionDateconst

"BILL_ON_NEXT_COLLECTION_DATE"

IsProratedbool

QuantitySchedulearray

[]V2ContractGetEditHistoryResponseDataAddSubscriptionsQuantitySchedule

List of quantity schedule items for the subscription. Only includes the current quantity and future quantity changes.

Hide ParametersShow Parameters

Quantityfloat64

StartingAtTime

formatdate-time

EndingBeforeTime

optional

formatdate-time

StartingAtTime

formatdate-time

SubscriptionRate

Hide ParametersShow Parameters

BillingFrequency

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataAddSubscriptionsSubscriptionRateBillingFrequencyMonthlyconst

"MONTHLY"

V2ContractGetEditHistoryResponseDataAddSubscriptionsSubscriptionRateBillingFrequencyQuarterlyconst

"QUARTERLY"

V2ContractGetEditHistoryResponseDataAddSubscriptionsSubscriptionRateBillingFrequencyAnnualconst

"ANNUAL"

V2ContractGetEditHistoryResponseDataAddSubscriptionsSubscriptionRateBillingFrequencyWeeklyconst

"WEEKLY"

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

IDstring

optional

formatuuid

CustomFieldsmap

optional

map[string, string]

Descriptionstring

optional

EndingBeforeTime

optional

formatdate-time

FiatCreditTypeIDstring

optional

formatuuid

Namestring

optional

AddUsageFiltersarray

optional

[]V2ContractGetEditHistoryResponseDataAddUsageFilter

Hide ParametersShow Parameters

GroupKeystring

GroupValuesarray

[]string

StartingAtTime

This will match contract starting_at value if usage filter is active from the beginning of the contract.

formatdate-time

EndingBeforeTime

optional

This will match contract ending_before value if usage filter is active until the end of the contract. It will be undefined if the contract is open-ended.

formatdate-time

ArchiveCommitsarray

optional

[]V2ContractGetEditHistoryResponseDataArchiveCommit

Hide ParametersShow Parameters

IDstring

formatuuid

ArchiveCreditsarray

optional

[]V2ContractGetEditHistoryResponseDataArchiveCredit

Hide ParametersShow Parameters

IDstring

formatuuid

ArchiveScheduledChargesarray

optional

[]V2ContractGetEditHistoryResponseDataArchiveScheduledCharge

Hide ParametersShow Parameters

IDstring

formatuuid

RemoveOverridesarray

optional

[]V2ContractGetEditHistoryResponseDataRemoveOverride

Hide ParametersShow Parameters

IDstring

formatuuid

TimestampTime

optional

formatdate-time

UpdateCommitsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCommit

Hide ParametersShow Parameters

IDstring

formatuuid

AccessSchedule

optional

Hide ParametersShow Parameters

AddScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCommitsAccessScheduleAddScheduleItem

Hide ParametersShow Parameters

Amountfloat64

EndingBeforeTime

RFC 3339 timestamp (exclusive)

formatdate-time

StartingAtTime

RFC 3339 timestamp (inclusive)

formatdate-time

RemoveScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCommitsAccessScheduleRemoveScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

UpdateScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCommitsAccessScheduleUpdateScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

Amountfloat64

optional

EndingBeforeTime

optional

RFC 3339 timestamp (exclusive)

formatdate-time

StartingAtTime

optional

RFC 3339 timestamp (inclusive)

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.

HierarchyConfiguration

optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V2ContractGetEditHistoryResponseDataUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

InvoiceSchedule

optional

Hide ParametersShow Parameters

AddScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCommitsInvoiceScheduleAddScheduleItem

Hide ParametersShow Parameters

TimestampTime

formatdate-time

Amountfloat64

optional

Quantityfloat64

optional

UnitPricefloat64

optional

RemoveScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCommitsInvoiceScheduleRemoveScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

UpdateScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCommitsInvoiceScheduleUpdateScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

Amountfloat64

optional

Quantityfloat64

optional

TimestampTime

optional

formatdate-time

UnitPricefloat64

optional

Namestring

optional

NetsuiteSalesOrderIDstring

optional

Priorityfloat64

optional

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

ProductIDstring

optional

formatuuid

RolloverFractionfloat64

optional

Specifiersarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCommitsSpecifier

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.

UpdateContractEndDateTime

optional

formatdate-time

UpdateContractNamestring

optional

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

UpdateCreditsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCredit

Hide ParametersShow Parameters

IDstring

formatuuid

AccessSchedule

optional

Hide ParametersShow Parameters

AddScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCreditsAccessScheduleAddScheduleItem

Hide ParametersShow Parameters

Amountfloat64

EndingBeforeTime

RFC 3339 timestamp (exclusive)

formatdate-time

StartingAtTime

RFC 3339 timestamp (inclusive)

formatdate-time

RemoveScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCreditsAccessScheduleRemoveScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

UpdateScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateCreditsAccessScheduleUpdateScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

Amountfloat64

optional

EndingBeforeTime

optional

RFC 3339 timestamp (exclusive)

formatdate-time

StartingAtTime

optional

RFC 3339 timestamp (inclusive)

formatdate-time

HierarchyConfiguration

optional

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V2ContractGetEditHistoryResponseDataUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

Namestring

optional

NetsuiteSalesOrderIDstring

optional

Priorityfloat64

optional

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

RolloverFractionfloat64

optional

UpdateDiscountsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateDiscount

Hide ParametersShow Parameters

IDstring

formatuuid

CustomFieldsmap

optional

map[string, string]

Namestring

optional

NetsuiteSalesOrderIDstring

optional

Schedule

optional

Must provide either schedule_items or recurring_schedule.

Hide ParametersShow Parameters

CreditTypeIDstring

optional

Defaults to USD (cents) if not passed.

formatuuid

DoNotInvoicebool

optional

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

RecurringSchedule

optional

Enter the unit price and quantity for the charge or instead only send the amount. If amount is sent, the unit price is assumed to be the amount and quantity is inferred to be 1.

Hide ParametersShow Parameters

AmountDistribution

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateDiscountsScheduleRecurringScheduleAmountDistributionDividedconst

"DIVIDED"

V2ContractGetEditHistoryResponseDataUpdateDiscountsScheduleRecurringScheduleAmountDistributionDividedRoundedconst

"DIVIDED_ROUNDED"

V2ContractGetEditHistoryResponseDataUpdateDiscountsScheduleRecurringScheduleAmountDistributionEachconst

"EACH"

EndingBeforeTime

RFC 3339 timestamp (exclusive).

formatdate-time

Frequency

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateDiscountsScheduleRecurringScheduleFrequencyMonthlyconst

"MONTHLY"

V2ContractGetEditHistoryResponseDataUpdateDiscountsScheduleRecurringScheduleFrequencyQuarterlyconst

"QUARTERLY"

V2ContractGetEditHistoryResponseDataUpdateDiscountsScheduleRecurringScheduleFrequencySemiAnnualconst

"SEMI_ANNUAL"

V2ContractGetEditHistoryResponseDataUpdateDiscountsScheduleRecurringScheduleFrequencyAnnualconst

"ANNUAL"

V2ContractGetEditHistoryResponseDataUpdateDiscountsScheduleRecurringScheduleFrequencyWeeklyconst

"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

[]V2ContractGetEditHistoryResponseDataUpdateDiscountsScheduleScheduleItem

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.

UpdatePrepaidBalanceThresholdConfiguration

optional

Hide ParametersShow Parameters

Commit

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

[]V2ContractGetEditHistoryResponseDataUpdatePrepaidBalanceThresholdConfigurationCommitSpecifier

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.

PaymentGateConfig

optional

Hide ParametersShow Parameters

PaymentGateType

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

"STRIPE"

V2ContractGetEditHistoryResponseDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

"EXTERNAL"

PrecalculatedTaxConfig

optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

TaxAmountfloat64

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

TaxNamestring

optional

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

StripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

"INVOICE"

V2ContractGetEditHistoryResponseDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxType

optional

Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

"STRIPE"

V2ContractGetEditHistoryResponseDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

"ANROK"

V2ContractGetEditHistoryResponseDataUpdatePrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

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

UpdateRecurringCommitsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateRecurringCommit

Hide ParametersShow Parameters

IDstring

formatuuid

AccessAmount

optional

Hide ParametersShow Parameters

Quantityfloat64

optional

UnitPricefloat64

optional

EndingBeforeTime

optional

formatdate-time

InvoiceAmount

optional

Hide ParametersShow Parameters

Quantityfloat64

optional

UnitPricefloat64

optional

UpdateRecurringCreditsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateRecurringCredit

Hide ParametersShow Parameters

IDstring

formatuuid

AccessAmount

optional

Hide ParametersShow Parameters

Quantityfloat64

optional

UnitPricefloat64

optional

EndingBeforeTime

optional

formatdate-time

UpdateRefundInvoicesarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateRefundInvoice

Hide ParametersShow Parameters

DateTime

formatdate-time

InvoiceIDstring

formatuuid

UpdateScheduledChargesarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateScheduledCharge

Hide ParametersShow Parameters

IDstring

formatuuid

InvoiceSchedule

optional

Hide ParametersShow Parameters

AddScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateScheduledChargesInvoiceScheduleAddScheduleItem

Hide ParametersShow Parameters

TimestampTime

formatdate-time

Amountfloat64

optional

Quantityfloat64

optional

UnitPricefloat64

optional

RemoveScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateScheduledChargesInvoiceScheduleRemoveScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

UpdateScheduleItemsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateScheduledChargesInvoiceScheduleUpdateScheduleItem

Hide ParametersShow Parameters

IDstring

formatuuid

Amountfloat64

optional

Quantityfloat64

optional

TimestampTime

optional

formatdate-time

UnitPricefloat64

optional

Namestring

optional

NetsuiteSalesOrderIDstring

optional

UpdateSpendThresholdConfiguration

optional

Hide ParametersShow Parameters

Commit

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.

PaymentGateConfig

optional

Hide ParametersShow Parameters

PaymentGateType

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

"STRIPE"

V2ContractGetEditHistoryResponseDataUpdateSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

"EXTERNAL"

PrecalculatedTaxConfig

optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

TaxAmountfloat64

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

TaxNamestring

optional

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

StripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

"INVOICE"

V2ContractGetEditHistoryResponseDataUpdateSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxType

optional

Stripe tax is only supported for Stripe payment gateway. Select NONE if you do not wish Metronome to calculate tax on your behalf. Leaving this field blank will default to NONE.

Hide ParametersShow Parameters

V2ContractGetEditHistoryResponseDataUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

"NONE"

V2ContractGetEditHistoryResponseDataUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

"STRIPE"

V2ContractGetEditHistoryResponseDataUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

"ANROK"

V2ContractGetEditHistoryResponseDataUpdateSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

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

UpdateSubscriptionsarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateSubscription

Optional list of subscriptions to update.

Hide ParametersShow Parameters

IDstring

formatuuid

EndingBeforeTime

optional

formatdate-time

QuantityUpdatesarray

optional

[]V2ContractGetEditHistoryResponseDataUpdateSubscriptionsQuantityUpdate

Hide ParametersShow Parameters

StartingAtTime

formatdate-time

Quantityfloat64

optional

QuantityDeltafloat64

optional

package main

import (
  "context"
  "fmt"

  "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.GetEditHistory(context.TODO(), metronome.V2ContractGetEditHistoryParams{
    ContractID: metronome.F("d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"),
    CustomerID: metronome.F("13117714-3f05-48e5-a6e9-a66093f13b4d"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

200 Example

{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "add_commits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "type": "PREPAID",
          "access_schedule": {
            "schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "ending_before": "2019-12-27T18:11:19.117Z",
                "starting_at": "2019-12-27T18:11:19.117Z"
              }
            ],
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            }
          },
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "description": "description",
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "invoice_schedule": {
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "do_not_invoice": true,
            "schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "quantity": 0,
                "timestamp": "2019-12-27T18:11:19.117Z",
                "unit_price": 0,
                "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ]
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "priority": 0,
          "rate_type": "COMMIT_RATE",
          "rollover_fraction": 0,
          "salesforce_opportunity_id": "salesforce_opportunity_id",
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ]
        }
      ],
      "add_credits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "type": "CREDIT",
          "access_schedule": {
            "schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "ending_before": "2019-12-27T18:11:19.117Z",
                "starting_at": "2019-12-27T18:11:19.117Z"
              }
            ],
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            }
          },
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "description": "description",
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "priority": 0,
          "salesforce_opportunity_id": "salesforce_opportunity_id",
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ]
        }
      ],
      "add_discounts": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "schedule": {
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "do_not_invoice": true,
            "schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "quantity": 0,
                "timestamp": "2019-12-27T18:11:19.117Z",
                "unit_price": 0,
                "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ]
          },
          "custom_fields": {
            "foo": "string"
          },
          "name": "x",
          "netsuite_sales_order_id": "netsuite_sales_order_id"
        }
      ],
      "add_overrides": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "starting_at": "2019-12-27T18:11:19.117Z",
          "applicable_product_tags": [
            "string"
          ],
          "ending_before": "2019-12-27T18:11:19.117Z",
          "entitled": true,
          "is_commit_specific": true,
          "multiplier": 0,
          "override_specifiers": [
            {
              "billing_frequency": "MONTHLY",
              "commit_ids": [
                "string"
              ],
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ],
              "recurring_commit_ids": [
                "string"
              ],
              "recurring_credit_ids": [
                "string"
              ]
            }
          ],
          "override_tiers": [
            {
              "multiplier": 0,
              "size": 0
            }
          ],
          "overwrite_rate": {
            "rate_type": "FLAT",
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "custom_rate": {
              "foo": "bar"
            },
            "is_prorated": true,
            "price": 0,
            "quantity": 0,
            "tiers": [
              {
                "price": 0,
                "size": 0
              }
            ]
          },
          "priority": 0,
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "target": "COMMIT_RATE",
          "type": "OVERWRITE"
        }
      ],
      "add_prepaid_balance_threshold_configuration": {
        "commit": {
          "product_id": "product_id",
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "description": "description",
          "name": "name",
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ]
        },
        "is_enabled": true,
        "payment_gate_config": {
          "payment_gate_type": "NONE",
          "precalculated_tax_config": {
            "tax_amount": 0,
            "tax_name": "tax_name"
          },
          "stripe_config": {
            "payment_type": "INVOICE",
            "invoice_metadata": {
              "foo": "string"
            }
          },
          "tax_type": "NONE"
        },
        "recharge_to_amount": 0,
        "threshold_amount": 0,
        "custom_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
      },
      "add_pro_services": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "max_amount": 0,
          "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "quantity": 0,
          "unit_price": 0,
          "custom_fields": {
            "foo": "string"
          },
          "description": "description",
          "netsuite_sales_order_id": "netsuite_sales_order_id"
        }
      ],
      "add_recurring_commits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_amount": {
            "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "unit_price": 0,
            "quantity": 0
          },
          "commit_duration": {
            "value": 0,
            "unit": "PERIODS"
          },
          "priority": 0,
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "rate_type": "COMMIT_RATE",
          "starting_at": "2019-12-27T18:11:19.117Z",
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "contract": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          },
          "description": "description",
          "ending_before": "2019-12-27T18:11:19.117Z",
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "invoice_amount": {
            "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "quantity": 0,
            "unit_price": 0
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "proration": "NONE",
          "recurrence_frequency": "MONTHLY",
          "rollover_fraction": 0,
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ],
          "subscription_config": {
            "allocation": "INDIVIDUAL",
            "apply_seat_increase_config": {
              "is_prorated": true
            },
            "subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          }
        }
      ],
      "add_recurring_credits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_amount": {
            "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "unit_price": 0,
            "quantity": 0
          },
          "commit_duration": {
            "value": 0,
            "unit": "PERIODS"
          },
          "priority": 0,
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "rate_type": "COMMIT_RATE",
          "starting_at": "2019-12-27T18:11:19.117Z",
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "contract": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          },
          "description": "description",
          "ending_before": "2019-12-27T18:11:19.117Z",
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "proration": "NONE",
          "recurrence_frequency": "MONTHLY",
          "rollover_fraction": 0,
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ],
          "subscription_config": {
            "allocation": "INDIVIDUAL",
            "apply_seat_increase_config": {
              "is_prorated": true
            },
            "subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          }
        }
      ],
      "add_reseller_royalties": [
        {
          "reseller_type": "AWS",
          "applicable_product_ids": [
            "string"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "aws_account_number": "aws_account_number",
          "aws_offer_id": "aws_offer_id",
          "aws_payer_reference_id": "aws_payer_reference_id",
          "ending_before": "2019-12-27T18:11:19.117Z",
          "fraction": 0,
          "gcp_account_id": "gcp_account_id",
          "gcp_offer_id": "gcp_offer_id",
          "netsuite_reseller_id": "netsuite_reseller_id",
          "reseller_contract_value": 0,
          "starting_at": "2019-12-27T18:11:19.117Z"
        }
      ],
      "add_scheduled_charges": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "schedule": {
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "do_not_invoice": true,
            "schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "quantity": 0,
                "timestamp": "2019-12-27T18:11:19.117Z",
                "unit_price": 0,
                "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ]
          },
          "name": "x",
          "netsuite_sales_order_id": "netsuite_sales_order_id"
        }
      ],
      "add_spend_threshold_configuration": {
        "commit": {
          "product_id": "product_id",
          "description": "description",
          "name": "name"
        },
        "is_enabled": true,
        "payment_gate_config": {
          "payment_gate_type": "NONE",
          "precalculated_tax_config": {
            "tax_amount": 0,
            "tax_name": "tax_name"
          },
          "stripe_config": {
            "payment_type": "INVOICE",
            "invoice_metadata": {
              "foo": "string"
            }
          },
          "tax_type": "NONE"
        },
        "threshold_amount": 0
      },
      "add_subscriptions": [
        {
          "collection_schedule": "ADVANCE",
          "proration": {
            "invoice_behavior": "BILL_IMMEDIATELY",
            "is_prorated": true
          },
          "quantity_schedule": [
            {
              "quantity": 0,
              "starting_at": "2019-12-27T18:11:19.117Z",
              "ending_before": "2019-12-27T18:11:19.117Z"
            }
          ],
          "starting_at": "2019-12-27T18:11:19.117Z",
          "subscription_rate": {
            "billing_frequency": "MONTHLY",
            "product": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            }
          },
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "custom_fields": {
            "foo": "string"
          },
          "description": "description",
          "ending_before": "2019-12-27T18:11:19.117Z",
          "fiat_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        }
      ],
      "add_usage_filters": [
        {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z",
          "ending_before": "2019-12-27T18:11:19.117Z"
        }
      ],
      "archive_commits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "archive_credits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "archive_scheduled_charges": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "remove_overrides": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "timestamp": "2019-12-27T18:11:19.117Z",
      "update_commits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_schedule": {
            "add_schedule_items": [
              {
                "amount": 0,
                "ending_before": "2019-12-27T18:11:19.117Z",
                "starting_at": "2019-12-27T18:11:19.117Z"
              }
            ],
            "remove_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ],
            "update_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "ending_before": "2019-12-27T18:11:19.117Z",
                "starting_at": "2019-12-27T18:11:19.117Z"
              }
            ]
          },
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "invoice_schedule": {
            "add_schedule_items": [
              {
                "timestamp": "2019-12-27T18:11:19.117Z",
                "amount": 0,
                "quantity": 0,
                "unit_price": 0
              }
            ],
            "remove_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ],
            "update_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "quantity": 0,
                "timestamp": "2019-12-27T18:11:19.117Z",
                "unit_price": 0
              }
            ]
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "priority": 0,
          "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "rollover_fraction": 0,
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ]
        }
      ],
      "update_contract_end_date": "2019-12-27T18:11:19.117Z",
      "update_contract_name": "update_contract_name",
      "update_credits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_schedule": {
            "add_schedule_items": [
              {
                "amount": 0,
                "ending_before": "2019-12-27T18:11:19.117Z",
                "starting_at": "2019-12-27T18:11:19.117Z"
              }
            ],
            "remove_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ],
            "update_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "ending_before": "2019-12-27T18:11:19.117Z",
                "starting_at": "2019-12-27T18:11:19.117Z"
              }
            ]
          },
          "hierarchy_configuration": {
            "child_access": {
              "type": "ALL"
            }
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "priority": 0,
          "rollover_fraction": 0
        }
      ],
      "update_discounts": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "custom_fields": {
            "foo": "string"
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id",
          "schedule": {
            "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "do_not_invoice": true,
            "recurring_schedule": {
              "amount_distribution": "DIVIDED",
              "ending_before": "2019-12-27T18:11:19.117Z",
              "frequency": "MONTHLY",
              "starting_at": "2019-12-27T18:11:19.117Z",
              "amount": 0,
              "quantity": 0,
              "unit_price": 0
            },
            "schedule_items": [
              {
                "timestamp": "2019-12-27T18:11:19.117Z",
                "amount": 0,
                "quantity": 0,
                "unit_price": 0
              }
            ]
          }
        }
      ],
      "update_prepaid_balance_threshold_configuration": {
        "commit": {
          "applicable_product_ids": [
            "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          ],
          "applicable_product_tags": [
            "string"
          ],
          "description": "description",
          "name": "name",
          "product_id": "product_id",
          "specifiers": [
            {
              "presentation_group_values": {
                "foo": "string"
              },
              "pricing_group_values": {
                "foo": "string"
              },
              "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "product_tags": [
                "string"
              ]
            }
          ]
        },
        "custom_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "is_enabled": true,
        "payment_gate_config": {
          "payment_gate_type": "NONE",
          "precalculated_tax_config": {
            "tax_amount": 0,
            "tax_name": "tax_name"
          },
          "stripe_config": {
            "payment_type": "INVOICE",
            "invoice_metadata": {
              "foo": "string"
            }
          },
          "tax_type": "NONE"
        },
        "recharge_to_amount": 0,
        "threshold_amount": 0
      },
      "update_recurring_commits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_amount": {
            "quantity": 0,
            "unit_price": 0
          },
          "ending_before": "2019-12-27T18:11:19.117Z",
          "invoice_amount": {
            "quantity": 0,
            "unit_price": 0
          }
        }
      ],
      "update_recurring_credits": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "access_amount": {
            "quantity": 0,
            "unit_price": 0
          },
          "ending_before": "2019-12-27T18:11:19.117Z"
        }
      ],
      "update_refund_invoices": [
        {
          "date": "2019-12-27T18:11:19.117Z",
          "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ],
      "update_scheduled_charges": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "invoice_schedule": {
            "add_schedule_items": [
              {
                "timestamp": "2019-12-27T18:11:19.117Z",
                "amount": 0,
                "quantity": 0,
                "unit_price": 0
              }
            ],
            "remove_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
              }
            ],
            "update_schedule_items": [
              {
                "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                "amount": 0,
                "quantity": 0,
                "timestamp": "2019-12-27T18:11:19.117Z",
                "unit_price": 0
              }
            ]
          },
          "name": "name",
          "netsuite_sales_order_id": "netsuite_sales_order_id"
        }
      ],
      "update_spend_threshold_configuration": {
        "commit": {
          "description": "description",
          "name": "name",
          "product_id": "product_id"
        },
        "is_enabled": true,
        "payment_gate_config": {
          "payment_gate_type": "NONE",
          "precalculated_tax_config": {
            "tax_amount": 0,
            "tax_name": "tax_name"
          },
          "stripe_config": {
            "payment_type": "INVOICE",
            "invoice_metadata": {
              "foo": "string"
            }
          },
          "tax_type": "NONE"
        },
        "threshold_amount": 0
      },
      "update_subscriptions": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "ending_before": "2019-12-27T18:11:19.117Z",
          "quantity_updates": [
            {
              "starting_at": "2019-12-27T18:11:19.117Z",
              "quantity": 0,
              "quantity_delta": 0
            }
          ]
        }
      ]
    }
  ]
}