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

Shared

API Reference

Shared

Shared

Base Usage Filter
BaseUsageFilterstruct
ShowShow
GroupKeystring
GroupValuesarray
[]string
StartingAtTime
optional
formatdate-time
Commit
Commitstruct
ShowShow
IDstring
formatuuid
ProductIDstringNamestringCommitProduct
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
TypeCommitTypePrepaidCommitTypeCommitTypePostpaidCommitTypeCommitType
Hide ParametersShow Parameters
CommitTypePrepaidconst
CommitTypePrepaidCommitTypeCommitTypePostpaidCommitTypeCommitType
"PREPAID"
CommitTypePostpaidconst
CommitTypePrepaidCommitTypeCommitTypePostpaidCommitTypeCommitType
"POSTPAID"
AccessScheduleScheduleItemsarrayCreditTypeCreditTypeDataScheduleDuration
optional

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

Amountfloat64
optional

(DEPRECATED) Use access_schedule + invoice_schedule instead.

ApplicableContractIDsarray
optional
[]string
ApplicableProductIDsarray
optional
[]string
ApplicableProductTagsarray
optional
[]string
ArchivedAtTime
optional

RFC 3339 timestamp indicating when the commit was archived. If not provided, the commit is not archived.

formatdate-time
Balancefloat64
optional

The current balance of the credit or commit. This balance reflects the amount of credit or commit that the customer has access to use at this moment - thus, expired and upcoming credit or commit segments contribute 0 to the balance. The balance will match the sum of all ledger entries with the exception of the case where the sum of negative manual ledger entries exceeds the positive amount remaining on the credit or commit - in that case, the balance will be 0. All manual ledger entries associated with active credit or commit segments are included in the balance, including future-dated manual ledger entries.

ContractIDstringCommitContract
optional
Hide ParametersShow Parameters
IDstring
formatuuid
CustomFieldsmap
optional
map[string, string]
Descriptionstring
optional
HierarchyConfigurationChildAccessCommitHierarchyConfigurationChildAccessCommitHierarchyConfiguration
optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters
ChildAccessCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}CommitHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct
Hide ParametersShow Parameters
TypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
Hide ParametersShow Parameters
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
"ALL"
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct
Hide ParametersShow Parameters
TypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
Hide ParametersShow Parameters
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
"NONE"
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct
Hide ParametersShow Parameters
ContractIDsarray
[]string
TypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
Hide ParametersShow Parameters
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
"CONTRACT_IDS"
InvoiceContractIDstringCommitInvoiceContract
optional

The contract that this commit will be billed on.

Hide ParametersShow Parameters
IDstring
formatuuid
InvoiceScheduleCreditTypeCreditTypeDataDoNotInvoiceboolScheduleItemsarraySchedulePointInTime
optional

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

Ledgerarray
optional
[]CommitLedger

A list of ordered events that impact the balance of a commit. For example, an invoice deduction or a rollover.

Hide ParametersShow Parameters
CommitLedgerPrepaidCommitSegmentStartLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitSegmentStartLedgerEntryTypePrepaidCommitSegmentStartCommitLedgerPrepaidCommitSegmentStartLedgerEntryTypeCommitLedgerPrepaidCommitSegmentStartLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitSegmentStartLedgerEntryTypePrepaidCommitSegmentStartconst
CommitLedgerPrepaidCommitSegmentStartLedgerEntryTypePrepaidCommitSegmentStartCommitLedgerPrepaidCommitSegmentStartLedgerEntryTypeCommitLedgerPrepaidCommitSegmentStartLedgerEntryType
"PREPAID_COMMIT_SEGMENT_START"
CommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypePrepaidCommitAutomatedInvoiceDeductionCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypeCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypePrepaidCommitAutomatedInvoiceDeductionconst
CommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypePrepaidCommitAutomatedInvoiceDeductionCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypeCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryType
"PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"
ContractIDstring
optional
formatuuid
CommitLedgerPrepaidCommitRolloverLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
NewContractIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitRolloverLedgerEntryTypePrepaidCommitRolloverCommitLedgerPrepaidCommitRolloverLedgerEntryTypeCommitLedgerPrepaidCommitRolloverLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitRolloverLedgerEntryTypePrepaidCommitRolloverconst
CommitLedgerPrepaidCommitRolloverLedgerEntryTypePrepaidCommitRolloverCommitLedgerPrepaidCommitRolloverLedgerEntryTypeCommitLedgerPrepaidCommitRolloverLedgerEntryType
"PREPAID_COMMIT_ROLLOVER"
CommitLedgerPrepaidCommitExpirationLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitExpirationLedgerEntryTypePrepaidCommitExpirationCommitLedgerPrepaidCommitExpirationLedgerEntryTypeCommitLedgerPrepaidCommitExpirationLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitExpirationLedgerEntryTypePrepaidCommitExpirationconst
CommitLedgerPrepaidCommitExpirationLedgerEntryTypePrepaidCommitExpirationCommitLedgerPrepaidCommitExpirationLedgerEntryTypeCommitLedgerPrepaidCommitExpirationLedgerEntryType
"PREPAID_COMMIT_EXPIRATION"
CommitLedgerPrepaidCommitCanceledLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitCanceledLedgerEntryTypePrepaidCommitCanceledCommitLedgerPrepaidCommitCanceledLedgerEntryTypeCommitLedgerPrepaidCommitCanceledLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitCanceledLedgerEntryTypePrepaidCommitCanceledconst
CommitLedgerPrepaidCommitCanceledLedgerEntryTypePrepaidCommitCanceledCommitLedgerPrepaidCommitCanceledLedgerEntryTypeCommitLedgerPrepaidCommitCanceledLedgerEntryType
"PREPAID_COMMIT_CANCELED"
ContractIDstring
optional
formatuuid
CommitLedgerPrepaidCommitCreditedLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitCreditedLedgerEntryTypePrepaidCommitCreditedCommitLedgerPrepaidCommitCreditedLedgerEntryTypeCommitLedgerPrepaidCommitCreditedLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitCreditedLedgerEntryTypePrepaidCommitCreditedconst
CommitLedgerPrepaidCommitCreditedLedgerEntryTypePrepaidCommitCreditedCommitLedgerPrepaidCommitCreditedLedgerEntryTypeCommitLedgerPrepaidCommitCreditedLedgerEntryType
"PREPAID_COMMIT_CREDITED"
ContractIDstring
optional
formatuuid
CommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypePrepaidCommitSeatBasedAdjustmentCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypeCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypePrepaidCommitSeatBasedAdjustmentconst
CommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypePrepaidCommitSeatBasedAdjustmentCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypeCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryType
"PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT"
CommitLedgerPostpaidCommitInitialBalanceLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypePostpaidCommitInitialBalanceCommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypeCommitLedgerPostpaidCommitInitialBalanceLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypePostpaidCommitInitialBalanceconst
CommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypePostpaidCommitInitialBalanceCommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypeCommitLedgerPostpaidCommitInitialBalanceLedgerEntryType
"POSTPAID_COMMIT_INITIAL_BALANCE"
CommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypePostpaidCommitAutomatedInvoiceDeductionCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypeCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypePostpaidCommitAutomatedInvoiceDeductionconst
CommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypePostpaidCommitAutomatedInvoiceDeductionCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypeCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryType
"POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"
ContractIDstring
optional
formatuuid
CommitLedgerPostpaidCommitRolloverLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
NewContractIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitRolloverLedgerEntryTypePostpaidCommitRolloverCommitLedgerPostpaidCommitRolloverLedgerEntryTypeCommitLedgerPostpaidCommitRolloverLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitRolloverLedgerEntryTypePostpaidCommitRolloverconst
CommitLedgerPostpaidCommitRolloverLedgerEntryTypePostpaidCommitRolloverCommitLedgerPostpaidCommitRolloverLedgerEntryTypeCommitLedgerPostpaidCommitRolloverLedgerEntryType
"POSTPAID_COMMIT_ROLLOVER"
CommitLedgerPostpaidCommitTrueupLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitTrueupLedgerEntryTypePostpaidCommitTrueupCommitLedgerPostpaidCommitTrueupLedgerEntryTypeCommitLedgerPostpaidCommitTrueupLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitTrueupLedgerEntryTypePostpaidCommitTrueupconst
CommitLedgerPostpaidCommitTrueupLedgerEntryTypePostpaidCommitTrueupCommitLedgerPostpaidCommitTrueupLedgerEntryTypeCommitLedgerPostpaidCommitTrueupLedgerEntryType
"POSTPAID_COMMIT_TRUEUP"
ContractIDstring
optional
formatuuid
CommitLedgerPrepaidCommitManualLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
Reasonstring
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitManualLedgerEntryTypePrepaidCommitManualCommitLedgerPrepaidCommitManualLedgerEntryTypeCommitLedgerPrepaidCommitManualLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitManualLedgerEntryTypePrepaidCommitManualconst
CommitLedgerPrepaidCommitManualLedgerEntryTypePrepaidCommitManualCommitLedgerPrepaidCommitManualLedgerEntryTypeCommitLedgerPrepaidCommitManualLedgerEntryType
"PREPAID_COMMIT_MANUAL"
CommitLedgerPostpaidCommitManualLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
Reasonstring
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitManualLedgerEntryTypePostpaidCommitManualCommitLedgerPostpaidCommitManualLedgerEntryTypeCommitLedgerPostpaidCommitManualLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitManualLedgerEntryTypePostpaidCommitManualconst
CommitLedgerPostpaidCommitManualLedgerEntryTypePostpaidCommitManualCommitLedgerPostpaidCommitManualLedgerEntryTypeCommitLedgerPostpaidCommitManualLedgerEntryType
"POSTPAID_COMMIT_MANUAL"
CommitLedgerPostpaidCommitExpirationLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitExpirationLedgerEntryTypePostpaidCommitExpirationCommitLedgerPostpaidCommitExpirationLedgerEntryTypeCommitLedgerPostpaidCommitExpirationLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitExpirationLedgerEntryTypePostpaidCommitExpirationconst
CommitLedgerPostpaidCommitExpirationLedgerEntryTypePostpaidCommitExpirationCommitLedgerPostpaidCommitExpirationLedgerEntryTypeCommitLedgerPostpaidCommitExpirationLedgerEntryType
"POSTPAID_COMMIT_EXPIRATION"
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.

