Retrieve

API Reference

Contracts

Get a contract (v1)

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

post/v1/contracts/get

This is the v1 endpoint to get a contract. New clients should implement using the v2 endpoint.

Parameters

body

Hide ParametersShow Parameters

ContractIDfield

param.Field[string]

formatuuid

CustomerIDfield

param.Field[string]

formatuuid

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 ledgers in the response. Setting this flag may cause the query to be slower.

Returns

V1ContractGetResponsestruct

Hide ParametersShow Parameters

Data

Hide ParametersShow Parameters

IDstring

formatuuid

Amendmentsarray

[]V1ContractGetResponseDataAmendment

Hide ParametersShow Parameters

IDstring

formatuuid

Commitsarray

[]

Hide ParametersShow Parameters

IDstring

formatuuid

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Type

Hide ParametersShow Parameters

CommitTypePrepaidconst

"PREPAID"

CommitTypePostpaidconst

"POSTPAID"

AccessSchedule

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.

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

CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

CommitHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"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

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

Type

Hide ParametersShow Parameters

CommitLedgerPrepaidCommitSegmentStartLedgerEntryTypePrepaidCommitSegmentStartconst

"PREPAID_COMMIT_SEGMENT_START"

CommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPrepaidCommitAutomatedInvoiceDeductionLedgerEntryTypePrepaidCommitAutomatedInvoiceDeductionconst

"PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"

ContractIDstring

optional

formatuuid

CommitLedgerPrepaidCommitRolloverLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

NewContractIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPrepaidCommitRolloverLedgerEntryTypePrepaidCommitRolloverconst

"PREPAID_COMMIT_ROLLOVER"

CommitLedgerPrepaidCommitExpirationLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPrepaidCommitExpirationLedgerEntryTypePrepaidCommitExpirationconst

"PREPAID_COMMIT_EXPIRATION"

CommitLedgerPrepaidCommitCanceledLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPrepaidCommitCanceledLedgerEntryTypePrepaidCommitCanceledconst

"PREPAID_COMMIT_CANCELED"

ContractIDstring

optional

formatuuid

CommitLedgerPrepaidCommitCreditedLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPrepaidCommitCreditedLedgerEntryTypePrepaidCommitCreditedconst

"PREPAID_COMMIT_CREDITED"

ContractIDstring

optional

formatuuid

CommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPrepaidCommitSeatBasedAdjustmentLedgerEntryTypePrepaidCommitSeatBasedAdjustmentconst

"PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT"

CommitLedgerPostpaidCommitInitialBalanceLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPostpaidCommitInitialBalanceLedgerEntryTypePostpaidCommitInitialBalanceconst

"POSTPAID_COMMIT_INITIAL_BALANCE"

CommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPostpaidCommitAutomatedInvoiceDeductionLedgerEntryTypePostpaidCommitAutomatedInvoiceDeductionconst

"POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION"

ContractIDstring

optional

formatuuid

CommitLedgerPostpaidCommitRolloverLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

NewContractIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPostpaidCommitRolloverLedgerEntryTypePostpaidCommitRolloverconst

"POSTPAID_COMMIT_ROLLOVER"

CommitLedgerPostpaidCommitTrueupLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPostpaidCommitTrueupLedgerEntryTypePostpaidCommitTrueupconst

"POSTPAID_COMMIT_TRUEUP"

ContractIDstring

optional

formatuuid

CommitLedgerPrepaidCommitManualLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

Reasonstring

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPrepaidCommitManualLedgerEntryTypePrepaidCommitManualconst

"PREPAID_COMMIT_MANUAL"

CommitLedgerPostpaidCommitManualLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

Reasonstring

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPostpaidCommitManualLedgerEntryTypePostpaidCommitManualconst

"POSTPAID_COMMIT_MANUAL"

CommitLedgerPostpaidCommitExpirationLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CommitLedgerPostpaidCommitExpirationLedgerEntryTypePostpaidCommitExpirationconst

"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

CommitRateTypeCommitRateconst

"COMMIT_RATE"

CommitRateTypeListRateconst

"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

[]CommitSpecifier

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

[]

Hide ParametersShow Parameters

IDstring

formatuuid

StartingAtTime

