Retrieve

API Reference

Contracts

Get a contract (v2)

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

post/v2/contracts/get

Get a specific contract. New clients should use this endpoint rather than the v1 endpoint.

Parameters

body

Hide ParametersShow Parameters

ContractIDfield

param.Field[string]

formatuuid

CustomerIDfield

param.Field[string]

formatuuid

AsOfDatefield

optional

param.Field[Time]

Optional RFC 3339 timestamp. Return the contract as of this date. Cannot be used with include_ledgers parameter.

formatdate-time

IncludeBalancefield

optional

param.Field[bool]

Include the balance of credits and commits in the response. Setting this flag may cause the query to be slower.

IncludeLedgersfield

optional

param.Field[bool]

Include commit/credit ledgers in the response. Setting this flag may cause the query to be slower. Cannot be used with as_of_date parameter.

Returns

V2ContractGetResponsestruct

Hide ParametersShow Parameters

Data

Hide ParametersShow Parameters

IDstring

formatuuid

Commitsarray

[]V2ContractGetResponseDataCommit

Hide ParametersShow Parameters

IDstring

formatuuid

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsTypePrepaidconst

"PREPAID"

V2ContractGetResponseDataCommitsTypePostpaidconst

"POSTPAID"

AccessSchedule

optional

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

ApplicableContractIDsarray

optional

[]string

ApplicableProductIDsarray

optional

[]string

ApplicableProductTagsarray

optional

[]string

ArchivedAtTime

optional

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.

Contract

optional

Hide ParametersShow Parameters

IDstring

formatuuid

CustomFieldsmap

optional

map[string, string]

Descriptionstring

optional

HierarchyConfiguration

optional

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V2ContractGetResponseDataCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V2ContractGetResponseDataCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

InvoiceContract

optional

The contract that this commit will be billed on.

Hide ParametersShow Parameters

IDstring

formatuuid

InvoiceSchedule

optional

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

Ledgerarray

optional

[]V2ContractGetResponseDataCommitsLedger

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

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPrepaidCommitSegmentStartLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPrepaidCommitSegmentStartLedgerEntryTypePrepaidCommitSegmentStartconst

"PREPAID_COMMIT_SEGMENT_START"

V2ContractGetResponseDataCommitsLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypePrepaidCommitAutomatedInvoiceDeductionconst

"PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"

ContractIDstring

optional

formatuuid

V2ContractGetResponseDataCommitsLedgerPrepaidCommitRolloverLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

NewContractIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPrepaidCommitRolloverLedgerEntryTypePrepaidCommitRolloverconst

"PREPAID_COMMIT_ROLLOVER"

V2ContractGetResponseDataCommitsLedgerPrepaidCommitExpirationLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPrepaidCommitExpirationLedgerEntryTypePrepaidCommitExpirationconst

"PREPAID_COMMIT_EXPIRATION"

V2ContractGetResponseDataCommitsLedgerPrepaidCommitCanceledLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPrepaidCommitCanceledLedgerEntryTypePrepaidCommitCanceledconst

"PREPAID_COMMIT_CANCELED"

ContractIDstring

optional

formatuuid

V2ContractGetResponseDataCommitsLedgerPrepaidCommitCreditedLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPrepaidCommitCreditedLedgerEntryTypePrepaidCommitCreditedconst

"PREPAID_COMMIT_CREDITED"

ContractIDstring

optional

formatuuid

V2ContractGetResponseDataCommitsLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypePrepaidCommitSeatBasedAdjustmentconst

"PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT"

V2ContractGetResponseDataCommitsLedgerPostpaidCommitInitialBalanceLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPostpaidCommitInitialBalanceLedgerEntryTypePostpaidCommitInitialBalanceconst

"POSTPAID_COMMIT_INITIAL_BALANCE"

V2ContractGetResponseDataCommitsLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypePostpaidCommitAutomatedInvoiceDeductionconst

"POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"

ContractIDstring

optional

formatuuid

V2ContractGetResponseDataCommitsLedgerPostpaidCommitRolloverLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

NewContractIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPostpaidCommitRolloverLedgerEntryTypePostpaidCommitRolloverconst

"POSTPAID_COMMIT_ROLLOVER"

V2ContractGetResponseDataCommitsLedgerPostpaidCommitTrueupLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPostpaidCommitTrueupLedgerEntryTypePostpaidCommitTrueupconst

"POSTPAID_COMMIT_TRUEUP"

ContractIDstring

optional

formatuuid

V2ContractGetResponseDataCommitsLedgerPrepaidCommitManualLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

Reasonstring

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPrepaidCommitManualLedgerEntryTypePrepaidCommitManualconst

"PREPAID_COMMIT_MANUAL"

V2ContractGetResponseDataCommitsLedgerPostpaidCommitManualLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

Reasonstring

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPostpaidCommitManualLedgerEntryTypePostpaidCommitManualconst

"POSTPAID_COMMIT_MANUAL"

V2ContractGetResponseDataCommitsLedgerPostpaidCommitExpirationLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsLedgerPostpaidCommitExpirationLedgerEntryTypePostpaidCommitExpirationconst

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

RateType

optional

Hide ParametersShow Parameters