RateTypeCommitRateTypeCommitRateCommitRateTypeCommitRateTypeListRateCommitRateTypeCommitRateType
optional
Hide ParametersShow Parameters
CommitRateTypeCommitRateconst
CommitRateTypeCommitRateCommitRateTypeCommitRateTypeListRateCommitRateTypeCommitRateType
"COMMIT_RATE"
CommitRateTypeListRateconst
CommitRateTypeCommitRateCommitRateTypeCommitRateTypeListRateCommitRateTypeCommitRateType
"LIST_RATE"
RolledOverFromCommitIDstringContractIDstringCommitRolledOverFrom
optional
Hide ParametersShow Parameters
CommitIDstring
formatuuid
ContractIDstring
formatuuid
RolloverFractionfloat64
optional
SalesforceOpportunityIDstring
optional

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

Specifiersarray
optional
[]CommitSpecifier

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.

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.

UniquenessKeystring
optional

Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or credit, a new record will not be created and the request will fail with a 409 error.

minLength1
maxLength128
Contract Without Amendments
ContractWithoutAmendmentsstruct
ShowShow
Commitsarray
[]IDstringProductCommitProductTypeCommitTypeAccessScheduleScheduleDurationAmountfloat64ApplicableContractIDsarrayApplicableProductIDsarrayApplicableProductTagsarrayArchivedAtTimeBalancefloat64ContractCommitContractCustomFieldsmapDescriptionstringHierarchyConfigurationCommitHierarchyConfigurationInvoiceContractCommitInvoiceContractInvoiceScheduleSchedulePointInTimeLedgerarrayNamestringNetsuiteSalesOrderIDstringPriorityfloat64RateTypeCommitRateTypeRolledOverFromCommitRolledOverFromRolloverFractionfloat64SalesforceOpportunityIDstringSpecifiersarrayUniquenessKeystringCommit
Hide ParametersShow Parameters
IDstring
formatuuid
ProductIDstringNamestringCommitProduct
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
TypeCommitTypePrepaidCommitTypeCommitTypePostpaidCommitTypeCommitType
Hide ParametersShow Parameters
CommitTypePrepaidconst
CommitTypePrepaidCommitTypeCommitTypePostpaidCommitTypeCommitType
"PREPAID"
CommitTypePostpaidconst
CommitTypePrepaidCommitTypeCommitTypePostpaidCommitTypeCommitType
"POSTPAID"
AccessScheduleScheduleItemsarrayCreditTypeCreditTypeDataScheduleDuration
optional

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

Amountfloat64
optional

(DEPRECATED) Use access_schedule + invoice_schedule instead.

ApplicableContractIDsarray
optional
[]string
ApplicableProductIDsarray
optional
[]string
ApplicableProductTagsarray
optional
[]string
ArchivedAtTime
optional

RFC 3339 timestamp indicating when the commit was archived. If not provided, the commit is not archived.

formatdate-time
Balancefloat64
optional

The current balance of the credit or commit. This balance reflects the amount of credit or commit that the customer has access to use at this moment - thus, expired and upcoming credit or commit segments contribute 0 to the balance. The balance will match the sum of all ledger entries with the exception of the case where the sum of negative manual ledger entries exceeds the positive amount remaining on the credit or commit - in that case, the balance will be 0. All manual ledger entries associated with active credit or commit segments are included in the balance, including future-dated manual ledger entries.

ContractIDstringCommitContract
optional
Hide ParametersShow Parameters
IDstring
formatuuid
CustomFieldsmap
optional
map[string, string]
Descriptionstring
optional
HierarchyConfigurationChildAccessCommitHierarchyConfigurationChildAccessCommitHierarchyConfiguration
optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters
ChildAccessCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}CommitHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct
Hide ParametersShow Parameters
TypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
Hide ParametersShow Parameters
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
"ALL"
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct
Hide ParametersShow Parameters
TypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
Hide ParametersShow Parameters
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
"NONE"
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct
Hide ParametersShow Parameters
ContractIDsarray
[]string
TypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
Hide ParametersShow Parameters
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst
CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeCommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
"CONTRACT_IDS"
InvoiceContractIDstringCommitInvoiceContract
optional

The contract that this commit will be billed on.

Hide ParametersShow Parameters
IDstring
formatuuid
InvoiceScheduleCreditTypeCreditTypeDataDoNotInvoiceboolScheduleItemsarraySchedulePointInTime
optional

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

Ledgerarray
optional
[]CommitLedger

A list of ordered events that impact the balance of a commit. For example, an invoice deduction or a rollover.

Hide ParametersShow Parameters
CommitLedgerPrepaidCommitSegmentStartLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitSegmentStartLedgerEntryTypePrepaidCommitSegmentStartCommitLedgerPrepaidCommitSegmentStartLedgerEntryTypeCommitLedgerPrepaidCommitSegmentStartLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitSegmentStartLedgerEntryTypePrepaidCommitSegmentStartconst
CommitLedgerPrepaidCommitSegmentStartLedgerEntryTypePrepaidCommitSegmentStartCommitLedgerPrepaidCommitSegmentStartLedgerEntryTypeCommitLedgerPrepaidCommitSegmentStartLedgerEntryType
"PREPAID_COMMIT_SEGMENT_START"
CommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypePrepaidCommitAutomatedInvoiceDeductionCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypeCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypePrepaidCommitAutomatedInvoiceDeductionconst
CommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypePrepaidCommitAutomatedInvoiceDeductionCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypeCommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryType
"PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"
ContractIDstring
optional
formatuuid
CommitLedgerPrepaidCommitRolloverLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
NewContractIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitRolloverLedgerEntryTypePrepaidCommitRolloverCommitLedgerPrepaidCommitRolloverLedgerEntryTypeCommitLedgerPrepaidCommitRolloverLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitRolloverLedgerEntryTypePrepaidCommitRolloverconst
CommitLedgerPrepaidCommitRolloverLedgerEntryTypePrepaidCommitRolloverCommitLedgerPrepaidCommitRolloverLedgerEntryTypeCommitLedgerPrepaidCommitRolloverLedgerEntryType
"PREPAID_COMMIT_ROLLOVER"
CommitLedgerPrepaidCommitExpirationLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitExpirationLedgerEntryTypePrepaidCommitExpirationCommitLedgerPrepaidCommitExpirationLedgerEntryTypeCommitLedgerPrepaidCommitExpirationLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitExpirationLedgerEntryTypePrepaidCommitExpirationconst
CommitLedgerPrepaidCommitExpirationLedgerEntryTypePrepaidCommitExpirationCommitLedgerPrepaidCommitExpirationLedgerEntryTypeCommitLedgerPrepaidCommitExpirationLedgerEntryType
"PREPAID_COMMIT_EXPIRATION"
CommitLedgerPrepaidCommitCanceledLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitCanceledLedgerEntryTypePrepaidCommitCanceledCommitLedgerPrepaidCommitCanceledLedgerEntryTypeCommitLedgerPrepaidCommitCanceledLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitCanceledLedgerEntryTypePrepaidCommitCanceledconst
CommitLedgerPrepaidCommitCanceledLedgerEntryTypePrepaidCommitCanceledCommitLedgerPrepaidCommitCanceledLedgerEntryTypeCommitLedgerPrepaidCommitCanceledLedgerEntryType
"PREPAID_COMMIT_CANCELED"
ContractIDstring
optional
formatuuid
CommitLedgerPrepaidCommitCreditedLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitCreditedLedgerEntryTypePrepaidCommitCreditedCommitLedgerPrepaidCommitCreditedLedgerEntryTypeCommitLedgerPrepaidCommitCreditedLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitCreditedLedgerEntryTypePrepaidCommitCreditedconst
CommitLedgerPrepaidCommitCreditedLedgerEntryTypePrepaidCommitCreditedCommitLedgerPrepaidCommitCreditedLedgerEntryTypeCommitLedgerPrepaidCommitCreditedLedgerEntryType
"PREPAID_COMMIT_CREDITED"
ContractIDstring
optional
formatuuid
CommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypePrepaidCommitSeatBasedAdjustmentCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypeCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypePrepaidCommitSeatBasedAdjustmentconst
CommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypePrepaidCommitSeatBasedAdjustmentCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypeCommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryType
"PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT"
CommitLedgerPostpaidCommitInitialBalanceLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypePostpaidCommitInitialBalanceCommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypeCommitLedgerPostpaidCommitInitialBalanceLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypePostpaidCommitInitialBalanceconst
CommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypePostpaidCommitInitialBalanceCommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypeCommitLedgerPostpaidCommitInitialBalanceLedgerEntryType
"POSTPAID_COMMIT_INITIAL_BALANCE"
CommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypePostpaidCommitAutomatedInvoiceDeductionCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypeCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypePostpaidCommitAutomatedInvoiceDeductionconst
CommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypePostpaidCommitAutomatedInvoiceDeductionCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypeCommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryType
"POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"
ContractIDstring
optional
formatuuid
CommitLedgerPostpaidCommitRolloverLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
NewContractIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitRolloverLedgerEntryTypePostpaidCommitRolloverCommitLedgerPostpaidCommitRolloverLedgerEntryTypeCommitLedgerPostpaidCommitRolloverLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitRolloverLedgerEntryTypePostpaidCommitRolloverconst
CommitLedgerPostpaidCommitRolloverLedgerEntryTypePostpaidCommitRolloverCommitLedgerPostpaidCommitRolloverLedgerEntryTypeCommitLedgerPostpaidCommitRolloverLedgerEntryType
"POSTPAID_COMMIT_ROLLOVER"
CommitLedgerPostpaidCommitTrueupLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitTrueupLedgerEntryTypePostpaidCommitTrueupCommitLedgerPostpaidCommitTrueupLedgerEntryTypeCommitLedgerPostpaidCommitTrueupLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitTrueupLedgerEntryTypePostpaidCommitTrueupconst
CommitLedgerPostpaidCommitTrueupLedgerEntryTypePostpaidCommitTrueupCommitLedgerPostpaidCommitTrueupLedgerEntryTypeCommitLedgerPostpaidCommitTrueupLedgerEntryType
"POSTPAID_COMMIT_TRUEUP"
ContractIDstring
optional
formatuuid
CommitLedgerPrepaidCommitManualLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
Reasonstring
TimestampTime
formatdate-time
TypeCommitLedgerPrepaidCommitManualLedgerEntryTypePrepaidCommitManualCommitLedgerPrepaidCommitManualLedgerEntryTypeCommitLedgerPrepaidCommitManualLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPrepaidCommitManualLedgerEntryTypePrepaidCommitManualconst
CommitLedgerPrepaidCommitManualLedgerEntryTypePrepaidCommitManualCommitLedgerPrepaidCommitManualLedgerEntryTypeCommitLedgerPrepaidCommitManualLedgerEntryType
"PREPAID_COMMIT_MANUAL"
CommitLedgerPostpaidCommitManualLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
Reasonstring
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitManualLedgerEntryTypePostpaidCommitManualCommitLedgerPostpaidCommitManualLedgerEntryTypeCommitLedgerPostpaidCommitManualLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitManualLedgerEntryTypePostpaidCommitManualconst
CommitLedgerPostpaidCommitManualLedgerEntryTypePostpaidCommitManualCommitLedgerPostpaidCommitManualLedgerEntryTypeCommitLedgerPostpaidCommitManualLedgerEntryType
"POSTPAID_COMMIT_MANUAL"
CommitLedgerPostpaidCommitExpirationLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
TimestampTime
formatdate-time
TypeCommitLedgerPostpaidCommitExpirationLedgerEntryTypePostpaidCommitExpirationCommitLedgerPostpaidCommitExpirationLedgerEntryTypeCommitLedgerPostpaidCommitExpirationLedgerEntryType
Hide ParametersShow Parameters
CommitLedgerPostpaidCommitExpirationLedgerEntryTypePostpaidCommitExpirationconst
CommitLedgerPostpaidCommitExpirationLedgerEntryTypePostpaidCommitExpirationCommitLedgerPostpaidCommitExpirationLedgerEntryTypeCommitLedgerPostpaidCommitExpirationLedgerEntryType
"POSTPAID_COMMIT_EXPIRATION"
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.