formatdate-time

ApplicableProductTagsarray

optional

[]string

CreditType

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

BillingFrequency

optional

Hide ParametersShow Parameters

OverrideOverrideSpecifiersBillingFrequencyMonthlyconst

"MONTHLY"

OverrideOverrideSpecifiersBillingFrequencyQuarterlyconst

"QUARTERLY"

OverrideOverrideSpecifiersBillingFrequencyAnnualconst

"ANNUAL"

OverrideOverrideSpecifiersBillingFrequencyWeeklyconst

"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

OverwriteRate

optional

Hide ParametersShow Parameters

RateType

Hide ParametersShow Parameters

OverrideOverwriteRateRateTypeFlatconst

"FLAT"

OverrideOverwriteRateRateTypePercentageconst

"PERCENTAGE"

OverrideOverwriteRateRateTypeSubscriptionconst

"SUBSCRIPTION"

OverrideOverwriteRateRateTypeTieredconst

"TIERED"

OverrideOverwriteRateRateTypeCustomconst

"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

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

Product

optional

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Quantityfloat64

optional

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

RateType

optional

Hide ParametersShow Parameters

OverrideRateTypeFlatconst

"FLAT"

OverrideRateTypePercentageconst

"PERCENTAGE"

OverrideRateTypeSubscriptionconst

"SUBSCRIPTION"

OverrideRateTypeTieredconst

"TIERED"

OverrideRateTypeCustomconst

"CUSTOM"

Target

optional

Hide ParametersShow Parameters

OverrideTargetCommitRateconst

"COMMIT_RATE"

OverrideTargetListRateconst

"LIST_RATE"

Tiersarray

optional

[]

Only set for TIERED rate_type.

Hide ParametersShow Parameters

Pricefloat64

Sizefloat64

optional

Type

optional

Hide ParametersShow Parameters

OverrideTypeOverwriteconst

"OVERWRITE"

OverrideTypeMultiplierconst

"MULTIPLIER"

OverrideTypeTieredconst

"TIERED"

Valuemap

optional

map[string, unknown]

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

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

Creditsarray

optional

[]

Hide ParametersShow Parameters

IDstring

formatuuid

Product

Hide ParametersShow Parameters

IDstring

formatuuid

Namestring

Type

Hide ParametersShow Parameters

CreditTypeCreditconst

"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

CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllstruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessAllTypeAllconst

"ALL"

CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNonestruct

Hide ParametersShow Parameters

Type

Hide ParametersShow Parameters

CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessNoneTypeNoneconst

"NONE"

CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsstruct

Hide ParametersShow Parameters

ContractIDsarray

[]string

Type

Hide ParametersShow Parameters

CreditHierarchyConfigurationChildAccessCommitHierarchyChildAccessContractIDsTypeContractIDsconst

"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

Type

Hide ParametersShow Parameters

CreditLedgerCreditSegmentStartLedgerEntryTypeCreditSegmentStartconst

"CREDIT_SEGMENT_START"

CreditLedgerCreditAutomatedInvoiceDeductionLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CreditLedgerCreditAutomatedInvoiceDeductionLedgerEntryTypeCreditAutomatedInvoiceDeductionconst

"CREDIT_AUTOMATED_INVOICE_DEDUCTION"

ContractIDstring

optional

formatuuid

CreditLedgerCreditExpirationLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CreditLedgerCreditExpirationLedgerEntryTypeCreditExpirationconst

"CREDIT_EXPIRATION"

CreditLedgerCreditCanceledLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CreditLedgerCreditCanceledLedgerEntryTypeCreditCanceledconst

"CREDIT_CANCELED"

ContractIDstring

optional

formatuuid

CreditLedgerCreditCreditedLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

InvoiceIDstring

formatuuid

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CreditLedgerCreditCreditedLedgerEntryTypeCreditCreditedconst

"CREDIT_CREDITED"

ContractIDstring

optional

formatuuid

CreditLedgerCreditManualLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

Reasonstring

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CreditLedgerCreditManualLedgerEntryTypeCreditManualconst

"CREDIT_MANUAL"

CreditLedgerCreditSeatBasedAdjustmentLedgerEntrystruct

Hide ParametersShow Parameters