V2ContractGetResponseDataCommitsRateTypeCommitRateconst

"COMMIT_RATE"

V2ContractGetResponseDataCommitsRateTypeListRateconst

"LIST_RATE"

RolledOverFrom

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

[]V2ContractGetResponseDataCommitsSpecifier

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.

CreatedAtTime

formatdate-time

CreatedBystring

CustomerIDstring

formatuuid

Overridesarray

[]V2ContractGetResponseDataOverride

Hide ParametersShow Parameters

IDstring

formatuuid

StartingAtTime

formatdate-time

ApplicableProductTagsarray

optional

[]string

EndingBeforeTime

optional

formatdate-time

Entitledbool

optional

IsCommitSpecificbool

optional

Multiplierfloat64

optional

OverrideSpecifiersarray

optional

[]V2ContractGetResponseDataOverridesOverrideSpecifier

Hide ParametersShow Parameters

BillingFrequency

optional

Hide ParametersShow Parameters

V2ContractGetResponseDataOverridesOverrideSpecifiersBillingFrequencyMonthlyconst

"MONTHLY"

V2ContractGetResponseDataOverridesOverrideSpecifiersBillingFrequencyQuarterlyconst

"QUARTERLY"

V2ContractGetResponseDataOverridesOverrideSpecifiersBillingFrequencyAnnualconst

"ANNUAL"

V2ContractGetResponseDataOverridesOverrideSpecifiersBillingFrequencyWeeklyconst

"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

[]V2ContractGetResponseDataOverridesOverrideTier

Hide ParametersShow Parameters

Multiplierfloat64

Sizefloat64

optional

OverwriteRate

optional

Hide ParametersShow Parameters

RateType

Hide ParametersShow Parameters

V2ContractGetResponseDataOverridesOverwriteRateRateTypeFlatconst

"FLAT"

V2ContractGetResponseDataOverridesOverwriteRateRateTypePercentageconst

"PERCENTAGE"

V2ContractGetResponseDataOverridesOverwriteRateRateTypeSubscriptionconst

"SUBSCRIPTION"

V2ContractGetResponseDataOverridesOverwriteRateRateTypeTieredconst

"TIERED"

V2ContractGetResponseDataOverridesOverwriteRateRateTypeCustomconst

"CUSTOM"

CreditType

optional

CustomRatemap

optional

map[string, unknown]

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

IsProratedbool

optional

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

Pricefloat64

optional

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

Quantityfloat64

optional

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

Tiersarray

optional

[]

Only set for TIERED rate_type.

Hide ParametersShow Parameters

Pricefloat64

Sizefloat64

optional

Priorityfloat64

optional

Product

optional

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Target

optional

Hide ParametersShow Parameters

V2ContractGetResponseDataOverridesTargetCommitRateconst

"COMMIT_RATE"

V2ContractGetResponseDataOverridesTargetListRateconst

"LIST_RATE"

Type

optional

Hide ParametersShow Parameters

V2ContractGetResponseDataOverridesTypeOverwriteconst

"OVERWRITE"

V2ContractGetResponseDataOverridesTypeMultiplierconst

"MULTIPLIER"

V2ContractGetResponseDataOverridesTypeTieredconst

"TIERED"

ScheduledChargesarray

[]

Hide ParametersShow Parameters

IDstring

formatuuid

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Schedule

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

[]V2ContractGetResponseDataTransition

Hide ParametersShow Parameters

FromContractIDstring

formatuuid

ToContractIDstring

formatuuid

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataTransitionsTypeSupersedeconst

"SUPERSEDE"

V2ContractGetResponseDataTransitionsTypeRenewalconst

"RENEWAL"

UsageFilterarray

[]V2ContractGetResponseDataUsageFilter

Hide ParametersShow Parameters

GroupKeystring

GroupValuesarray

[]string

StartingAtTime

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

formatdate-time

EndingBeforeTime

optional

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

formatdate-time

UsageStatementSchedule

Hide ParametersShow Parameters

BillingAnchorDateTime

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

formatdate-time

Frequency

Hide ParametersShow Parameters

V2ContractGetResponseDataUsageStatementScheduleFrequencyMonthlyconst

"MONTHLY"

V2ContractGetResponseDataUsageStatementScheduleFrequencyQuarterlyconst

"QUARTERLY"

V2ContractGetResponseDataUsageStatementScheduleFrequencyAnnualconst

"ANNUAL"

V2ContractGetResponseDataUsageStatementScheduleFrequencyWeeklyconst

"WEEKLY"

ArchivedAtTime

optional

formatdate-time

Creditsarray

optional

[]V2ContractGetResponseDataCredit

Hide ParametersShow Parameters

IDstring

formatuuid

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsTypeCreditconst

"CREDIT"

AccessSchedule

optional

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

ApplicableContractIDsarray

optional

[]string

ApplicableProductIDsarray

optional

[]string

ApplicableProductTagsarray

optional

[]string

Balancefloat64

optional

Contract

optional

Hide ParametersShow Parameters

IDstring

formatuuid

CustomFieldsmap

optional

map[string, string]

Descriptionstring

optional

HierarchyConfiguration

optional

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V2ContractGetResponseDataCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V2ContractGetResponseDataCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