RateTypeCommitRateTypeCommitRateCommitRateTypeCommitRateTypeListRateCommitRateTypeCommitRateType
optional
Hide ParametersShow Parameters
CommitRateTypeCommitRateconst
CommitRateTypeCommitRateCommitRateTypeCommitRateTypeListRateCommitRateTypeCommitRateType
"COMMIT_RATE"
CommitRateTypeListRateconst
CommitRateTypeCommitRateCommitRateTypeCommitRateTypeListRateCommitRateTypeCommitRateType
"LIST_RATE"
RolledOverFromCommitIDstringContractIDstringCommitRolledOverFrom
optional
Hide ParametersShow Parameters
CommitIDstring
formatuuid
ContractIDstring
formatuuid
RolloverFractionfloat64
optional
SalesforceOpportunityIDstring
optional

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

Specifiersarray
optional
[]CommitSpecifier

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.

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.

UniquenessKeystring
optional

Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or credit, a new record will not be created and the request will fail with a 409 error.

minLength1
maxLength128
CreatedAtTime
formatdate-time
CreatedBystring
Overridesarray
[]IDstringStartingAtTimeApplicableProductTagsarrayCreditTypeCreditTypeDataEndingBeforeTimeEntitledboolIsCommitSpecificboolIsProratedboolMultiplierfloat64OverrideSpecifiersarrayOverrideTiersarrayOverwriteRateOverrideOverwriteRatePricefloat64Priorityfloat64ProductOverrideProductQuantityfloat64RateTypeOverrideRateTypeTargetOverrideTargetTiersarrayTypeOverrideTypeValuemapOverride
Hide ParametersShow Parameters
IDstring
formatuuid
StartingAtTime
formatdate-time
ApplicableProductTagsarray
optional
[]string
CreditTypeIDstringNamestringCreditTypeData
optional
EndingBeforeTime
optional
formatdate-time
Entitledbool
optional
IsCommitSpecificbool
optional
IsProratedbool
optional

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

Multiplierfloat64
optional
OverrideSpecifiersarray
optional
[]OverrideOverrideSpecifier
Hide ParametersShow Parameters
BillingFrequencyOverrideOverrideSpecifiersBillingFrequencyMonthlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyQuarterlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyAnnualOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyWeeklyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequency
optional
Hide ParametersShow Parameters
OverrideOverrideSpecifiersBillingFrequencyMonthlyconst
OverrideOverrideSpecifiersBillingFrequencyMonthlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyQuarterlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyAnnualOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyWeeklyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequency
"MONTHLY"
OverrideOverrideSpecifiersBillingFrequencyQuarterlyconst
OverrideOverrideSpecifiersBillingFrequencyMonthlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyQuarterlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyAnnualOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyWeeklyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequency
"QUARTERLY"
OverrideOverrideSpecifiersBillingFrequencyAnnualconst
OverrideOverrideSpecifiersBillingFrequencyMonthlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyQuarterlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyAnnualOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyWeeklyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequency
"ANNUAL"
OverrideOverrideSpecifiersBillingFrequencyWeeklyconst
OverrideOverrideSpecifiersBillingFrequencyMonthlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyQuarterlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyAnnualOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyWeeklyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequency
"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
[]OverrideOverrideTier
Hide ParametersShow Parameters
Multiplierfloat64
Sizefloat64
optional
OverwriteRateRateTypeOverrideOverwriteRateRateTypeCreditTypeCreditTypeDataCustomRatemapIsProratedboolPricefloat64Quantityfloat64TiersarrayOverrideOverwriteRate
optional
Hide ParametersShow Parameters
RateTypeOverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
Hide ParametersShow Parameters
OverrideOverwriteRateRateTypeFlatconst
OverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
"FLAT"
OverrideOverwriteRateRateTypePercentageconst
OverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
"PERCENTAGE"
OverrideOverwriteRateRateTypeSubscriptionconst
OverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
"SUBSCRIPTION"
OverrideOverwriteRateRateTypeTieredconst
OverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
"TIERED"
OverrideOverwriteRateRateTypeCustomconst
OverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
"CUSTOM"
CreditTypeIDstringNamestringCreditTypeData
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
[]Pricefloat64Sizefloat64Tier

Only set for TIERED rate_type.

Hide ParametersShow Parameters
Pricefloat64
Sizefloat64
optional
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.

Priorityfloat64
optional
ProductIDstringNamestringOverrideProduct
optional
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
Quantityfloat64
optional

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

RateTypeOverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
optional
Hide ParametersShow Parameters
OverrideRateTypeFlatconst
OverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
"FLAT"
OverrideRateTypePercentageconst
OverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
"PERCENTAGE"
OverrideRateTypeSubscriptionconst
OverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
"SUBSCRIPTION"
OverrideRateTypeTieredconst
OverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
"TIERED"
OverrideRateTypeCustomconst
OverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
"CUSTOM"
TargetOverrideTargetCommitRateOverrideTargetOverrideTargetListRateOverrideTargetOverrideTarget
optional
Hide ParametersShow Parameters
OverrideTargetCommitRateconst
OverrideTargetCommitRateOverrideTargetOverrideTargetListRateOverrideTargetOverrideTarget
"COMMIT_RATE"
OverrideTargetListRateconst
OverrideTargetCommitRateOverrideTargetOverrideTargetListRateOverrideTargetOverrideTarget
"LIST_RATE"
Tiersarray
optional
[]Pricefloat64Sizefloat64Tier

Only set for TIERED rate_type.

Hide ParametersShow Parameters
Pricefloat64
Sizefloat64
optional
TypeOverrideTypeOverwriteOverrideTypeOverrideTypeMultiplierOverrideTypeOverrideTypeTieredOverrideTypeOverrideType
optional
Hide ParametersShow Parameters
OverrideTypeOverwriteconst
OverrideTypeOverwriteOverrideTypeOverrideTypeMultiplierOverrideTypeOverrideTypeTieredOverrideTypeOverrideType
"OVERWRITE"
OverrideTypeMultiplierconst
OverrideTypeOverwriteOverrideTypeOverrideTypeMultiplierOverrideTypeOverrideTypeTieredOverrideTypeOverrideType
"MULTIPLIER"
OverrideTypeTieredconst
OverrideTypeOverwriteOverrideTypeOverrideTypeMultiplierOverrideTypeOverrideTypeTieredOverrideTypeOverrideType
"TIERED"
Valuemap
optional
map[string, unknown]

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