Amountfloat64

SegmentIDstring

formatuuid

TimestampTime

formatdate-time

Type

Hide ParametersShow Parameters

CreditLedgerCreditSeatBasedAdjustmentLedgerEntryTypeCreditSeatBasedAdjustmentconst

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

RateType

optional

Hide ParametersShow Parameters

CreditRateTypeCommitRateconst

"COMMIT_RATE"

CreditRateTypeListRateconst

"LIST_RATE"

SalesforceOpportunityIDstring

optional

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

Specifiersarray

optional

[]CreditSpecifier

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

minLength1

maxLength128

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.

NetsuiteSalesOrderIDstring

optional

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

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.

ResellerRoyaltiesarray

optional

[]V1ContractGetResponseDataAmendmentsResellerRoyalty

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

Hide ParametersShow Parameters

ResellerType

Hide ParametersShow Parameters

V1ContractGetResponseDataAmendmentsResellerRoyaltiesResellerTypeAwsconst

"AWS"

V1ContractGetResponseDataAmendmentsResellerRoyaltiesResellerTypeAwsProServiceconst

"AWS_PRO_SERVICE"

V1ContractGetResponseDataAmendmentsResellerRoyaltiesResellerTypeGcpconst

"GCP"

V1ContractGetResponseDataAmendmentsResellerRoyaltiesResellerTypeGcpProServiceconst

"GCP_PRO_SERVICE"

AwsAccountNumberstring

optional

AwsOfferIDstring

optional

AwsPayerReferenceIDstring

optional

EndingBeforeTime

optional

formatdate-time

Fractionfloat64

optional

GcpAccountIDstring

optional

GcpOfferIDstring

optional

NetsuiteResellerIDstring

optional

ResellerContractValuefloat64

optional

StartingAtTime

optional

formatdate-time

SalesforceOpportunityIDstring

optional

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

Current

CustomerIDstring

formatuuid

Initial

ArchivedAtTime

optional

RFC 3339 timestamp indicating when the contract was archived. If not returned, the contract is not archived.

formatdate-time

CustomFieldsmap

optional

map[string, string]

CustomerBillingProviderConfiguration

optional

The billing provider configuration associated with a contract.

Hide ParametersShow Parameters

BillingProvider

Hide ParametersShow Parameters

V1ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderAwsMarketplaceconst

"aws_marketplace"

V1ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderStripeconst

"stripe"

V1ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderNetsuiteconst

"netsuite"

V1ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderCustomconst

"custom"

V1ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderAzureMarketplaceconst

"azure_marketplace"

V1ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderQuickbooksOnlineconst

"quickbooks_online"

V1ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderWorkdayconst

"workday"

V1ContractGetResponseDataCustomerBillingProviderConfigurationBillingProviderGcpMarketplaceconst

"gcp_marketplace"

DeliveryMethod

Hide ParametersShow Parameters

V1ContractGetResponseDataCustomerBillingProviderConfigurationDeliveryMethodDirectToBillingProviderconst

"direct_to_billing_provider"

V1ContractGetResponseDataCustomerBillingProviderConfigurationDeliveryMethodAwsSqsconst

"aws_sqs"

V1ContractGetResponseDataCustomerBillingProviderConfigurationDeliveryMethodTackleconst

"tackle"

V1ContractGetResponseDataCustomerBillingProviderConfigurationDeliveryMethodAwsSnsconst

"aws_sns"

IDstring

optional

formatuuid

Configurationmap

optional

map[string, unknown]

Configuration for the billing provider. The structure of this object is specific to the billing provider.

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

[]V1ContractGetResponseDataPrepaidBalanceThresholdConfigurationCommitSpecifier

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.

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

V1ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

"NONE"

V1ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

"STRIPE"

V1ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

"EXTERNAL"

PrecalculatedTaxConfig

optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

TaxAmountfloat64

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

TaxNamestring

optional

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

StripeConfig

optional

Only applicable if using STRIPE as your payment gate type.

Hide ParametersShow Parameters

PaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V1ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

"INVOICE"

V1ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

"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

V1ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

"NONE"

V1ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

"STRIPE"

V1ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

"ANROK"

V1ContractGetResponseDataPrepaidBalanceThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

"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

Priorityfloat64