Ledgerarray

optional

[]V2ContractGetResponseDataCreditsLedger

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

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsLedgerCreditSegmentStartLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsLedgerCreditSegmentStartLedgerEntryTypeCreditSegmentStartconst

"CREDIT_SEGMENT_START"

V2ContractGetResponseDataCreditsLedgerCreditAutomatedInvoiceDeductionLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditAutomatedInvoiceDeductionconst

"CREDIT_AUTOMATED_INVOICE_DEDUCTION"

ContractIDstring

optional

formatuuid

V2ContractGetResponseDataCreditsLedgerCreditExpirationLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsLedgerCreditExpirationLedgerEntryTypeCreditExpirationconst

"CREDIT_EXPIRATION"

V2ContractGetResponseDataCreditsLedgerCreditCanceledLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsLedgerCreditCanceledLedgerEntryTypeCreditCanceledconst

"CREDIT_CANCELED"

ContractIDstring

optional

formatuuid

V2ContractGetResponseDataCreditsLedgerCreditCreditedLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsLedgerCreditCreditedLedgerEntryTypeCreditCreditedconst

"CREDIT_CREDITED"

ContractIDstring

optional

formatuuid

V2ContractGetResponseDataCreditsLedgerCreditManualLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

Reasonstring

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsLedgerCreditManualLedgerEntryTypeCreditManualconst

"CREDIT_MANUAL"

V2ContractGetResponseDataCreditsLedgerCreditSeatBasedAdjustmentLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataCreditsLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditSeatBasedAdjustmentconst

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

SalesforceOpportunityIDstring

optional

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

Specifiersarray

optional

[]V2ContractGetResponseDataCreditsSpecifier

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.

CustomFieldsmap

optional

map[string, string]

CustomerBillingProviderConfiguration

optional

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

Hide ParametersShow Parameters

IDstring

ID of Customer's billing provider configuration.

formatuuid

BillingProvider

Hide ParametersShow Parameters

V2ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderAwsMarketplaceconst

"aws_marketplace"

V2ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderStripeconst

"stripe"

V2ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderNetsuiteconst

"netsuite"

V2ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderCustomconst

"custom"

V2ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderAzureMarketplaceconst

"azure_marketplace"

V2ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderQuickbooksOnlineconst

"quickbooks_online"

V2ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderWorkdayconst

"workday"

V2ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderGcpMarketplaceconst

"gcp_marketplace"

DeliveryMethod

Hide ParametersShow Parameters

V2ContractGetResponseDataCustomerBillingProviderConfigurationDeliveryMethodDirectToBillingProviderconst

"direct_to_billing_provider"

V2ContractGetResponseDataCustomerBillingProviderConfigurationDeliveryMethodAwsSqsconst

"aws_sqs"

V2ContractGetResponseDataCustomerBillingProviderConfigurationDeliveryMethodTackleconst

"tackle"

V2ContractGetResponseDataCustomerBillingProviderConfigurationDeliveryMethodAwsSnsconst

"aws_sns"

Discountsarray

optional

[]

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

Hide ParametersShow Parameters

IDstring

formatuuid

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Schedule

CustomFieldsmap

optional

map[string, string]

Namestring

optional

minLength1

NetsuiteSalesOrderIDstring

optional

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

EndingBeforeTime

optional

formatdate-time

HasMore

optional

Indicates whether there are more items than the limit for this endpoint. Use the respective list endpoints to get the full lists.

Hide ParametersShow Parameters

Commitsbool

Whether there are more commits on this contract than the limit for this endpoint. Use the /contracts/customerCommits/list endpoint to get the full list of commits.

Creditsbool

Whether there are more credits on this contract than the limit for this endpoint. Use the /contracts/customerCredits/list endpoint to get the full list of credits.

HierarchyConfiguration

optional

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

Hide ParametersShow Parameters

V2ContractGetResponseDataHierarchyConfigurationParentHierarchyConfigurationstruct

Hide ParametersShow Parameters

Childrenarray

[]V2ContractGetResponseDataHierarchyConfigurationParentHierarchyConfigurationChild

List of contracts that belong to this parent.

Hide ParametersShow Parameters

ContractIDstring

formatuuid

CustomerIDstring

formatuuid

V2ContractGetResponseDataHierarchyConfigurationChildHierarchyConfigurationstruct

Hide ParametersShow Parameters

Parent

The single parent contract/customer for this child.

Hide ParametersShow Parameters

ContractIDstring

formatuuid

CustomerIDstring

formatuuid

MultiplierOverridePrioritization

optional

Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list prices automatically. EXPLICIT prioritization requires specifying priorities for each multiplier; the one with the lowest priority value will be prioritized first.

Hide ParametersShow Parameters

V2ContractGetResponseDataMultiplierOverridePrioritizationLowestMultiplierconst

"LOWEST_MULTIPLIER"

V2ContractGetResponseDataMultiplierOverridePrioritizationExplicitconst

"EXPLICIT"

Namestring

optional

NetPaymentTermsDaysfloat64

optional

NetsuiteSalesOrderIDstring

optional

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

PrepaidBalanceThresholdConfiguration

optional

Hide ParametersShow Parameters

Commit

Hide ParametersShow Parameters