ScheduledChargesarray
[]IDstringProductScheduledChargeProductScheduleSchedulePointInTimeArchivedAtTimeCustomFieldsmapNamestringNetsuiteSalesOrderIDstringScheduledCharge
Hide ParametersShow Parameters
IDstring
formatuuid
ProductIDstringNamestringScheduledChargeProduct
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
ScheduleCreditTypeCreditTypeDataDoNotInvoiceboolScheduleItemsarraySchedulePointInTime
ArchivedAtTime
optional
formatdate-time
CustomFieldsmap
optional
map[string, string]
Namestring
optional

displayed on invoices

minLength1
NetsuiteSalesOrderIDstring
optional

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

StartingAtTime
formatdate-time
Transitionsarray
[]ContractWithoutAmendmentsTransition
Hide ParametersShow Parameters
FromContractIDstring
formatuuid
ToContractIDstring
formatuuid
TypeContractWithoutAmendmentsTransitionsTypeSupersedeContractWithoutAmendmentsTransitionsTypeContractWithoutAmendmentsTransitionsTypeRenewalContractWithoutAmendmentsTransitionsTypeContractWithoutAmendmentsTransitionsType
Hide ParametersShow Parameters
ContractWithoutAmendmentsTransitionsTypeSupersedeconst
ContractWithoutAmendmentsTransitionsTypeSupersedeContractWithoutAmendmentsTransitionsTypeContractWithoutAmendmentsTransitionsTypeRenewalContractWithoutAmendmentsTransitionsTypeContractWithoutAmendmentsTransitionsType
"SUPERSEDE"
ContractWithoutAmendmentsTransitionsTypeRenewalconst
ContractWithoutAmendmentsTransitionsTypeSupersedeContractWithoutAmendmentsTransitionsTypeContractWithoutAmendmentsTransitionsTypeRenewalContractWithoutAmendmentsTransitionsTypeContractWithoutAmendmentsTransitionsType
"RENEWAL"
UsageStatementScheduleBillingAnchorDateTimeFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementSchedule
Hide ParametersShow Parameters
BillingAnchorDateTime

Contract usage statements follow a selected cadence based on this date.

formatdate-time
FrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyMonthlyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyQuarterlyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyAnnualContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyWeeklyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequency
Hide ParametersShow Parameters
ContractWithoutAmendmentsUsageStatementScheduleFrequencyMonthlyconst
ContractWithoutAmendmentsUsageStatementScheduleFrequencyMonthlyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyQuarterlyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyAnnualContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyWeeklyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequency
"MONTHLY"
ContractWithoutAmendmentsUsageStatementScheduleFrequencyQuarterlyconst
ContractWithoutAmendmentsUsageStatementScheduleFrequencyMonthlyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyQuarterlyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyAnnualContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyWeeklyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequency
"QUARTERLY"
ContractWithoutAmendmentsUsageStatementScheduleFrequencyAnnualconst
ContractWithoutAmendmentsUsageStatementScheduleFrequencyMonthlyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyQuarterlyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyAnnualContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyWeeklyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequency
"ANNUAL"
ContractWithoutAmendmentsUsageStatementScheduleFrequencyWeeklyconst
ContractWithoutAmendmentsUsageStatementScheduleFrequencyMonthlyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyQuarterlyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyAnnualContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequencyWeeklyContractWithoutAmendmentsUsageStatementScheduleFrequencyContractWithoutAmendmentsUsageStatementScheduleFrequency
"WEEKLY"
Creditsarray
optional
[]IDstringProductCreditProductTypeCreditTypeAccessScheduleScheduleDurationApplicableContractIDsarrayApplicableProductIDsarrayApplicableProductTagsarrayBalancefloat64ContractCreditContractCustomFieldsmapDescriptionstringHierarchyConfigurationCreditHierarchyConfigurationLedgerarrayNamestringNetsuiteSalesOrderIDstringPriorityfloat64RateTypeCreditRateTypeSalesforceOpportunityIDstringSpecifiersarrayUniquenessKeystringCredit
Hide ParametersShow Parameters
IDstring
formatuuid
ProductIDstringNamestringCreditProduct
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
TypeCreditTypeCreditCreditTypeCreditType
Hide ParametersShow Parameters
CreditTypeCreditconst
CreditTypeCreditCreditTypeCreditType
"CREDIT"
AccessScheduleScheduleItemsarrayCreditTypeCreditTypeDataScheduleDuration
optional

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

ApplicableContractIDsarray
optional
[]string
ApplicableProductIDsarray
optional
[]string
ApplicableProductTagsarray
optional
[]string
Balancefloat64
optional

The current balance of the credit or commit. This balance reflects the amount of credit or commit that the customer has access to use at this moment - thus, expired and upcoming credit or commit segments contribute 0 to the balance. The balance will match the sum of all ledger entries with the exception of the case where the sum of negative manual ledger entries exceeds the positive amount remaining on the credit or commit - in that case, the balance will be 0. All manual ledger entries associated with active credit or commit segments are included in the balance, including future-dated manual ledger entries.

ContractIDstringCreditContract
optional
Hide ParametersShow Parameters
IDstring
formatuuid
CustomFieldsmap
optional
map[string, string]
Descriptionstring
optional
HierarchyConfigurationChildAccessCreditHierarchyConfigurationChildAccessCreditHierarchyConfiguration
optional

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters
ChildAccessCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}CreditHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct
Hide ParametersShow Parameters
TypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
Hide ParametersShow Parameters
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
"ALL"
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct
Hide ParametersShow Parameters
TypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
Hide ParametersShow Parameters
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
"NONE"
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct
Hide ParametersShow Parameters
ContractIDsarray
[]string
TypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
Hide ParametersShow Parameters
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
"CONTRACT_IDS"
Ledgerarray
optional
[]CreditLedger

A list of ordered events that impact the balance of a credit. For example, an invoice deduction or an expiration.

Hide ParametersShow Parameters
CreditLedgerCreditSegmentStartLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditSegmentStartLedgerEntryTypeCreditSegmentStartCreditLedgerCreditSegmentStartLedgerEntryTypeCreditLedgerCreditSegmentStartLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditSegmentStartLedgerEntryTypeCreditSegmentStartconst
CreditLedgerCreditSegmentStartLedgerEntryTypeCreditSegmentStartCreditLedgerCreditSegmentStartLedgerEntryTypeCreditLedgerCreditSegmentStartLedgerEntryType
"CREDIT_SEGMENT_START"
CreditLedgerCreditAutomatedInvoiceDeductionLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditAutomatedInvoiceDeductionCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditAutomatedInvoiceDeductionconst
CreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditAutomatedInvoiceDeductionCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryType
"CREDIT_AUTOMATED_INVOICE_DEDUCTION"
ContractIDstring
optional
formatuuid
CreditLedgerCreditExpirationLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditExpirationLedgerEntryTypeCreditExpirationCreditLedgerCreditExpirationLedgerEntryTypeCreditLedgerCreditExpirationLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditExpirationLedgerEntryTypeCreditExpirationconst
CreditLedgerCreditExpirationLedgerEntryTypeCreditExpirationCreditLedgerCreditExpirationLedgerEntryTypeCreditLedgerCreditExpirationLedgerEntryType
"CREDIT_EXPIRATION"
CreditLedgerCreditCanceledLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditCanceledLedgerEntryTypeCreditCanceledCreditLedgerCreditCanceledLedgerEntryTypeCreditLedgerCreditCanceledLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditCanceledLedgerEntryTypeCreditCanceledconst
CreditLedgerCreditCanceledLedgerEntryTypeCreditCanceledCreditLedgerCreditCanceledLedgerEntryTypeCreditLedgerCreditCanceledLedgerEntryType
"CREDIT_CANCELED"
ContractIDstring
optional
formatuuid
CreditLedgerCreditCreditedLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditCreditedLedgerEntryTypeCreditCreditedCreditLedgerCreditCreditedLedgerEntryTypeCreditLedgerCreditCreditedLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditCreditedLedgerEntryTypeCreditCreditedconst
CreditLedgerCreditCreditedLedgerEntryTypeCreditCreditedCreditLedgerCreditCreditedLedgerEntryTypeCreditLedgerCreditCreditedLedgerEntryType
"CREDIT_CREDITED"
ContractIDstring
optional
formatuuid
CreditLedgerCreditManualLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
Reasonstring
TimestampTime
formatdate-time
TypeCreditLedgerCreditManualLedgerEntryTypeCreditManualCreditLedgerCreditManualLedgerEntryTypeCreditLedgerCreditManualLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditManualLedgerEntryTypeCreditManualconst
CreditLedgerCreditManualLedgerEntryTypeCreditManualCreditLedgerCreditManualLedgerEntryTypeCreditLedgerCreditManualLedgerEntryType
"CREDIT_MANUAL"
CreditLedgerCreditSeatBasedAdjustmentLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditSeatBasedAdjustmentCreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditLedgerCreditSeatBasedAdjustmentLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditSeatBasedAdjustmentconst
CreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditSeatBasedAdjustmentCreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditLedgerCreditSeatBasedAdjustmentLedgerEntryType
"CREDIT_SEAT_BASED_ADJUSTMENT"
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.