optional

Priority of the contract.

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

V1ContractGetResponseDataScheduledChargesOnUsageInvoicesAllconst

"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

V1ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeNoneconst

"NONE"

V1ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeStripeconst

"STRIPE"

V1ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigPaymentGateTypeExternalconst

"EXTERNAL"

PrecalculatedTaxConfig

optional

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

TaxAmountfloat64

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

TaxNamestring

optional

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

StripeConfig

optional

Only applicable if using STRIPE as your payment gate type.

Hide ParametersShow Parameters

PaymentType

If left blank, will default to INVOICE

Hide ParametersShow Parameters

V1ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypeInvoiceconst

"INVOICE"

V1ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigStripeConfigPaymentTypePaymentIntentconst

"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

V1ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigTaxTypeNoneconst

"NONE"

V1ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigTaxTypeStripeconst

"STRIPE"

V1ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigTaxTypeAnrokconst

"ANROK"

V1ContractGetResponseDataSpendThresholdConfigurationPaymentGateConfigTaxTypePrecalculatedconst

"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

[]V1ContractGetResponseDataSubscription

List of subscriptions on the contract.

Hide ParametersShow Parameters

CollectionSchedule

Hide ParametersShow Parameters

V1ContractGetResponseDataSubscriptionsCollectionScheduleAdvanceconst

"ADVANCE"

V1ContractGetResponseDataSubscriptionsCollectionScheduleArrearsconst

"ARREARS"

Proration

Hide ParametersShow Parameters

InvoiceBehavior

Hide ParametersShow Parameters

V1ContractGetResponseDataSubscriptionsProrationInvoiceBehaviorBillImmediatelyconst

"BILL_IMMEDIATELY"

V1ContractGetResponseDataSubscriptionsProrationInvoiceBehaviorBillOnNextCollectionDateconst

"BILL_ON_NEXT_COLLECTION_DATE"

IsProratedbool

QuantitySchedulearray

[]V1ContractGetResponseDataSubscriptionsQuantitySchedule

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

V1ContractGetResponseDataSubscriptionsSubscriptionRateBillingFrequencyMonthlyconst

"MONTHLY"

V1ContractGetResponseDataSubscriptionsSubscriptionRateBillingFrequencyQuarterlyconst

"QUARTERLY"

V1ContractGetResponseDataSubscriptionsSubscriptionRateBillingFrequencyAnnualconst

"ANNUAL"

V1ContractGetResponseDataSubscriptionsSubscriptionRateBillingFrequencyWeeklyconst