ProductIDstring

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

ApplicableProductIDsarray

optional

[]string

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

ApplicableProductTagsarray

optional

[]string

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

Descriptionstring

optional

Namestring

optional

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

Specifiersarray

optional

[]V2ContractGetResponseDataPrepaidBalanceThresholdConfigurationCommitSpecifier

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with applicable_product_ids or applicable_product_tags. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

Hide ParametersShow Parameters

PresentationGroupValuesmap

optional

map[string, string]

PricingGroupValuesmap

optional

map[string, string]

ProductIDstring

optional

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

formatuuid

ProductTagsarray

optional

[]string

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

IsEnabledbool

When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.

PaymentGateConfig

Hide ParametersShow Parameters

PaymentGateType

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

Hide ParametersShow Parameters

V2ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

"NONE"

V2ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

"STRIPE"

V2ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

"EXTERNAL"

PrecalculatedTaxConfig

optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

TaxAmountfloat64

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

TaxNamestring

optional

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

StripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

"INVOICE"

V2ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxType

optional

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

Hide ParametersShow Parameters

V2ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

"NONE"

V2ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

"STRIPE"

V2ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

"ANROK"

V2ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

"PRECALCULATED"

RechargeToAmountfloat64

Specify the amount the balance should be recharged to.

ThresholdAmountfloat64

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

CustomCreditTypeIDstring

optional

If provided, the threshold, recharge-to amount, and the resulting threshold commit amount will be in terms of this credit type instead of the fiat currency.

formatuuid

Priorityfloat64

optional

Priority of the contract.

ProfessionalServicesarray

optional

[]

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

[]V2ContractGetResponseDataRecurringCommit

Hide ParametersShow Parameters

IDstring

formatuuid

AccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters

CreditTypeIDstring

formatuuid

UnitPricefloat64

Quantityfloat64

optional

CommitDuration

The amount of time the created commits will be valid for

Hide ParametersShow Parameters

Valuefloat64

Unit

optional

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCommitsCommitDurationUnitPeriodsconst

"PERIODS"

Priorityfloat64

Will be passed down to the individual commits

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

RateType

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

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCommitsRateTypeCommitRateconst

"COMMIT_RATE"

V2ContractGetResponseDataRecurringCommitsRateTypeListRateconst

"LIST_RATE"

StartingAtTime

Determines the start time for the first commit

formatdate-time

ApplicableProductIDsarray

optional

[]string

Will be passed down to the individual commits

ApplicableProductTagsarray

optional

[]string

Will be passed down to the individual commits

Contract

optional

Hide ParametersShow Parameters

IDstring

formatuuid

Descriptionstring

optional

Will be passed down to the individual commits

EndingBeforeTime

optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time

HierarchyConfiguration

optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V2ContractGetResponseDataRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V2ContractGetResponseDataRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCommitsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

InvoiceAmount

optional

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

Hide ParametersShow Parameters

CreditTypeIDstring

formatuuid

Quantityfloat64

UnitPricefloat64

Namestring

optional

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

NetsuiteSalesOrderIDstring

optional

Will be passed down to the individual commits

Proration

optional

Determines whether the first and last commit will be prorated. If not provided, the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCommitsProrationNoneconst

"NONE"

V2ContractGetResponseDataRecurringCommitsProrationFirstconst

"FIRST"

V2ContractGetResponseDataRecurringCommitsProrationLastconst

"LAST"

V2ContractGetResponseDataRecurringCommitsProrationFirstAndLastconst

"FIRST_AND_LAST"

RecurrenceFrequency

optional

The frequency at which the recurring commits will be created. If not provided: - The commits will be created on the usage invoice frequency. If provided: - The period defined in the duration will correspond to this frequency. - Commits will be created aligned with the recurring commit's starting_at rather than the usage invoice dates.

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCommitsRecurrenceFrequencyMonthlyconst

"MONTHLY"

V2ContractGetResponseDataRecurringCommitsRecurrenceFrequencyQuarterlyconst

"QUARTERLY"

V2ContractGetResponseDataRecurringCommitsRecurrenceFrequencyAnnualconst

"ANNUAL"

V2ContractGetResponseDataRecurringCommitsRecurrenceFrequencyWeeklyconst

"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

[]V2ContractGetResponseDataRecurringCommitsSpecifier

Hide ParametersShow Parameters

PresentationGroupValuesmap

optional

map[string, string]

PricingGroupValuesmap

optional

map[string, string]

ProductIDstring

optional

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

formatuuid

ProductTagsarray

optional

[]string

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

SubscriptionConfig

optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters

Allocation

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCommitsSubscriptionConfigAllocationIndividualconst

"INDIVIDUAL"

V2ContractGetResponseDataRecurringCommitsSubscriptionConfigAllocationPooledconst

"POOLED"

ApplySeatIncreaseConfig

Hide ParametersShow Parameters

IsProratedbool

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

SubscriptionIDstring

formatuuid

RecurringCreditsarray

optional

[]V2ContractGetResponseDataRecurringCredit

Hide ParametersShow Parameters

IDstring

formatuuid

AccessAmount

The amount of commit to grant.

Hide ParametersShow Parameters

CreditTypeIDstring