RateTypeCreditRateTypeCommitRateCreditRateTypeCreditRateTypeListRateCreditRateTypeCreditRateType
optional
Hide ParametersShow Parameters
CreditRateTypeCommitRateconst
CreditRateTypeCommitRateCreditRateTypeCreditRateTypeListRateCreditRateTypeCreditRateType
"COMMIT_RATE"
CreditRateTypeListRateconst
CreditRateTypeCommitRateCreditRateTypeCreditRateTypeListRateCreditRateTypeCreditRateType
"LIST_RATE"
SalesforceOpportunityIDstring
optional

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

Specifiersarray
optional
[]CreditSpecifier

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.

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.

UniquenessKeystring
optional

Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or credit, a new record will not be created and the request will fail with a 409 error.

minLength1
maxLength128
Discountsarray
optional
[]IDstringProductDiscountProductScheduleSchedulePointInTimeCustomFieldsmapNamestringNetsuiteSalesOrderIDstringDiscount

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

Hide ParametersShow Parameters
IDstring
formatuuid
ProductIDstringNamestringDiscountProduct
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
ScheduleCreditTypeCreditTypeDataDoNotInvoiceboolScheduleItemsarraySchedulePointInTime
CustomFieldsmap
optional
map[string, string]
Namestring
optional
minLength1
NetsuiteSalesOrderIDstring
optional

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

EndingBeforeTime
optional
formatdate-time
HierarchyConfigurationContractWithoutAmendmentsHierarchyConfigurationParentHierarchyConfigurationstruct{…}ContractWithoutAmendmentsHierarchyConfigurationChildHierarchyConfigurationstruct{…}ContractWithoutAmendmentsHierarchyConfiguration
optional

Either a parent configuration with a list of children or a child configuration with a single parent.

Hide ParametersShow Parameters
ContractWithoutAmendmentsHierarchyConfigurationParentHierarchyConfigurationstruct
Hide ParametersShow Parameters
Childrenarray
[]ContractWithoutAmendmentsHierarchyConfigurationParentHierarchyConfigurationChild

List of contracts that belong to this parent.

Hide ParametersShow Parameters
ContractIDstring
formatuuid
CustomerIDstring
formatuuid
ContractWithoutAmendmentsHierarchyConfigurationChildHierarchyConfigurationstruct
Hide ParametersShow Parameters
ParentContractIDstringCustomerIDstringContractWithoutAmendmentsHierarchyConfigurationChildHierarchyConfigurationParent

The single parent contract/customer for this child.

Hide ParametersShow Parameters
ContractIDstring
formatuuid
CustomerIDstring
formatuuid
Namestring
optional
NetPaymentTermsDaysfloat64
optional
NetsuiteSalesOrderIDstring
optional

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

PrepaidBalanceThresholdConfigurationCommitContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationCommitIsEnabledboolPaymentGateConfigContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigRechargeToAmountfloat64ThresholdAmountfloat64CustomCreditTypeIDstringContractWithoutAmendmentsPrepaidBalanceThresholdConfiguration
optional
Hide ParametersShow Parameters
CommitProductIDstringApplicableProductIDsarrayApplicableProductTagsarrayDescriptionstringNamestringSpecifiersarrayContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationCommit
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
[]ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationCommitSpecifier

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with applicable_product_ids or applicable_product_tags.

Hide ParametersShow Parameters
PresentationGroupValuesmap
optional
map[string, string]
PricingGroupValuesmap
optional
map[string, string]
ProductIDstring
optional

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

formatuuid
ProductTagsarray
optional
[]string

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

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.

PaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypePrecalculatedTaxConfigContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigStripeConfigContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfig
Hide ParametersShow Parameters
PaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType

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
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType
"NONE"
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType
"STRIPE"
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateType
"EXTERNAL"
PrecalculatedTaxConfigTaxAmountfloat64TaxNamestringContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig
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.

StripeConfigPaymentTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceMetadatamapContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfig
optional

Only applicable if using STRIPE as your payment gate type.

Hide ParametersShow Parameters
PaymentTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentType
"INVOICE"
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentType
"PAYMENT_INTENT"
InvoiceMetadatamap
optional
map[string, string]

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

TaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType
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
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneconst
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType
"NONE"
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeconst
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType
"STRIPE"
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType
"ANROK"
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst
ContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxType
"PRECALCULATED"
RechargeToAmountfloat64

Specify the amount the balance should be recharged to.

ThresholdAmountfloat64

Specify the threshold amount for the contract. Each time the contract's prepaid 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
ProfessionalServicesarray
optional
[]IDstringMaxAmountfloat64ProductIDstringQuantityfloat64UnitPricefloat64CustomFieldsmapDescriptionstringNetsuiteSalesOrderIDstringProService

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

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.

RateCardIDstring
optional
formatuuid
RecurringCommitsarray
optional
[]ContractWithoutAmendmentsRecurringCommit
Hide ParametersShow Parameters
IDstring
formatuuid
AccessAmountCreditTypeIDstringUnitPricefloat64Quantityfloat64ContractWithoutAmendmentsRecurringCommitsAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters
CreditTypeIDstring
formatuuid
UnitPricefloat64
Quantityfloat64
optional
CommitDurationValuefloat64UnitContractWithoutAmendmentsRecurringCommitsCommitDurationUnitContractWithoutAmendmentsRecurringCommitsCommitDuration

The amount of time the created commits will be valid for

Hide ParametersShow Parameters
Valuefloat64
UnitContractWithoutAmendmentsRecurringCommitsCommitDurationUnitPeriodsContractWithoutAmendmentsRecurringCommitsCommitDurationUnitContractWithoutAmendmentsRecurringCommitsCommitDurationUnit
optional
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCommitsCommitDurationUnitPeriodsconst
ContractWithoutAmendmentsRecurringCommitsCommitDurationUnitPeriodsContractWithoutAmendmentsRecurringCommitsCommitDurationUnitContractWithoutAmendmentsRecurringCommitsCommitDurationUnit
"PERIODS"
Priorityfloat64

Will be passed down to the individual commits

ProductIDstringNamestringContractWithoutAmendmentsRecurringCommitsProduct
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
RateTypeContractWithoutAmendmentsRecurringCommitsRateTypeCommitRateContractWithoutAmendmentsRecurringCommitsRateTypeContractWithoutAmendmentsRecurringCommitsRateTypeListRateContractWithoutAmendmentsRecurringCommitsRateTypeContractWithoutAmendmentsRecurringCommitsRateType

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

Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCommitsRateTypeCommitRateconst
ContractWithoutAmendmentsRecurringCommitsRateTypeCommitRateContractWithoutAmendmentsRecurringCommitsRateTypeContractWithoutAmendmentsRecurringCommitsRateTypeListRateContractWithoutAmendmentsRecurringCommitsRateTypeContractWithoutAmendmentsRecurringCommitsRateType
"COMMIT_RATE"
ContractWithoutAmendmentsRecurringCommitsRateTypeListRateconst
ContractWithoutAmendmentsRecurringCommitsRateTypeCommitRateContractWithoutAmendmentsRecurringCommitsRateTypeContractWithoutAmendmentsRecurringCommitsRateTypeListRateContractWithoutAmendmentsRecurringCommitsRateTypeContractWithoutAmendmentsRecurringCommitsRateType
"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

ContractIDstringContractWithoutAmendmentsRecurringCommitsContract
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
HierarchyConfigurationChildAccessContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessContractWithoutAmendmentsRecurringCommitsHierarchyConfiguration
optional

Optional configuration for recurring commit/credit hierarchy access control

Hide ParametersShow Parameters
ChildAccessContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct
Hide ParametersShow Parameters
TypeContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst
ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
"ALL"
ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct
Hide ParametersShow Parameters
TypeContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst
ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
"NONE"
ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct
Hide ParametersShow Parameters
ContractIDsarray
[]string
TypeContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst
ContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractWithoutAmendmentsRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
"CONTRACT_IDS"
InvoiceAmountCreditTypeIDstringQuantityfloat64UnitPricefloat64ContractWithoutAmendmentsRecurringCommitsInvoiceAmount
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

ProrationContractWithoutAmendmentsRecurringCommitsProrationNoneContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationFirstContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationLastContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationFirstAndLastContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProration
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
ContractWithoutAmendmentsRecurringCommitsProrationNoneconst
ContractWithoutAmendmentsRecurringCommitsProrationNoneContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationFirstContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationLastContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationFirstAndLastContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProration
"NONE"
ContractWithoutAmendmentsRecurringCommitsProrationFirstconst
ContractWithoutAmendmentsRecurringCommitsProrationNoneContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationFirstContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationLastContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationFirstAndLastContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProration
"FIRST"
ContractWithoutAmendmentsRecurringCommitsProrationLastconst
ContractWithoutAmendmentsRecurringCommitsProrationNoneContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationFirstContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationLastContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationFirstAndLastContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProration
"LAST"
ContractWithoutAmendmentsRecurringCommitsProrationFirstAndLastconst
ContractWithoutAmendmentsRecurringCommitsProrationNoneContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationFirstContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationLastContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProrationFirstAndLastContractWithoutAmendmentsRecurringCommitsProrationContractWithoutAmendmentsRecurringCommitsProration
"FIRST_AND_LAST"
RecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyMonthlyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyQuarterlyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyAnnualContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyWeeklyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequency
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
ContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyMonthlyconst
ContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyMonthlyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyQuarterlyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyAnnualContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyWeeklyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequency
"MONTHLY"
ContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyQuarterlyconst
ContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyMonthlyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyQuarterlyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyAnnualContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyWeeklyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequency
"QUARTERLY"
ContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyAnnualconst
ContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyMonthlyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyQuarterlyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyAnnualContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyWeeklyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequency
"ANNUAL"
ContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyWeeklyconst
ContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyMonthlyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyQuarterlyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyAnnualContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyWeeklyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequencyContractWithoutAmendmentsRecurringCommitsRecurrenceFrequency
"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
[]ContractWithoutAmendmentsRecurringCommitsSpecifier

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.

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.

SubscriptionConfigAllocationContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationApplySeatIncreaseConfigContractWithoutAmendmentsRecurringCommitsSubscriptionConfigApplySeatIncreaseConfigSubscriptionIDstringContractWithoutAmendmentsRecurringCommitsSubscriptionConfig
optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters
AllocationContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationIndividualContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationPooledContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocation
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationIndividualconst
ContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationIndividualContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationPooledContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocation
"INDIVIDUAL"
ContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationPooledconst
ContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationIndividualContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationPooledContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCommitsSubscriptionConfigAllocation
"POOLED"
ApplySeatIncreaseConfigIsProratedboolContractWithoutAmendmentsRecurringCommitsSubscriptionConfigApplySeatIncreaseConfig
Hide ParametersShow Parameters
IsProratedbool

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

SubscriptionIDstring
formatuuid
RecurringCreditsarray
optional
[]ContractWithoutAmendmentsRecurringCredit
Hide ParametersShow Parameters
IDstring
formatuuid
AccessAmountCreditTypeIDstringUnitPricefloat64Quantityfloat64ContractWithoutAmendmentsRecurringCreditsAccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters
CreditTypeIDstring
formatuuid
UnitPricefloat64
Quantityfloat64
optional
CommitDurationValuefloat64UnitContractWithoutAmendmentsRecurringCreditsCommitDurationUnitContractWithoutAmendmentsRecurringCreditsCommitDuration

The amount of time the created commits will be valid for

Hide ParametersShow Parameters
Valuefloat64
UnitContractWithoutAmendmentsRecurringCreditsCommitDurationUnitPeriodsContractWithoutAmendmentsRecurringCreditsCommitDurationUnitContractWithoutAmendmentsRecurringCreditsCommitDurationUnit
optional
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCreditsCommitDurationUnitPeriodsconst
ContractWithoutAmendmentsRecurringCreditsCommitDurationUnitPeriodsContractWithoutAmendmentsRecurringCreditsCommitDurationUnitContractWithoutAmendmentsRecurringCreditsCommitDurationUnit
"PERIODS"
Priorityfloat64

Will be passed down to the individual commits

ProductIDstringNamestringContractWithoutAmendmentsRecurringCreditsProduct
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
RateTypeContractWithoutAmendmentsRecurringCreditsRateTypeCommitRateContractWithoutAmendmentsRecurringCreditsRateTypeContractWithoutAmendmentsRecurringCreditsRateTypeListRateContractWithoutAmendmentsRecurringCreditsRateTypeContractWithoutAmendmentsRecurringCreditsRateType

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

Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCreditsRateTypeCommitRateconst
ContractWithoutAmendmentsRecurringCreditsRateTypeCommitRateContractWithoutAmendmentsRecurringCreditsRateTypeContractWithoutAmendmentsRecurringCreditsRateTypeListRateContractWithoutAmendmentsRecurringCreditsRateTypeContractWithoutAmendmentsRecurringCreditsRateType
"COMMIT_RATE"
ContractWithoutAmendmentsRecurringCreditsRateTypeListRateconst
ContractWithoutAmendmentsRecurringCreditsRateTypeCommitRateContractWithoutAmendmentsRecurringCreditsRateTypeContractWithoutAmendmentsRecurringCreditsRateTypeListRateContractWithoutAmendmentsRecurringCreditsRateTypeContractWithoutAmendmentsRecurringCreditsRateType
"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

ContractIDstringContractWithoutAmendmentsRecurringCreditsContract
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
HierarchyConfigurationChildAccessContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessContractWithoutAmendmentsRecurringCreditsHierarchyConfiguration
optional

Optional configuration for recurring commit/credit hierarchy access control

Hide ParametersShow Parameters
ChildAccessContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct
Hide ParametersShow Parameters
TypeContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst
ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
"ALL"
ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct
Hide ParametersShow Parameters
TypeContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst
ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
"NONE"
ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct
Hide ParametersShow Parameters
ContractIDsarray
[]string
TypeContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst
ContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractWithoutAmendmentsRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
"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

ProrationContractWithoutAmendmentsRecurringCreditsProrationNoneContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationFirstContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationLastContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationFirstAndLastContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProration
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
ContractWithoutAmendmentsRecurringCreditsProrationNoneconst
ContractWithoutAmendmentsRecurringCreditsProrationNoneContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationFirstContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationLastContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationFirstAndLastContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProration
"NONE"
ContractWithoutAmendmentsRecurringCreditsProrationFirstconst
ContractWithoutAmendmentsRecurringCreditsProrationNoneContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationFirstContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationLastContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationFirstAndLastContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProration
"FIRST"
ContractWithoutAmendmentsRecurringCreditsProrationLastconst
ContractWithoutAmendmentsRecurringCreditsProrationNoneContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationFirstContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationLastContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationFirstAndLastContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProration
"LAST"
ContractWithoutAmendmentsRecurringCreditsProrationFirstAndLastconst
ContractWithoutAmendmentsRecurringCreditsProrationNoneContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationFirstContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationLastContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProrationFirstAndLastContractWithoutAmendmentsRecurringCreditsProrationContractWithoutAmendmentsRecurringCreditsProration
"FIRST_AND_LAST"
RecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyMonthlyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyQuarterlyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyAnnualContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyWeeklyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequency
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
ContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyMonthlyconst
ContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyMonthlyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyQuarterlyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyAnnualContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyWeeklyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequency
"MONTHLY"
ContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyQuarterlyconst
ContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyMonthlyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyQuarterlyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyAnnualContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyWeeklyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequency
"QUARTERLY"
ContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyAnnualconst
ContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyMonthlyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyQuarterlyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyAnnualContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyWeeklyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequency
"ANNUAL"
ContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyWeeklyconst
ContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyMonthlyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyQuarterlyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyAnnualContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyWeeklyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequencyContractWithoutAmendmentsRecurringCreditsRecurrenceFrequency
"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
[]ContractWithoutAmendmentsRecurringCreditsSpecifier

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.

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.

SubscriptionConfigAllocationContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationApplySeatIncreaseConfigContractWithoutAmendmentsRecurringCreditsSubscriptionConfigApplySeatIncreaseConfigSubscriptionIDstringContractWithoutAmendmentsRecurringCreditsSubscriptionConfig
optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters
AllocationContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationIndividualContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationPooledContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocation
Hide ParametersShow Parameters
ContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationIndividualconst
ContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationIndividualContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationPooledContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocation
"INDIVIDUAL"
ContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationPooledconst
ContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationIndividualContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationPooledContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocationContractWithoutAmendmentsRecurringCreditsSubscriptionConfigAllocation
"POOLED"
ApplySeatIncreaseConfigIsProratedboolContractWithoutAmendmentsRecurringCreditsSubscriptionConfigApplySeatIncreaseConfig
Hide ParametersShow Parameters
IsProratedbool

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

SubscriptionIDstring
formatuuid
ResellerRoyaltiesarray
optional
[]ContractWithoutAmendmentsResellerRoyalty

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

Hide ParametersShow Parameters
Fractionfloat64
NetsuiteResellerIDstring
ResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsProServiceContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpProServiceContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerType
Hide ParametersShow Parameters
ContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsconst
ContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsProServiceContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpProServiceContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerType
"AWS"
ContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsProServiceconst
ContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsProServiceContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpProServiceContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerType
"AWS_PRO_SERVICE"
ContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpconst
ContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsProServiceContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpProServiceContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerType
"GCP"
ContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpProServiceconst
ContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeAwsProServiceContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerTypeGcpProServiceContractWithoutAmendmentsResellerRoyaltiesResellerTypeContractWithoutAmendmentsResellerRoyaltiesResellerType
"GCP_PRO_SERVICE"
StartingAtTime
formatdate-time
ApplicableProductIDsarray
optional
[]string
ApplicableProductTagsarray
optional
[]string
AwsAccountNumberstring
optional
AwsOfferIDstring
optional
AwsPayerReferenceIDstring
optional
EndingBeforeTime
optional
formatdate-time
GcpAccountIDstring
optional
GcpOfferIDstring
optional
ResellerContractValuefloat64
optional
SalesforceOpportunityIDstring
optional

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

ScheduledChargesOnUsageInvoicesContractWithoutAmendmentsScheduledChargesOnUsageInvoicesAllContractWithoutAmendmentsScheduledChargesOnUsageInvoicesContractWithoutAmendmentsScheduledChargesOnUsageInvoices
optional

Determines which scheduled and commit charges to consolidate onto the Contract's usage invoice. The charge's timestamp must match the usage invoice's ending_before date for consolidation to occur. This field cannot be modified after a Contract has been created. If this field is omitted, charges will appear on a separate invoice from usage charges.