"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

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.V1.Contracts.Get(context.TODO(), metronome.V1ContractGetParams{
    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",
    "amendments": [
      {
        "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"
              }
            },
            "amount": 0,
            "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"
                ]
              }
            ],
            "uniqueness_key": "x"
          }
        ],
        "created_at": "2019-12-27T18:11:19.117Z",
        "created_by": "created_by",
        "overrides": [
          {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "starting_at": "2019-12-27T18:11:19.117Z",
            "applicable_product_tags": [
              "string"
            ],
            "credit_type": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "ending_before": "2019-12-27T18:11:19.117Z",
            "entitled": true,
            "is_commit_specific": true,
            "is_prorated": 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
                }
              ]
            },
            "price": 0,
            "priority": 0,
            "product": {
              "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
              "name": "name"
            },
            "quantity": 0,
            "rate_type": "FLAT",
            "target": "COMMIT_RATE",
            "tiers": [
              {
                "price": 0,
                "size": 0
              }
            ],
            "type": "OVERWRITE",
            "value": {
              "foo": "bar"
            }
          }
        ],
        "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",
        "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,
            "rate_type": "COMMIT_RATE",
            "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"
                ]
              }
            ],
            "uniqueness_key": "x"
          }
        ],
        "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"
          }
        ],
        "netsuite_sales_order_id": "netsuite_sales_order_id",
        "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"
          }
        ],
        "reseller_royalties": [
          {
            "reseller_type": "AWS",
            "aws_account_number": "aws_account_number",
            "aws_offer_id": "aws_offer_id",
            "aws_payer_reference_id": "aws_payer_reference_id",
            "ending_before": "2019-12-27T18:11:19.117Z",
            "fraction": 0,
            "gcp_account_id": "gcp_account_id",
            "gcp_offer_id": "gcp_offer_id",
            "netsuite_reseller_id": "netsuite_reseller_id",
            "reseller_contract_value": 0,
            "starting_at": "2019-12-27T18:11:19.117Z"
          }
        ],
        "salesforce_opportunity_id": "salesforce_opportunity_id"
      }
    ],
    "current": {
      "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"
            }
          },
          "amount": 0,
          "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"
              ]
            }
          ],
          "uniqueness_key": "x"
        }
      ],
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "overrides": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "starting_at": "2019-12-27T18:11:19.117Z",
          "applicable_product_tags": [
            "string"
          ],
          "credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "ending_before": "2019-12-27T18:11:19.117Z",
          "entitled": true,
          "is_commit_specific": true,
          "is_prorated": 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
              }
            ]
          },
          "price": 0,
          "priority": 0,
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "quantity": 0,
          "rate_type": "FLAT",
          "target": "COMMIT_RATE",
          "tiers": [
            {
              "price": 0,
              "size": 0
            }
          ],
          "type": "OVERWRITE",
          "value": {
            "foo": "bar"
          }
        }
      ],
      "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_statement_schedule": {
        "billing_anchor_date": "2019-12-27T18:11:19.117Z",
        "frequency": "MONTHLY"
      },
      "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,
          "rate_type": "COMMIT_RATE",
          "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"
              ]
            }
          ],
          "uniqueness_key": "x"
        }
      ],
      "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",
      "hierarchy_configuration": {
        "children": [
          {
            "contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          }
        ]
      },
      "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"
      },
      "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": [
        {
          "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
      },
      "total_contract_value": 0,
      "usage_filter": {
        "current": {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z"
        },
        "initial": {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z"
        },
        "updates": [
          {
            "group_key": "group_key",
            "group_values": [
              "string"
            ],
            "starting_at": "2019-12-27T18:11:19.117Z"
          }
        ]
      }
    },
    "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "initial": {
      "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"
            }
          },
          "amount": 0,
          "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"
              ]
            }
          ],
          "uniqueness_key": "x"
        }
      ],
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "overrides": [
        {
          "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
          "starting_at": "2019-12-27T18:11:19.117Z",
          "applicable_product_tags": [
            "string"
          ],
          "credit_type": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "ending_before": "2019-12-27T18:11:19.117Z",
          "entitled": true,
          "is_commit_specific": true,
          "is_prorated": 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
              }
            ]
          },
          "price": 0,
          "priority": 0,
          "product": {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "name": "name"
          },
          "quantity": 0,
          "rate_type": "FLAT",
          "target": "COMMIT_RATE",
          "tiers": [
            {
              "price": 0,
              "size": 0
            }
          ],
          "type": "OVERWRITE",
          "value": {
            "foo": "bar"
          }
        }
      ],
      "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_statement_schedule": {
        "billing_anchor_date": "2019-12-27T18:11:19.117Z",
        "frequency": "MONTHLY"
      },
      "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,
          "rate_type": "COMMIT_RATE",
          "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"
              ]
            }
          ],
          "uniqueness_key": "x"
        }
      ],
      "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",
      "hierarchy_configuration": {
        "children": [
          {
            "contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
          }
        ]
      },
      "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"
      },
      "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": [
        {
          "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
      },
      "total_contract_value": 0,
      "usage_filter": {
        "current": {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z"
        },
        "initial": {
          "group_key": "group_key",
          "group_values": [
            "string"
          ],
          "starting_at": "2019-12-27T18:11:19.117Z"
        },
        "updates": [
          {
            "group_key": "group_key",
            "group_values": [
              "string"
            ],
            "starting_at": "2019-12-27T18:11:19.117Z"
          }
        ]
      }
    },
    "archived_at": "2019-12-27T18:11:19.117Z",
    "custom_fields": {
      "foo": "string"
    },
    "customer_billing_provider_configuration": {
      "billing_provider": "aws_marketplace",
      "delivery_method": "direct_to_billing_provider",
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "configuration": {
        "foo": "bar"
      }
    },
    "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,
    "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"
      }
    ],
    "uniqueness_key": "x"
  }
}