formatuuid

UnitPricefloat64

Quantityfloat64

optional

CommitDuration

The amount of time the created commits will be valid for

Hide ParametersShow Parameters

Valuefloat64

Unit

optional

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCreditsCommitDurationUnitPeriodsconst

"PERIODS"

Priorityfloat64

Will be passed down to the individual commits

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

RateType

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

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCreditsRateTypeCommitRateconst

"COMMIT_RATE"

V2ContractGetResponseDataRecurringCreditsRateTypeListRateconst

"LIST_RATE"

StartingAtTime

Determines the start time for the first commit

formatdate-time

ApplicableProductIDsarray

optional

[]string

Will be passed down to the individual commits

ApplicableProductTagsarray

optional

[]string

Will be passed down to the individual commits

Contract

optional

Hide ParametersShow Parameters

IDstring

formatuuid

Descriptionstring

optional

Will be passed down to the individual commits

EndingBeforeTime

optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time

HierarchyConfiguration

optional

Optional configuration for recurring credit hierarchy access control

Hide ParametersShow Parameters

ChildAccess

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

V2ContractGetResponseDataRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

V2ContractGetResponseDataRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCreditsHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"CONTRACT_IDS"

Namestring

optional

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

NetsuiteSalesOrderIDstring

optional

Will be passed down to the individual commits

Proration

optional

Determines whether the first and last commit will be prorated. If not provided, the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCreditsProrationNoneconst

"NONE"

V2ContractGetResponseDataRecurringCreditsProrationFirstconst

"FIRST"

V2ContractGetResponseDataRecurringCreditsProrationLastconst

"LAST"

V2ContractGetResponseDataRecurringCreditsProrationFirstAndLastconst

"FIRST_AND_LAST"

RecurrenceFrequency

optional

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCreditsRecurrenceFrequencyMonthlyconst

"MONTHLY"

V2ContractGetResponseDataRecurringCreditsRecurrenceFrequencyQuarterlyconst

"QUARTERLY"

V2ContractGetResponseDataRecurringCreditsRecurrenceFrequencyAnnualconst

"ANNUAL"

V2ContractGetResponseDataRecurringCreditsRecurrenceFrequencyWeeklyconst

"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

[]V2ContractGetResponseDataRecurringCreditsSpecifier

Hide ParametersShow Parameters

PresentationGroupValuesmap

optional

map[string, string]

PricingGroupValuesmap

optional

map[string, string]

ProductIDstring

optional

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

formatuuid

ProductTagsarray

optional

[]string

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

SubscriptionConfig

optional

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters

Allocation

Hide ParametersShow Parameters

V2ContractGetResponseDataRecurringCreditsSubscriptionConfigAllocationIndividualconst

"INDIVIDUAL"

V2ContractGetResponseDataRecurringCreditsSubscriptionConfigAllocationPooledconst

"POOLED"

ApplySeatIncreaseConfig

Hide ParametersShow Parameters

IsProratedbool

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

SubscriptionIDstring

formatuuid

ResellerRoyaltiesarray

optional

[]V2ContractGetResponseDataResellerRoyalty

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

Hide ParametersShow Parameters

ResellerType

Hide ParametersShow Parameters

V2ContractGetResponseDataResellerRoyaltiesResellerTypeAwsconst

"AWS"

V2ContractGetResponseDataResellerRoyaltiesResellerTypeAwsProServiceconst

"AWS_PRO_SERVICE"

V2ContractGetResponseDataResellerRoyaltiesResellerTypeGcpconst

"GCP"

V2ContractGetResponseDataResellerRoyaltiesResellerTypeGcpProServiceconst

"GCP_PRO_SERVICE"

Segmentsarray

[]V2ContractGetResponseDataResellerRoyaltiesSegment

Hide ParametersShow Parameters

Fractionfloat64

NetsuiteResellerIDstring

ResellerType

Hide ParametersShow Parameters

V2ContractGetResponseDataResellerRoyaltiesSegmentsResellerTypeAwsconst

"AWS"

V2ContractGetResponseDataResellerRoyaltiesSegmentsResellerTypeAwsProServiceconst

"AWS_PRO_SERVICE"

V2ContractGetResponseDataResellerRoyaltiesSegmentsResellerTypeGcpconst

"GCP"

V2ContractGetResponseDataResellerRoyaltiesSegmentsResellerTypeGcpProServiceconst

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

ScheduledChargesOnUsageInvoices

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

V2ContractGetResponseDataScheduledChargesOnUsageInvoicesAllconst

"ALL"

SpendThresholdConfiguration

optional

Hide ParametersShow Parameters

Commit

Hide ParametersShow Parameters

ProductIDstring

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

Descriptionstring

optional

Namestring

optional

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

IsEnabledbool

When set to false, the contract will not be evaluated against the threshold_amount. Toggling to true will result an immediate evaluation, regardless of prior state.

PaymentGateConfig

Hide ParametersShow Parameters

PaymentGateType

Hide ParametersShow Parameters

V2ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

"NONE"

V2ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

"STRIPE"

V2ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

"EXTERNAL"

PrecalculatedTaxConfig

optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

TaxAmountfloat64

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

TaxNamestring

optional

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

StripeConfig