Hide ParametersShow Parameters
ContractWithoutAmendmentsScheduledChargesOnUsageInvoicesAllconst
ContractWithoutAmendmentsScheduledChargesOnUsageInvoicesAllContractWithoutAmendmentsScheduledChargesOnUsageInvoicesContractWithoutAmendmentsScheduledChargesOnUsageInvoices
"ALL"
SpendThresholdConfigurationCommitContractWithoutAmendmentsSpendThresholdConfigurationCommitIsEnabledboolPaymentGateConfigContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigThresholdAmountfloat64ContractWithoutAmendmentsSpendThresholdConfiguration
optional
Hide ParametersShow Parameters
CommitProductIDstringDescriptionstringNamestringContractWithoutAmendmentsSpendThresholdConfigurationCommit
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.

PaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypePrecalculatedTaxConfigContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfigStripeConfigContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfig
Hide ParametersShow Parameters
PaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateType

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
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateType
"NONE"
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateType
"STRIPE"
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPaymentGateType
"EXTERNAL"
PrecalculatedTaxConfigTaxAmountfloat64TaxNamestringContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigPrecalculatedTaxConfig
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.

StripeConfigPaymentTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceMetadatamapContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfig
optional

Only applicable if using STRIPE as your payment gate type.

Hide ParametersShow Parameters
PaymentTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentType
"INVOICE"
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentType
"PAYMENT_INTENT"
InvoiceMetadatamap
optional
map[string, string]

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

TaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxType
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
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneconst
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxType
"NONE"
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeconst
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxType
"STRIPE"
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxType
"ANROK"
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst
ContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxTypeContractWithoutAmendmentsSpendThresholdConfigurationPaymentGateConfigTaxType
"PRECALCULATED"
ThresholdAmountfloat64

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

TotalContractValuefloat64
optional

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

UsageFilterCurrentBaseUsageFilterInitialBaseUsageFilterUpdatesarrayContractWithoutAmendmentsUsageFilter
optional
Hide ParametersShow Parameters
CurrentGroupKeystringGroupValuesarrayStartingAtTimeBaseUsageFilter
InitialGroupKeystringGroupValuesarrayStartingAtTimeBaseUsageFilter
Updatesarray
[]ContractWithoutAmendmentsUsageFilterUpdate
Hide ParametersShow Parameters
GroupKeystring
GroupValuesarray
[]string
StartingAtTime
formatdate-time
Credit
Creditstruct
ShowShow
IDstring
formatuuid
ProductIDstringNamestringCreditProduct
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
TypeCreditTypeCreditCreditTypeCreditType
Hide ParametersShow Parameters
CreditTypeCreditconst
CreditTypeCreditCreditTypeCreditType
"CREDIT"
AccessScheduleScheduleItemsarrayCreditTypeCreditTypeDataScheduleDuration
optional

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

ApplicableContractIDsarray
optional
[]string
ApplicableProductIDsarray
optional
[]string
ApplicableProductTagsarray
optional
[]string
Balancefloat64
optional

The current balance of the credit or commit. This balance reflects the amount of credit or commit that the customer has access to use at this moment - thus, expired and upcoming credit or commit segments contribute 0 to the balance. The balance will match the sum of all ledger entries with the exception of the case where the sum of negative manual ledger entries exceeds the positive amount remaining on the credit or commit - in that case, the balance will be 0. All manual ledger entries associated with active credit or commit segments are included in the balance, including future-dated manual ledger entries.

ContractIDstringCreditContract
optional
Hide ParametersShow Parameters
IDstring
formatuuid
CustomFieldsmap
optional
map[string, string]
Descriptionstring
optional
HierarchyConfigurationChildAccessCreditHierarchyConfigurationChildAccessCreditHierarchyConfiguration
optional

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters
ChildAccessCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct{…}CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct{…}CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct{…}CreditHierarchyConfigurationChildAccess
Hide ParametersShow Parameters
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct
Hide ParametersShow Parameters
TypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
Hide ParametersShow Parameters
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllType
"ALL"
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct
Hide ParametersShow Parameters
TypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
Hide ParametersShow Parameters
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneType
"NONE"
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct
Hide ParametersShow Parameters
ContractIDsarray
[]string
TypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
Hide ParametersShow Parameters
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst
CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeCreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsType
"CONTRACT_IDS"
Ledgerarray
optional
[]CreditLedger

A list of ordered events that impact the balance of a credit. For example, an invoice deduction or an expiration.

Hide ParametersShow Parameters
CreditLedgerCreditSegmentStartLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditSegmentStartLedgerEntryTypeCreditSegmentStartCreditLedgerCreditSegmentStartLedgerEntryTypeCreditLedgerCreditSegmentStartLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditSegmentStartLedgerEntryTypeCreditSegmentStartconst
CreditLedgerCreditSegmentStartLedgerEntryTypeCreditSegmentStartCreditLedgerCreditSegmentStartLedgerEntryTypeCreditLedgerCreditSegmentStartLedgerEntryType
"CREDIT_SEGMENT_START"
CreditLedgerCreditAutomatedInvoiceDeductionLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditAutomatedInvoiceDeductionCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditAutomatedInvoiceDeductionconst
CreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditAutomatedInvoiceDeductionCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryType
"CREDIT_AUTOMATED_INVOICE_DEDUCTION"
ContractIDstring
optional
formatuuid
CreditLedgerCreditExpirationLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditExpirationLedgerEntryTypeCreditExpirationCreditLedgerCreditExpirationLedgerEntryTypeCreditLedgerCreditExpirationLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditExpirationLedgerEntryTypeCreditExpirationconst
CreditLedgerCreditExpirationLedgerEntryTypeCreditExpirationCreditLedgerCreditExpirationLedgerEntryTypeCreditLedgerCreditExpirationLedgerEntryType
"CREDIT_EXPIRATION"
CreditLedgerCreditCanceledLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditCanceledLedgerEntryTypeCreditCanceledCreditLedgerCreditCanceledLedgerEntryTypeCreditLedgerCreditCanceledLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditCanceledLedgerEntryTypeCreditCanceledconst
CreditLedgerCreditCanceledLedgerEntryTypeCreditCanceledCreditLedgerCreditCanceledLedgerEntryTypeCreditLedgerCreditCanceledLedgerEntryType
"CREDIT_CANCELED"
ContractIDstring
optional
formatuuid
CreditLedgerCreditCreditedLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
InvoiceIDstring
formatuuid
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditCreditedLedgerEntryTypeCreditCreditedCreditLedgerCreditCreditedLedgerEntryTypeCreditLedgerCreditCreditedLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditCreditedLedgerEntryTypeCreditCreditedconst
CreditLedgerCreditCreditedLedgerEntryTypeCreditCreditedCreditLedgerCreditCreditedLedgerEntryTypeCreditLedgerCreditCreditedLedgerEntryType
"CREDIT_CREDITED"
ContractIDstring
optional
formatuuid
CreditLedgerCreditManualLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
Reasonstring
TimestampTime
formatdate-time
TypeCreditLedgerCreditManualLedgerEntryTypeCreditManualCreditLedgerCreditManualLedgerEntryTypeCreditLedgerCreditManualLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditManualLedgerEntryTypeCreditManualconst
CreditLedgerCreditManualLedgerEntryTypeCreditManualCreditLedgerCreditManualLedgerEntryTypeCreditLedgerCreditManualLedgerEntryType
"CREDIT_MANUAL"
CreditLedgerCreditSeatBasedAdjustmentLedgerEntrystruct
Hide ParametersShow Parameters
Amountfloat64
SegmentIDstring
formatuuid
TimestampTime
formatdate-time
TypeCreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditSeatBasedAdjustmentCreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditLedgerCreditSeatBasedAdjustmentLedgerEntryType
Hide ParametersShow Parameters
CreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditSeatBasedAdjustmentconst
CreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditSeatBasedAdjustmentCreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditLedgerCreditSeatBasedAdjustmentLedgerEntryType
"CREDIT_SEAT_BASED_ADJUSTMENT"
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.

RateTypeCreditRateTypeCommitRateCreditRateTypeCreditRateTypeListRateCreditRateTypeCreditRateType
optional
Hide ParametersShow Parameters
CreditRateTypeCommitRateconst
CreditRateTypeCommitRateCreditRateTypeCreditRateTypeListRateCreditRateTypeCreditRateType
"COMMIT_RATE"
CreditRateTypeListRateconst
CreditRateTypeCommitRateCreditRateTypeCreditRateTypeListRateCreditRateTypeCreditRateType
"LIST_RATE"
SalesforceOpportunityIDstring
optional

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

Specifiersarray
optional
[]CreditSpecifier

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.

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.

UniquenessKeystring
optional

Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or credit, a new record will not be created and the request will fail with a 409 error.

minLength1
maxLength128
Credit Type Data
CreditTypeDatastruct
ShowShow
IDstring
formatuuid
Namestring
Discount
Discountstruct
ShowShow
IDstring
formatuuid
ProductIDstringNamestringDiscountProduct
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
ScheduleCreditTypeCreditTypeDataDoNotInvoiceboolScheduleItemsarraySchedulePointInTime
CustomFieldsmap
optional
map[string, string]
Namestring
optional
minLength1
NetsuiteSalesOrderIDstring
optional

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

Event Type Filter
EventTypeFilterstruct

An optional filtering rule to match the 'event_type' property of an event.

ShowShow
InValuesarray
optional
[]string

A list of event types that are explicitly included in the billable metric. If specified, only events of these types will match the billable metric. Must be non-empty if present.

NotInValuesarray
optional
[]string

A list of event types that are explicitly excluded from the billable metric. If specified, events of these types will not match the billable metric. Must be non-empty if present.