optional

Only applicable if using STRIPE as your payment gateway type.

Hide ParametersShow Parameters

PaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V2ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

"INVOICE"

V2ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

"PAYMENT_INTENT"

InvoiceMetadatamap

optional

map[string, string]

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

TaxType

optional

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

Hide ParametersShow Parameters

V2ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

"NONE"

V2ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

"STRIPE"

V2ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

"ANROK"

V2ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

"PRECALCULATED"

ThresholdAmountfloat64

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

Subscriptionsarray

optional

[]V2ContractGetResponseDataSubscription

List of subscriptions on the contract.

Hide ParametersShow Parameters

CollectionSchedule

Hide ParametersShow Parameters

V2ContractGetResponseDataSubscriptionsCollectionScheduleAdvanceconst

"ADVANCE"

V2ContractGetResponseDataSubscriptionsCollectionScheduleArrearsconst

"ARREARS"

Proration

Hide ParametersShow Parameters

InvoiceBehavior

Hide ParametersShow Parameters

V2ContractGetResponseDataSubscriptionsProrationInvoiceBehaviorBillImmediatelyconst

"BILL_IMMEDIATELY"

V2ContractGetResponseDataSubscriptionsProrationInvoiceBehaviorBillOnNextCollectionDateconst

"BILL_ON_NEXT_COLLECTION_DATE"

IsProratedbool

QuantitySchedulearray

[]V2ContractGetResponseDataSubscriptionsQuantitySchedule

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

Hide ParametersShow Parameters

Quantityfloat64

StartingAtTime

formatdate-time

EndingBeforeTime

optional

formatdate-time

StartingAtTime

formatdate-time

SubscriptionRate

Hide ParametersShow Parameters

BillingFrequency

Hide ParametersShow Parameters

V2ContractGetResponseDataSubscriptionsSubscriptionRateBillingFrequencyMonthlyconst

"MONTHLY"

V2ContractGetResponseDataSubscriptionsSubscriptionRateBillingFrequencyQuarterlyconst

"QUARTERLY"

V2ContractGetResponseDataSubscriptionsSubscriptionRateBillingFrequencyAnnualconst

"ANNUAL"

V2ContractGetResponseDataSubscriptionsSubscriptionRateBillingFrequencyWeeklyconst

"WEEKLY"

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

IDstring

optional

formatuuid

CustomFieldsmap

optional

map[string, string]

Descriptionstring

optional

EndingBeforeTime

optional

formatdate-time

FiatCreditTypeIDstring

optional

formatuuid

Namestring

optional

TotalContractValuefloat64

optional

UniquenessKeystring

optional

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

minLength1

maxLength128

package main