ID
IDstruct
ShowShow
IDstring
formatuuid
Override
Overridestruct
ShowShow
IDstring
formatuuid
StartingAtTime
formatdate-time
ApplicableProductTagsarray
optional
[]string
CreditTypeIDstringNamestringCreditTypeData
optional
EndingBeforeTime
optional
formatdate-time
Entitledbool
optional
IsCommitSpecificbool
optional
IsProratedbool
optional

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

Multiplierfloat64
optional
OverrideSpecifiersarray
optional
[]OverrideOverrideSpecifier
Hide ParametersShow Parameters
BillingFrequencyOverrideOverrideSpecifiersBillingFrequencyMonthlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyQuarterlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyAnnualOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyWeeklyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequency
optional
Hide ParametersShow Parameters
OverrideOverrideSpecifiersBillingFrequencyMonthlyconst
OverrideOverrideSpecifiersBillingFrequencyMonthlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyQuarterlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyAnnualOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyWeeklyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequency
"MONTHLY"
OverrideOverrideSpecifiersBillingFrequencyQuarterlyconst
OverrideOverrideSpecifiersBillingFrequencyMonthlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyQuarterlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyAnnualOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyWeeklyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequency
"QUARTERLY"
OverrideOverrideSpecifiersBillingFrequencyAnnualconst
OverrideOverrideSpecifiersBillingFrequencyMonthlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyQuarterlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyAnnualOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyWeeklyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequency
"ANNUAL"
OverrideOverrideSpecifiersBillingFrequencyWeeklyconst
OverrideOverrideSpecifiersBillingFrequencyMonthlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyQuarterlyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyAnnualOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequencyWeeklyOverrideOverrideSpecifiersBillingFrequencyOverrideOverrideSpecifiersBillingFrequency
"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
[]OverrideOverrideTier
Hide ParametersShow Parameters
Multiplierfloat64
Sizefloat64
optional
OverwriteRateRateTypeOverrideOverwriteRateRateTypeCreditTypeCreditTypeDataCustomRatemapIsProratedboolPricefloat64Quantityfloat64TiersarrayOverrideOverwriteRate
optional
Hide ParametersShow Parameters
RateTypeOverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
Hide ParametersShow Parameters
OverrideOverwriteRateRateTypeFlatconst
OverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
"FLAT"
OverrideOverwriteRateRateTypePercentageconst
OverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
"PERCENTAGE"
OverrideOverwriteRateRateTypeSubscriptionconst
OverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
"SUBSCRIPTION"
OverrideOverwriteRateRateTypeTieredconst
OverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
"TIERED"
OverrideOverwriteRateRateTypeCustomconst
OverrideOverwriteRateRateTypeFlatOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypePercentageOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeSubscriptionOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeTieredOverrideOverwriteRateRateTypeOverrideOverwriteRateRateTypeCustomOverrideOverwriteRateRateTypeOverrideOverwriteRateRateType
"CUSTOM"
CreditTypeIDstringNamestringCreditTypeData
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
[]Pricefloat64Sizefloat64Tier

Only set for TIERED rate_type.

Hide ParametersShow Parameters
Pricefloat64
Sizefloat64
optional
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.

Priorityfloat64
optional
ProductIDstringNamestringOverrideProduct
optional
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
Quantityfloat64
optional

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

RateTypeOverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
optional
Hide ParametersShow Parameters
OverrideRateTypeFlatconst
OverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
"FLAT"
OverrideRateTypePercentageconst
OverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
"PERCENTAGE"
OverrideRateTypeSubscriptionconst
OverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
"SUBSCRIPTION"
OverrideRateTypeTieredconst
OverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
"TIERED"
OverrideRateTypeCustomconst
OverrideRateTypeFlatOverrideRateTypeOverrideRateTypePercentageOverrideRateTypeOverrideRateTypeSubscriptionOverrideRateTypeOverrideRateTypeTieredOverrideRateTypeOverrideRateTypeCustomOverrideRateTypeOverrideRateType
"CUSTOM"
TargetOverrideTargetCommitRateOverrideTargetOverrideTargetListRateOverrideTargetOverrideTarget
optional
Hide ParametersShow Parameters
OverrideTargetCommitRateconst
OverrideTargetCommitRateOverrideTargetOverrideTargetListRateOverrideTargetOverrideTarget
"COMMIT_RATE"
OverrideTargetListRateconst
OverrideTargetCommitRateOverrideTargetOverrideTargetListRateOverrideTargetOverrideTarget
"LIST_RATE"
Tiersarray
optional
[]Pricefloat64Sizefloat64Tier

Only set for TIERED rate_type.

Hide ParametersShow Parameters
Pricefloat64
Sizefloat64
optional
TypeOverrideTypeOverwriteOverrideTypeOverrideTypeMultiplierOverrideTypeOverrideTypeTieredOverrideTypeOverrideType
optional
Hide ParametersShow Parameters
OverrideTypeOverwriteconst
OverrideTypeOverwriteOverrideTypeOverrideTypeMultiplierOverrideTypeOverrideTypeTieredOverrideTypeOverrideType
"OVERWRITE"
OverrideTypeMultiplierconst
OverrideTypeOverwriteOverrideTypeOverrideTypeMultiplierOverrideTypeOverrideTypeTieredOverrideTypeOverrideType
"MULTIPLIER"
OverrideTypeTieredconst
OverrideTypeOverwriteOverrideTypeOverrideTypeMultiplierOverrideTypeOverrideTypeTieredOverrideTypeOverrideType
"TIERED"
Valuemap
optional
map[string, unknown]

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

Property Filter
PropertyFilterstruct
ShowShow
Namestring

The name of the event property.

Existsbool
optional

Determines whether the property must exist in the event. If true, only events with this property will pass the filter. If false, only events without this property will pass the filter. If null or omitted, the existence of the property is optional.

InValuesarray
optional
[]string

Specifies the allowed values for the property to match an event. An event will pass the filter only if its property value is included in this list. If undefined, all property values will pass the filter. Must be non-empty if present.

NotInValuesarray
optional
[]string

Specifies the values that prevent an event from matching the filter. An event will not pass the filter if its property value is included in this list. If null or empty, all property values will pass the filter. Must be non-empty if present.

Pro Service
ProServicestruct
ShowShow
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.

Rate
Ratestruct
ShowShow
RateTypeRateRateTypeFlatRateRateTypeRateRateTypePercentageRateRateTypeRateRateTypeSubscriptionRateRateTypeRateRateTypeCustomRateRateTypeRateRateTypeTieredRateRateTypeRateRateType
Hide ParametersShow Parameters
RateRateTypeFlatconst
RateRateTypeFlatRateRateTypeRateRateTypePercentageRateRateTypeRateRateTypeSubscriptionRateRateTypeRateRateTypeCustomRateRateTypeRateRateTypeTieredRateRateTypeRateRateType
"FLAT"
RateRateTypePercentageconst
RateRateTypeFlatRateRateTypeRateRateTypePercentageRateRateTypeRateRateTypeSubscriptionRateRateTypeRateRateTypeCustomRateRateTypeRateRateTypeTieredRateRateTypeRateRateType
"PERCENTAGE"
RateRateTypeSubscriptionconst
RateRateTypeFlatRateRateTypeRateRateTypePercentageRateRateTypeRateRateTypeSubscriptionRateRateTypeRateRateTypeCustomRateRateTypeRateRateTypeTieredRateRateTypeRateRateType
"SUBSCRIPTION"
RateRateTypeCustomconst
RateRateTypeFlatRateRateTypeRateRateTypePercentageRateRateTypeRateRateTypeSubscriptionRateRateTypeRateRateTypeCustomRateRateTypeRateRateTypeTieredRateRateTypeRateRateType
"CUSTOM"
RateRateTypeTieredconst
RateRateTypeFlatRateRateTypeRateRateTypePercentageRateRateTypeRateRateTypeSubscriptionRateRateTypeRateRateTypeCustomRateRateTypeRateRateTypeTieredRateRateTypeRateRateType
"TIERED"
CreditTypeIDstringNamestringCreditTypeData
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.

PricingGroupValuesmap
optional
map[string, string]

if pricing groups are used, this will contain the values used to calculate the price

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

Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed using list prices rather than the standard rates for this product on the contract.

Scheduled Charge
ScheduledChargestruct
ShowShow
IDstring
formatuuid
ProductIDstringNamestringScheduledChargeProduct
Hide ParametersShow Parameters
IDstring
formatuuid
Namestring
ScheduleCreditTypeCreditTypeDataDoNotInvoiceboolScheduleItemsarraySchedulePointInTime
ArchivedAtTime
optional
formatdate-time
CustomFieldsmap
optional
map[string, string]
Namestring
optional

displayed on invoices

minLength1
NetsuiteSalesOrderIDstring
optional

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

Schedule Duration
ScheduleDurationstruct
ShowShow
ScheduleItemsarray
[]ScheduleDurationScheduleItem
Hide ParametersShow Parameters
IDstring
formatuuid
Amountfloat64
EndingBeforeTime
formatdate-time
StartingAtTime
formatdate-time
CreditTypeIDstringNamestringCreditTypeData
optional
Schedule Point In Time
SchedulePointInTimestruct
ShowShow
CreditTypeIDstringNamestringCreditTypeData
optional
DoNotInvoicebool
optional

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

ScheduleItemsarray
optional
[]SchedulePointInTimeScheduleItem
Hide ParametersShow Parameters
IDstring
formatuuid
Amountfloat64
Quantityfloat64
TimestampTime
formatdate-time
UnitPricefloat64
InvoiceIDstring
optional
formatuuid
Tier
Tierstruct
ShowShow
Pricefloat64
Sizefloat64
optional