import (
  "context"
  "fmt"

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

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

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "commits": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "product": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "type": "PREPAID",
        "access_schedule": {
          "schedule_items": [
            {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "amount": 0,
              "ending_before": "2019-12-27T18:11:19.117Z",
              "starting_at": "2019-12-27T18:11:19.117Z"
            }
          ],
          "credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          }
        },
        "applicable_contract_ids": [
          "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        ],
        "applicable_product_ids": [
          "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        ],
        "applicable_product_tags": [
          "string"
        ],
        "archived_at": "2019-12-27T18:11:19.117Z",
        "balance": 0,
        "contract": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        },
        "custom_fields": {
          "foo": "string"
        },
        "description": "description",
        "hierarchy_configuration": {
          "child_access": {
            "type": "ALL"
          }
        },
        "invoice_contract": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        },
        "invoice_schedule": {
          "credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "do_not_invoice": true,
          "schedule_items": [
            {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "amount": 0,
              "quantity": 0,
              "timestamp": "2019-12-27T18:11:19.117Z",
              "unit_price": 0,
              "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
            }
          ]
        },
        "ledger": [
          {
            "amount": 0,
            "segment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "timestamp": "2019-12-27T18:11:19.117Z",
            "type": "PREPAID_COMMIT_SEGMENT_START"
          }
        ],
        "name": "name",
        "netsuite_sales_order_id": "netsuite_sales_order_id",
        "priority": 0,
        "rate_type": "COMMIT_RATE",
        "rolled_over_from": {
          "commit_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        },
        "rollover_fraction": 0,
        "salesforce_opportunity_id": "salesforce_opportunity_id",
        "specifiers": [
          {
            "presentation_group_values": {
              "foo": "string"
            },
            "pricing_group_values": {
              "foo": "string"
            },
            "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "product_tags": [
              "string"
            ]
          }
        ]
      }
    ],
    "created_at": "2019-12-27T18:11:19.117Z",
    "created_by": "created_by",
    "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "overrides": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "starting_at": "2019-12-27T18:11:19.117Z",
        "applicable_product_tags": [
          "string"
        ],
        "ending_before": "2019-12-27T18:11:19.117Z",
        "entitled": true,
        "is_commit_specific": true,
        "multiplier": 0,
        "override_specifiers": [
          {
            "billing_frequency": "MONTHLY",
            "commit_ids": [
              "string"
            ],
            "presentation_group_values": {
              "foo": "string"
            },
            "pricing_group_values": {
              "foo": "string"
            },
            "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "product_tags": [
              "string"
            ],
            "recurring_commit_ids": [
              "string"
            ],
            "recurring_credit_ids": [
              "string"
            ]
          }
        ],
        "override_tiers": [
          {
            "multiplier": 0,
            "size": 0
          }
        ],
        "overwrite_rate": {
          "rate_type": "FLAT",
          "credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "custom_rate": {
            "foo": "bar"
          },
          "is_prorated": true,
          "price": 0,
          "quantity": 0,
          "tiers": [
            {
              "price": 0,
              "size": 0
            }
          ]
        },
        "priority": 0,
        "product": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "target": "COMMIT_RATE",
        "type": "OVERWRITE"
      }
    ],
    "scheduled_charges": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "product": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "schedule": {
          "credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "do_not_invoice": true,
          "schedule_items": [
            {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "amount": 0,
              "quantity": 0,
              "timestamp": "2019-12-27T18:11:19.117Z",
              "unit_price": 0,
              "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
            }
          ]
        },
        "archived_at": "2019-12-27T18:11:19.117Z",
        "custom_fields": {
          "foo": "string"
        },
        "name": "x",
        "netsuite_sales_order_id": "netsuite_sales_order_id"
      }
    ],
    "starting_at": "2019-12-27T18:11:19.117Z",
    "transitions": [
      {
        "from_contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "to_contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "type": "SUPERSEDE"
      }
    ],
    "usage_filter": [
      {
        "group_key": "group_key",
        "group_values": [
          "string"
        ],
        "starting_at": "2019-12-27T18:11:19.117Z",
        "ending_before": "2019-12-27T18:11:19.117Z"
      }
    ],
    "usage_statement_schedule": {
      "billing_anchor_date": "2019-12-27T18:11:19.117Z",
      "frequency": "MONTHLY"
    },
    "archived_at": "2019-12-27T18:11:19.117Z",
    "credits": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "product": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "type": "CREDIT",
        "access_schedule": {
          "schedule_items": [
            {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "amount": 0,
              "ending_before": "2019-12-27T18:11:19.117Z",
              "starting_at": "2019-12-27T18:11:19.117Z"
            }
          ],
          "credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          }
        },
        "applicable_contract_ids": [
          "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        ],
        "applicable_product_ids": [
          "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        ],
        "applicable_product_tags": [
          "string"
        ],
        "balance": 0,
        "contract": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        },
        "custom_fields": {
          "foo": "string"
        },
        "description": "description",
        "hierarchy_configuration": {
          "child_access": {
            "type": "ALL"
          }
        },
        "ledger": [
          {
            "amount": 0,
            "segment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "timestamp": "2019-12-27T18:11:19.117Z",
            "type": "CREDIT_SEGMENT_START"
          }
        ],
        "name": "name",
        "netsuite_sales_order_id": "netsuite_sales_order_id",
        "priority": 0,
        "salesforce_opportunity_id": "salesforce_opportunity_id",
        "specifiers": [
          {
            "presentation_group_values": {
              "foo": "string"
            },
            "pricing_group_values": {
              "foo": "string"
            },
            "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "product_tags": [
              "string"
            ]
          }
        ]
      }
    ],
    "custom_fields": {
      "foo": "string"
    },
    "customer_billing_provider_configuration": {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "billing_provider": "aws_marketplace",
      "delivery_method": "direct_to_billing_provider"
    },
    "discounts": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "product": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "schedule": {
          "credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "do_not_invoice": true,
          "schedule_items": [
            {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "amount": 0,
              "quantity": 0,
              "timestamp": "2019-12-27T18:11:19.117Z",
              "unit_price": 0,
              "invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
            }
          ]
        },
        "custom_fields": {
          "foo": "string"
        },
        "name": "x",
        "netsuite_sales_order_id": "netsuite_sales_order_id"
      }
    ],
    "ending_before": "2019-12-27T18:11:19.117Z",
    "has_more": {
      "commits": true,
      "credits": true
    },
    "hierarchy_configuration": {
      "children": [
        {
          "contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      ]
    },
    "multiplier_override_prioritization": "LOWEST_MULTIPLIER",
    "name": "name",
    "net_payment_terms_days": 0,
    "netsuite_sales_order_id": "netsuite_sales_order_id",
    "prepaid_balance_threshold_configuration": {
      "commit": {
        "product_id": "product_id",
        "applicable_product_ids": [
          "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        ],
        "applicable_product_tags": [
          "string"
        ],
        "description": "description",
        "name": "name",
        "specifiers": [
          {
            "presentation_group_values": {
              "foo": "string"
            },
            "pricing_group_values": {
              "foo": "string"
            },
            "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "product_tags": [
              "string"
            ]
          }
        ]
      },
      "is_enabled": true,
      "payment_gate_config": {
        "payment_gate_type": "NONE",
        "precalculated_tax_config": {
          "tax_amount": 0,
          "tax_name": "tax_name"
        },
        "stripe_config": {
          "payment_type": "INVOICE",
          "invoice_metadata": {
            "foo": "string"
          }
        },
        "tax_type": "NONE"
      },
      "recharge_to_amount": 0,
      "threshold_amount": 0,
      "custom_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
    },
    "priority": 0,
    "professional_services": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "max_amount": 0,
        "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "quantity": 0,
        "unit_price": 0,
        "custom_fields": {
          "foo": "string"
        },
        "description": "description",
        "netsuite_sales_order_id": "netsuite_sales_order_id"
      }
    ],
    "rate_card_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "recurring_commits": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "access_amount": {
          "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "unit_price": 0,
          "quantity": 0
        },
        "commit_duration": {
          "value": 0,
          "unit": "PERIODS"
        },
        "priority": 0,
        "product": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "rate_type": "COMMIT_RATE",
        "starting_at": "2019-12-27T18:11:19.117Z",
        "applicable_product_ids": [
          "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        ],
        "applicable_product_tags": [
          "string"
        ],
        "contract": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        },
        "description": "description",
        "ending_before": "2019-12-27T18:11:19.117Z",
        "hierarchy_configuration": {
          "child_access": {
            "type": "ALL"
          }
        },
        "invoice_amount": {
          "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "quantity": 0,
          "unit_price": 0
        },
        "name": "name",
        "netsuite_sales_order_id": "netsuite_sales_order_id",
        "proration": "NONE",
        "recurrence_frequency": "MONTHLY",
        "rollover_fraction": 0,
        "specifiers": [
          {
            "presentation_group_values": {
              "foo": "string"
            },
            "pricing_group_values": {
              "foo": "string"
            },
            "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "product_tags": [
              "string"
            ]
          }
        ],
        "subscription_config": {
          "allocation": "INDIVIDUAL",
          "apply_seat_increase_config": {
            "is_prorated": true
          },
          "subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      }
    ],
    "recurring_credits": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "access_amount": {
          "credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "unit_price": 0,
          "quantity": 0
        },
        "commit_duration": {
          "value": 0,
          "unit": "PERIODS"
        },
        "priority": 0,
        "product": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "name": "name"
        },
        "rate_type": "COMMIT_RATE",
        "starting_at": "2019-12-27T18:11:19.117Z",
        "applicable_product_ids": [
          "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        ],
        "applicable_product_tags": [
          "string"
        ],
        "contract": {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        },
        "description": "description",
        "ending_before": "2019-12-27T18:11:19.117Z",
        "hierarchy_configuration": {
          "child_access": {
            "type": "ALL"
          }
        },
        "name": "name",
        "netsuite_sales_order_id": "netsuite_sales_order_id",
        "proration": "NONE",
        "recurrence_frequency": "MONTHLY",
        "rollover_fraction": 0,
        "specifiers": [
          {
            "presentation_group_values": {
              "foo": "string"
            },
            "pricing_group_values": {
              "foo": "string"
            },
            "product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "product_tags": [
              "string"
            ]
          }
        ],
        "subscription_config": {
          "allocation": "INDIVIDUAL",
          "apply_seat_increase_config": {
            "is_prorated": true
          },
          "subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
        }
      }
    ],
    "reseller_royalties": [
      {
        "reseller_type": "AWS",
        "segments": [
          {
            "fraction": 0,
            "netsuite_reseller_id": "netsuite_reseller_id",
            "reseller_type": "AWS",
            "starting_at": "2019-12-27T18:11:19.117Z",
            "applicable_product_ids": [
              "string"
            ],
            "applicable_product_tags": [
              "string"
            ],
            "aws_account_number": "aws_account_number",
            "aws_offer_id": "aws_offer_id",
            "aws_payer_reference_id": "aws_payer_reference_id",
            "ending_before": "2019-12-27T18:11:19.117Z",
            "gcp_account_id": "gcp_account_id",
            "gcp_offer_id": "gcp_offer_id",
            "reseller_contract_value": 0
          }
        ]
      }
    ],
    "salesforce_opportunity_id": "salesforce_opportunity_id",
    "scheduled_charges_on_usage_invoices": "ALL",
    "spend_threshold_configuration": {
      "commit": {
        "product_id": "product_id",
        "description": "description",
        "name": "name"
      },
      "is_enabled": true,
      "payment_gate_config": {
        "payment_gate_type": "NONE",
        "precalculated_tax_config": {
          "tax_amount": 0,
          "tax_name": "tax_name"
        },
        "stripe_config": {
          "payment_type": "INVOICE",
          "invoice_metadata": {
            "foo": "string"
          }
        },
        "tax_type": "NONE"
      },
      "threshold_amount": 0
    },
    "subscriptions": [
      {
        "collection_schedule": "ADVANCE",
        "proration": {
          "invoice_behavior": "BILL_IMMEDIATELY",
          "is_prorated": true
        },
        "quantity_schedule": [
          {
            "quantity": 0,
            "starting_at": "2019-12-27T18:11:19.117Z",
            "ending_before": "2019-12-27T18:11:19.117Z"
          }
        ],
        "starting_at": "2019-12-27T18:11:19.117Z",
        "subscription_rate": {
          "billing_frequency": "MONTHLY",
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          }
        },
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "custom_fields": {
          "foo": "string"
        },
        "description": "description",
        "ending_before": "2019-12-27T18:11:19.117Z",
        "fiat_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "name": "name"
      }
    ],
    "total_contract_value": 0,
    "uniqueness_key": "x"
  }
}