Shared

API Reference

Shared

Shared

Base Usage Filter

BaseUsageFilterclass

ShowShow

group_keyString

group_valuesarray

Array[String]

starting_atTime

optional

formatdate-time

Commit

Commitclass

ShowShow

idString

formatuuid

productobject

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

typeunion

:PREPAID | :POSTPAID

Hide ParametersShow Parameters

:PREPAID

:POSTPAID

access_scheduleschedule_itemsarraycredit_typeCreditTypeDataScheduleDuration

optional

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

amountFloat

optional

(DEPRECATED) Use access_schedule + invoice_schedule instead.

applicable_contract_idsarray

optional

Array[String]

applicable_product_idsarray

optional

Array[String]

applicable_product_tagsarray

optional

Array[String]

archived_atTime

optional

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

formatdate-time

balanceFloat

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.

contractobject

optional

{ id}

Hide ParametersShow Parameters

idString

formatuuid

custom_fieldshash

optional

Hash[Symbol, String]

descriptionString

optional

hierarchy_configurationobject

optional

{ child_access}

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters

child_accessunion

{ type} | { type} | { contract_ids, type}

Hide ParametersShow Parameters

CommitHierarchyChildAccessAllclass

Hide ParametersShow Parameters

typeunion

:ALL

Hide ParametersShow Parameters

:ALL

CommitHierarchyChildAccessNoneclass

Hide ParametersShow Parameters

typeunion

:NONE

Hide ParametersShow Parameters

:NONE

CommitHierarchyChildAccessContractIDsclass

Hide ParametersShow Parameters

contract_idsarray

Array[String]

typeunion

:CONTRACT_IDS

Hide ParametersShow Parameters

:CONTRACT_IDS

invoice_contractobject

optional

{ id}

The contract that this commit will be billed on.

Hide ParametersShow Parameters

idString

formatuuid

invoice_schedulecredit_typeCreditTypeDatado_not_invoiceboolschedule_itemsarraySchedulePointInTime

optional

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

ledgerarray

optional

Array[{ amount, segment_id, timestamp, type} | { amount, invoice_id, segment_id, 3 more} | { amount, new_contract_id, segment_id, 2 more} | 11 more]

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

Hide ParametersShow Parameters

PrepaidCommitSegmentStartLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_SEGMENT_START

Hide ParametersShow Parameters

:PREPAID_COMMIT_SEGMENT_START

PrepaidCommitAutomatedInvoiceDeductionLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION

Hide ParametersShow Parameters

:PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION

contract_idString

optional

formatuuid

PrepaidCommitRolloverLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

new_contract_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_ROLLOVER

Hide ParametersShow Parameters

:PREPAID_COMMIT_ROLLOVER

PrepaidCommitExpirationLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_EXPIRATION

Hide ParametersShow Parameters

:PREPAID_COMMIT_EXPIRATION

PrepaidCommitCanceledLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_CANCELED

Hide ParametersShow Parameters

:PREPAID_COMMIT_CANCELED

contract_idString

optional

formatuuid

PrepaidCommitCreditedLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_CREDITED

Hide ParametersShow Parameters

:PREPAID_COMMIT_CREDITED

contract_idString

optional

formatuuid

PrepaidCommitSeatBasedAdjustmentLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT

Hide ParametersShow Parameters

:PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT

PostpaidCommitInitialBalanceLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_INITIAL_BALANCE

Hide ParametersShow Parameters

:POSTPAID_COMMIT_INITIAL_BALANCE

PostpaidCommitAutomatedInvoiceDeductionLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION

Hide ParametersShow Parameters

:POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION

contract_idString

optional

formatuuid

PostpaidCommitRolloverLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

new_contract_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_ROLLOVER

Hide ParametersShow Parameters

:POSTPAID_COMMIT_ROLLOVER

PostpaidCommitTrueupLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_TRUEUP

Hide ParametersShow Parameters

:POSTPAID_COMMIT_TRUEUP

contract_idString

optional

formatuuid

PrepaidCommitManualLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

reasonString

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_MANUAL

Hide ParametersShow Parameters

:PREPAID_COMMIT_MANUAL

PostpaidCommitManualLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

reasonString

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_MANUAL

Hide ParametersShow Parameters

:POSTPAID_COMMIT_MANUAL

PostpaidCommitExpirationLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_EXPIRATION

Hide ParametersShow Parameters

:POSTPAID_COMMIT_EXPIRATION

nameString

optional

netsuite_sales_order_idString

optional

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

priorityFloat

optional

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

rate_typeunion

optional

:COMMIT_RATE | :LIST_RATE

Hide ParametersShow Parameters

:COMMIT_RATE

:LIST_RATE

rolled_over_fromobject

optional

{ commit_id, contract_id}

Hide ParametersShow Parameters

commit_idString

formatuuid

contract_idString

formatuuid

rollover_fractionFloat

optional

salesforce_opportunity_idString

optional

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

specifiersarray

optional

Array[{ presentation_group_values, pricing_group_values, product_id, product_tags}]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown.

Hide ParametersShow Parameters

presentation_group_valueshash

optional

Hash[Symbol, String]

pricing_group_valueshash

optional

Hash[Symbol, String]

product_idString

optional

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

formatuuid

product_tagsarray

optional

Array[String]

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

uniqueness_keyString

optional

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

minLength1

maxLength128

Contract Without Amendments

ContractWithoutAmendmentsclass

ShowShow

commitsarray

Array[idStringproductobjecttypeunionaccess_scheduleScheduleDurationamountFloatapplicable_contract_idsarrayapplicable_product_idsarrayapplicable_product_tagsarrayarchived_atTimebalanceFloatcontractobjectcustom_fieldshashdescriptionStringhierarchy_configurationobjectinvoice_contractobjectinvoice_scheduleSchedulePointInTimeledgerarraynameStringnetsuite_sales_order_idStringpriorityFloatrate_typeunionrolled_over_fromobjectrollover_fractionFloatsalesforce_opportunity_idStringspecifiersarrayuniqueness_keyStringCommit]

Hide ParametersShow Parameters

idString

formatuuid

productobject

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

typeunion

:PREPAID | :POSTPAID

Hide ParametersShow Parameters

:PREPAID

:POSTPAID

access_scheduleschedule_itemsarraycredit_typeCreditTypeDataScheduleDuration

optional

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

amountFloat

optional

(DEPRECATED) Use access_schedule + invoice_schedule instead.

applicable_contract_idsarray

optional

Array[String]

applicable_product_idsarray

optional

Array[String]

applicable_product_tagsarray

optional

Array[String]

archived_atTime

optional

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

formatdate-time

balanceFloat

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.

contractobject

optional

{ id}

Hide ParametersShow Parameters

idString

formatuuid

custom_fieldshash

optional

Hash[Symbol, String]

descriptionString

optional

hierarchy_configurationobject

optional

{ child_access}

Optional configuration for commit hierarchy access control

Hide ParametersShow Parameters

child_accessunion

{ type} | { type} | { contract_ids, type}

Hide ParametersShow Parameters

CommitHierarchyChildAccessAllclass

Hide ParametersShow Parameters

typeunion

:ALL

Hide ParametersShow Parameters

:ALL

CommitHierarchyChildAccessNoneclass

Hide ParametersShow Parameters

typeunion

:NONE

Hide ParametersShow Parameters

:NONE

CommitHierarchyChildAccessContractIDsclass

Hide ParametersShow Parameters

contract_idsarray

Array[String]

typeunion

:CONTRACT_IDS

Hide ParametersShow Parameters

:CONTRACT_IDS

invoice_contractobject

optional

{ id}

The contract that this commit will be billed on.

Hide ParametersShow Parameters

idString

formatuuid

invoice_schedulecredit_typeCreditTypeDatado_not_invoiceboolschedule_itemsarraySchedulePointInTime

optional

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

ledgerarray

optional

Array[{ amount, segment_id, timestamp, type} | { amount, invoice_id, segment_id, 3 more} | { amount, new_contract_id, segment_id, 2 more} | 11 more]

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

Hide ParametersShow Parameters

PrepaidCommitSegmentStartLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_SEGMENT_START

Hide ParametersShow Parameters

:PREPAID_COMMIT_SEGMENT_START

PrepaidCommitAutomatedInvoiceDeductionLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION

Hide ParametersShow Parameters

:PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION

contract_idString

optional

formatuuid

PrepaidCommitRolloverLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

new_contract_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_ROLLOVER

Hide ParametersShow Parameters

:PREPAID_COMMIT_ROLLOVER

PrepaidCommitExpirationLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_EXPIRATION

Hide ParametersShow Parameters

:PREPAID_COMMIT_EXPIRATION

PrepaidCommitCanceledLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_CANCELED

Hide ParametersShow Parameters

:PREPAID_COMMIT_CANCELED

contract_idString

optional

formatuuid

PrepaidCommitCreditedLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_CREDITED

Hide ParametersShow Parameters

:PREPAID_COMMIT_CREDITED

contract_idString

optional

formatuuid

PrepaidCommitSeatBasedAdjustmentLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT

Hide ParametersShow Parameters

:PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT

PostpaidCommitInitialBalanceLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_INITIAL_BALANCE

Hide ParametersShow Parameters

:POSTPAID_COMMIT_INITIAL_BALANCE

PostpaidCommitAutomatedInvoiceDeductionLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION

Hide ParametersShow Parameters

:POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION

contract_idString

optional

formatuuid

PostpaidCommitRolloverLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

new_contract_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_ROLLOVER

Hide ParametersShow Parameters

:POSTPAID_COMMIT_ROLLOVER

PostpaidCommitTrueupLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_TRUEUP

Hide ParametersShow Parameters

:POSTPAID_COMMIT_TRUEUP

contract_idString

optional

formatuuid

PrepaidCommitManualLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

reasonString

timestampTime

formatdate-time

typeunion

:PREPAID_COMMIT_MANUAL

Hide ParametersShow Parameters

:PREPAID_COMMIT_MANUAL

PostpaidCommitManualLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

reasonString

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_MANUAL

Hide ParametersShow Parameters

:POSTPAID_COMMIT_MANUAL

PostpaidCommitExpirationLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

timestampTime

formatdate-time

typeunion

:POSTPAID_COMMIT_EXPIRATION

Hide ParametersShow Parameters

:POSTPAID_COMMIT_EXPIRATION

nameString

optional

netsuite_sales_order_idString

optional

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

priorityFloat

optional

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

rate_typeunion

optional

:COMMIT_RATE | :LIST_RATE

Hide ParametersShow Parameters

:COMMIT_RATE

:LIST_RATE

rolled_over_fromobject

optional

{ commit_id, contract_id}

Hide ParametersShow Parameters

commit_idString

formatuuid

contract_idString

formatuuid

rollover_fractionFloat

optional

salesforce_opportunity_idString

optional

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

specifiersarray

optional

Array[{ presentation_group_values, pricing_group_values, product_id, product_tags}]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown.

Hide ParametersShow Parameters

presentation_group_valueshash

optional

Hash[Symbol, String]

pricing_group_valueshash

optional

Hash[Symbol, String]

product_idString

optional

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

formatuuid

product_tagsarray

optional

Array[String]

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

uniqueness_keyString

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

created_atTime

formatdate-time

created_byString

overridesarray

Array[idStringstarting_atTimeapplicable_product_tagsarraycredit_typeCreditTypeDataending_beforeTimeentitledboolis_commit_specificboolis_proratedboolmultiplierFloatoverride_specifiersarrayoverride_tiersarrayoverwrite_rateobjectpriceFloatpriorityFloatproductobjectquantityFloatrate_typeuniontargetuniontiersarraytypeunionvaluehashOverride]

Hide ParametersShow Parameters

idString

formatuuid

starting_atTime

formatdate-time

applicable_product_tagsarray

optional

Array[String]

credit_typeidStringnameStringCreditTypeData

optional

ending_beforeTime

optional

formatdate-time

entitledbool

optional

is_commit_specificbool

optional

is_proratedbool

optional

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

multiplierFloat

optional

override_specifiersarray

optional

Array[{ billing_frequency, commit_ids, presentation_group_values, 5 more}]

Hide ParametersShow Parameters

billing_frequencyunion

optional

:MONTHLY | :QUARTERLY | :ANNUAL | :WEEKLY

Hide ParametersShow Parameters

:MONTHLY

:QUARTERLY

:ANNUAL

:WEEKLY

commit_idsarray

optional

Array[String]

presentation_group_valueshash

optional

Hash[Symbol, String]

pricing_group_valueshash

optional

Hash[Symbol, String]

product_idString

optional

formatuuid

product_tagsarray

optional

Array[String]

recurring_commit_idsarray

optional

Array[String]

recurring_credit_idsarray

optional

Array[String]

override_tiersarray

optional

Array[{ multiplier, size}]

Hide ParametersShow Parameters

multiplierFloat

sizeFloat

optional

overwrite_rateobject

optional

{ rate_type, credit_type, custom_rate, 4 more}

Hide ParametersShow Parameters

rate_typeunion

:FLAT | :PERCENTAGE | :SUBSCRIPTION | 2 more

Hide ParametersShow Parameters

:FLAT

:PERCENTAGE

:SUBSCRIPTION

:TIERED

:CUSTOM

credit_typeidStringnameStringCreditTypeData

optional

custom_ratehash

optional

Hash[Symbol, untyped]

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

is_proratedbool

optional

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

priceFloat

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.

quantityFloat

optional

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

tiersarray

optional

Array[priceFloatsizeFloatTier]

Only set for TIERED rate_type.

Hide ParametersShow Parameters

priceFloat

sizeFloat

optional

priceFloat

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.

priorityFloat

optional

productobject

optional

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

quantityFloat

optional

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

rate_typeunion

optional

:FLAT | :PERCENTAGE | :SUBSCRIPTION | 2 more

Hide ParametersShow Parameters

:FLAT

:PERCENTAGE

:SUBSCRIPTION

:TIERED

:CUSTOM

targetunion

optional

:COMMIT_RATE | :LIST_RATE

Hide ParametersShow Parameters

:COMMIT_RATE

:LIST_RATE

tiersarray

optional

Array[priceFloatsizeFloatTier]

Only set for TIERED rate_type.

Hide ParametersShow Parameters

priceFloat

sizeFloat

optional

typeunion

optional

:OVERWRITE | :MULTIPLIER | :TIERED

Hide ParametersShow Parameters

:OVERWRITE

:MULTIPLIER

:TIERED

valuehash

optional

Hash[Symbol, untyped]

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

scheduled_chargesarray

Array[idStringproductobjectscheduleSchedulePointInTimearchived_atTimecustom_fieldshashnameStringnetsuite_sales_order_idStringScheduledCharge]

Hide ParametersShow Parameters

idString

formatuuid

productobject

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

schedulecredit_typeCreditTypeDatado_not_invoiceboolschedule_itemsarraySchedulePointInTime

archived_atTime

optional

formatdate-time

custom_fieldshash

optional

Hash[Symbol, String]

nameString

optional

displayed on invoices

minLength1

netsuite_sales_order_idString

optional

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

starting_atTime

formatdate-time

transitionsarray

Array[{ from_contract_id, to_contract_id, type}]

Hide ParametersShow Parameters

from_contract_idString

formatuuid

to_contract_idString

formatuuid

typeunion

:SUPERSEDE | :RENEWAL

Hide ParametersShow Parameters

:SUPERSEDE

:RENEWAL

usage_statement_scheduleobject

{ billing_anchor_date, frequency}

Hide ParametersShow Parameters

billing_anchor_dateTime

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

formatdate-time

frequencyunion

:MONTHLY | :QUARTERLY | :ANNUAL | :WEEKLY

Hide ParametersShow Parameters

:MONTHLY

:QUARTERLY

:ANNUAL

:WEEKLY

creditsarray

optional

Array[idStringproductobjecttypeunionaccess_scheduleScheduleDurationapplicable_contract_idsarrayapplicable_product_idsarrayapplicable_product_tagsarraybalanceFloatcontractobjectcustom_fieldshashdescriptionStringhierarchy_configurationobjectledgerarraynameStringnetsuite_sales_order_idStringpriorityFloatrate_typeunionsalesforce_opportunity_idStringspecifiersarrayuniqueness_keyStringCredit]

Hide ParametersShow Parameters

idString

formatuuid

productobject

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

typeunion

:CREDIT

Hide ParametersShow Parameters

:CREDIT

access_scheduleschedule_itemsarraycredit_typeCreditTypeDataScheduleDuration

optional

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

applicable_contract_idsarray

optional

Array[String]

applicable_product_idsarray

optional

Array[String]

applicable_product_tagsarray

optional

Array[String]

balanceFloat

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.

contractobject

optional

{ id}

Hide ParametersShow Parameters

idString

formatuuid

custom_fieldshash

optional

Hash[Symbol, String]

descriptionString

optional

hierarchy_configurationobject

optional

{ child_access}

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters

child_accessunion

{ type} | { type} | { contract_ids, type}

Hide ParametersShow Parameters

CommitHierarchyChildAccessAllclass

Hide ParametersShow Parameters

typeunion

:ALL

Hide ParametersShow Parameters

:ALL

CommitHierarchyChildAccessNoneclass

Hide ParametersShow Parameters

typeunion

:NONE

Hide ParametersShow Parameters

:NONE

CommitHierarchyChildAccessContractIDsclass

Hide ParametersShow Parameters

contract_idsarray

Array[String]

typeunion

:CONTRACT_IDS

Hide ParametersShow Parameters

:CONTRACT_IDS

ledgerarray

optional

Array[{ amount, segment_id, timestamp, type} | { amount, invoice_id, segment_id, 3 more} | { amount, segment_id, timestamp, type} | 4 more]

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

Hide ParametersShow Parameters

CreditSegmentStartLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_SEGMENT_START

Hide ParametersShow Parameters

:CREDIT_SEGMENT_START

CreditAutomatedInvoiceDeductionLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_AUTOMATED_INVOICE_DEDUCTION

Hide ParametersShow Parameters

:CREDIT_AUTOMATED_INVOICE_DEDUCTION

contract_idString

optional

formatuuid

CreditExpirationLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_EXPIRATION

Hide ParametersShow Parameters

:CREDIT_EXPIRATION

CreditCanceledLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_CANCELED

Hide ParametersShow Parameters

:CREDIT_CANCELED

contract_idString

optional

formatuuid

CreditCreditedLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_CREDITED

Hide ParametersShow Parameters

:CREDIT_CREDITED

contract_idString

optional

formatuuid

CreditManualLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

reasonString

timestampTime

formatdate-time

typeunion

:CREDIT_MANUAL

Hide ParametersShow Parameters

:CREDIT_MANUAL

CreditSeatBasedAdjustmentLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_SEAT_BASED_ADJUSTMENT

Hide ParametersShow Parameters

:CREDIT_SEAT_BASED_ADJUSTMENT

nameString

optional

netsuite_sales_order_idString

optional

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

priorityFloat

optional

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

rate_typeunion

optional

:COMMIT_RATE | :LIST_RATE

Hide ParametersShow Parameters

:COMMIT_RATE

:LIST_RATE

salesforce_opportunity_idString

optional

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

specifiersarray

optional

Array[{ presentation_group_values, pricing_group_values, product_id, product_tags}]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown.

Hide ParametersShow Parameters

presentation_group_valueshash

optional

Hash[Symbol, String]

pricing_group_valueshash

optional

Hash[Symbol, String]

product_idString

optional

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

formatuuid

product_tagsarray

optional

Array[String]

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

uniqueness_keyString

optional

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

minLength1

maxLength128

discountsarray

optional

Array[idStringproductobjectscheduleSchedulePointInTimecustom_fieldshashnameStringnetsuite_sales_order_idStringDiscount]

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

Hide ParametersShow Parameters

idString

formatuuid

productobject

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

schedulecredit_typeCreditTypeDatado_not_invoiceboolschedule_itemsarraySchedulePointInTime

custom_fieldshash

optional

Hash[Symbol, String]

nameString

optional

minLength1

netsuite_sales_order_idString

optional

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

ending_beforeTime

optional

formatdate-time

hierarchy_configurationunion

optional

{ children} | { parent}

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

Hide ParametersShow Parameters

ParentHierarchyConfigurationclass

Hide ParametersShow Parameters

childrenarray

Array[{ contract_id, customer_id}]

List of contracts that belong to this parent.

Hide ParametersShow Parameters

contract_idString

formatuuid

customer_idString

formatuuid

ChildHierarchyConfigurationclass

Hide ParametersShow Parameters

parentobject

{ contract_id, customer_id}

The single parent contract/customer for this child.

Hide ParametersShow Parameters

contract_idString

formatuuid

customer_idString

formatuuid

nameString

optional

net_payment_terms_daysFloat

optional

netsuite_sales_order_idString

optional

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

prepaid_balance_threshold_configurationobject

optional

{ commit, is_enabled, payment_gate_config, 3 more}

Hide ParametersShow Parameters

commitobject

{ product_id, applicable_product_ids, applicable_product_tags, 3 more}

Hide ParametersShow Parameters

product_idString

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

applicable_product_idsarray

optional

Array[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.

applicable_product_tagsarray

optional

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

Array[{ presentation_group_values, pricing_group_values, product_id, product_tags}]

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

presentation_group_valueshash

optional

Hash[Symbol, String]

pricing_group_valueshash

optional

Hash[Symbol, String]

product_idString

optional

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

formatuuid

product_tagsarray

optional

Array[String]

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

is_enabledbool

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.

payment_gate_configobject

{ payment_gate_type, precalculated_tax_config, stripe_config, tax_type}

Hide ParametersShow Parameters

payment_gate_typeunion

:NONE | :STRIPE | :EXTERNAL

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

:NONE

:STRIPE

:EXTERNAL

precalculated_tax_configobject

optional

{ tax_amount, tax_name}

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

tax_amountFloat

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

tax_nameString

optional

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

stripe_configobject

optional

{ payment_type, invoice_metadata}

Only applicable if using STRIPE as your payment gate type.

Hide ParametersShow Parameters

payment_typeunion

:INVOICE | :PAYMENT_INTENT

If left blank, will default to INVOICE

Hide ParametersShow Parameters

:INVOICE

:PAYMENT_INTENT

invoice_metadatahash

optional

Hash[Symbol, String]

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

tax_typeunion

optional

:NONE | :STRIPE | :ANROK | :PRECALCULATED

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

:NONE

:STRIPE

:ANROK

:PRECALCULATED

recharge_to_amountFloat

Specify the amount the balance should be recharged to.

threshold_amountFloat

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

custom_credit_type_idString

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

professional_servicesarray

optional

Array[idStringmax_amountFloatproduct_idStringquantityFloatunit_priceFloatcustom_fieldshashdescriptionStringnetsuite_sales_order_idStringProService]

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

Hide ParametersShow Parameters

idString

formatuuid

max_amountFloat

Maximum amount for the term.

product_idString

formatuuid

quantityFloat

Quantity for the charge. Will be multiplied by unit_price to determine the amount.

unit_priceFloat

Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified.

custom_fieldshash

optional

Hash[Symbol, String]

descriptionString

optional

netsuite_sales_order_idString

optional

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

rate_card_idString

optional

formatuuid

recurring_commitsarray

optional

Array[{ id, access_amount, commit_duration, 18 more}]

Hide ParametersShow Parameters

idString

formatuuid

access_amountobject

{ credit_type_id, unit_price, quantity}

The amount of commit to grant.

Hide ParametersShow Parameters

credit_type_idString

formatuuid

unit_priceFloat

quantityFloat

optional

commit_durationobject

{ value, unit}

The amount of time the created commits will be valid for

Hide ParametersShow Parameters

valueFloat

unitunion

optional

:PERIODS

Hide ParametersShow Parameters

:PERIODS

priorityFloat

Will be passed down to the individual commits

productobject

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

rate_typeunion

:COMMIT_RATE | :LIST_RATE

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

Hide ParametersShow Parameters

:COMMIT_RATE

:LIST_RATE

starting_atTime

Determines the start time for the first commit

formatdate-time

applicable_product_idsarray

optional

Array[String]

Will be passed down to the individual commits

applicable_product_tagsarray

optional

Array[String]

Will be passed down to the individual commits

contractobject

optional

{ id}

Hide ParametersShow Parameters

idString

formatuuid

descriptionString

optional

Will be passed down to the individual commits

ending_beforeTime

optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time

hierarchy_configurationobject

optional

{ child_access}

Optional configuration for recurring commit/credit hierarchy access control

Hide ParametersShow Parameters

child_accessunion

{ type} | { type} | { contract_ids, type}

Hide ParametersShow Parameters

CommitHierarchyChildAccessAllclass

Hide ParametersShow Parameters

typeunion

:ALL

Hide ParametersShow Parameters

:ALL

CommitHierarchyChildAccessNoneclass

Hide ParametersShow Parameters

typeunion

:NONE

Hide ParametersShow Parameters

:NONE

CommitHierarchyChildAccessContractIDsclass

Hide ParametersShow Parameters

contract_idsarray

Array[String]

typeunion

:CONTRACT_IDS

Hide ParametersShow Parameters

:CONTRACT_IDS

invoice_amountobject

optional

{ credit_type_id, quantity, unit_price}

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

Hide ParametersShow Parameters

credit_type_idString

formatuuid

quantityFloat

unit_priceFloat

nameString

optional

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

netsuite_sales_order_idString

optional

Will be passed down to the individual commits

prorationunion

optional

:NONE | :FIRST | :LAST | :FIRST_AND_LAST

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

:NONE

:FIRST

:LAST

:FIRST_AND_LAST

recurrence_frequencyunion

optional

:MONTHLY | :QUARTERLY | :ANNUAL | :WEEKLY

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

:MONTHLY

:QUARTERLY

:ANNUAL

:WEEKLY

rollover_fractionFloat

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

Array[{ presentation_group_values, pricing_group_values, product_id, product_tags}]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown.

Hide ParametersShow Parameters

presentation_group_valueshash

optional

Hash[Symbol, String]

pricing_group_valueshash

optional

Hash[Symbol, String]

product_idString

optional

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

formatuuid

product_tagsarray

optional

Array[String]

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

subscription_configobject

optional

{ allocation, apply_seat_increase_config, subscription_id}

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters

allocationunion

:INDIVIDUAL | :POOLED

Hide ParametersShow Parameters

:INDIVIDUAL

:POOLED

apply_seat_increase_configobject

{ is_prorated}

Hide ParametersShow Parameters

is_proratedbool

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

subscription_idString

formatuuid

recurring_creditsarray

optional

Array[{ id, access_amount, commit_duration, 17 more}]

Hide ParametersShow Parameters

idString

formatuuid

access_amountobject

{ credit_type_id, unit_price, quantity}

The amount of commit to grant.

Hide ParametersShow Parameters

credit_type_idString

formatuuid

unit_priceFloat

quantityFloat

optional

commit_durationobject

{ value, unit}

The amount of time the created commits will be valid for

Hide ParametersShow Parameters

valueFloat

unitunion

optional

:PERIODS

Hide ParametersShow Parameters

:PERIODS

priorityFloat

Will be passed down to the individual commits

productobject

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

rate_typeunion

:COMMIT_RATE | :LIST_RATE

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

Hide ParametersShow Parameters

:COMMIT_RATE

:LIST_RATE

starting_atTime

Determines the start time for the first commit

formatdate-time

applicable_product_idsarray

optional

Array[String]

Will be passed down to the individual commits

applicable_product_tagsarray

optional

Array[String]

Will be passed down to the individual commits

contractobject

optional

{ id}

Hide ParametersShow Parameters

idString

formatuuid

descriptionString

optional

Will be passed down to the individual commits

ending_beforeTime

optional

Determines when the contract will stop creating recurring commits. Optional

formatdate-time

hierarchy_configurationobject

optional

{ child_access}

Optional configuration for recurring commit/credit hierarchy access control

Hide ParametersShow Parameters

child_accessunion

{ type} | { type} | { contract_ids, type}

Hide ParametersShow Parameters

CommitHierarchyChildAccessAllclass

Hide ParametersShow Parameters

typeunion

:ALL

Hide ParametersShow Parameters

:ALL

CommitHierarchyChildAccessNoneclass

Hide ParametersShow Parameters

typeunion

:NONE

Hide ParametersShow Parameters

:NONE

CommitHierarchyChildAccessContractIDsclass

Hide ParametersShow Parameters

contract_idsarray

Array[String]

typeunion

:CONTRACT_IDS

Hide ParametersShow Parameters

:CONTRACT_IDS

nameString

optional

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

netsuite_sales_order_idString

optional

Will be passed down to the individual commits

prorationunion

optional

:NONE | :FIRST | :LAST | :FIRST_AND_LAST

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

:NONE

:FIRST

:LAST

:FIRST_AND_LAST

recurrence_frequencyunion

optional

:MONTHLY | :QUARTERLY | :ANNUAL | :WEEKLY

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

:MONTHLY

:QUARTERLY

:ANNUAL

:WEEKLY

rollover_fractionFloat

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

Array[{ presentation_group_values, pricing_group_values, product_id, product_tags}]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown.

Hide ParametersShow Parameters

presentation_group_valueshash

optional

Hash[Symbol, String]

pricing_group_valueshash

optional

Hash[Symbol, String]

product_idString

optional

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

formatuuid

product_tagsarray

optional

Array[String]

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

subscription_configobject

optional

{ allocation, apply_seat_increase_config, subscription_id}

Attach a subscription to the recurring commit/credit.

Hide ParametersShow Parameters

allocationunion

:INDIVIDUAL | :POOLED

Hide ParametersShow Parameters

:INDIVIDUAL

:POOLED

apply_seat_increase_configobject

{ is_prorated}

Hide ParametersShow Parameters

is_proratedbool

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

subscription_idString

formatuuid

reseller_royaltiesarray

optional

Array[{ fraction, netsuite_reseller_id, reseller_type, 10 more}]

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

Hide ParametersShow Parameters

fractionFloat

netsuite_reseller_idString

reseller_typeunion

:AWS | :AWS_PRO_SERVICE | :GCP | :GCP_PRO_SERVICE

Hide ParametersShow Parameters

:AWS

:AWS_PRO_SERVICE

:GCP

:GCP_PRO_SERVICE

starting_atTime

formatdate-time

applicable_product_idsarray

optional

Array[String]

applicable_product_tagsarray

optional

Array[String]

aws_account_numberString

optional

aws_offer_idString

optional

aws_payer_reference_idString

optional

ending_beforeTime

optional

formatdate-time

gcp_account_idString

optional

gcp_offer_idString

optional

reseller_contract_valueFloat

optional

salesforce_opportunity_idString

optional

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

scheduled_charges_on_usage_invoicesunion

optional

:ALL

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

:ALL

spend_threshold_configurationobject

optional

{ commit, is_enabled, payment_gate_config, threshold_amount}

Hide ParametersShow Parameters

commitobject

{ product_id, description, name}

Hide ParametersShow Parameters

product_idString

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.

is_enabledbool

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.

payment_gate_configobject

{ payment_gate_type, precalculated_tax_config, stripe_config, tax_type}

Hide ParametersShow Parameters

payment_gate_typeunion

:NONE | :STRIPE | :EXTERNAL

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

:NONE

:STRIPE

:EXTERNAL

precalculated_tax_configobject

optional

{ tax_amount, tax_name}

Only applicable if using PRECALCULATED as your tax type.

Hide ParametersShow Parameters

tax_amountFloat

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

tax_nameString

optional

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

stripe_configobject

optional

{ payment_type, invoice_metadata}

Only applicable if using STRIPE as your payment gate type.

Hide ParametersShow Parameters

payment_typeunion

:INVOICE | :PAYMENT_INTENT

If left blank, will default to INVOICE

Hide ParametersShow Parameters

:INVOICE

:PAYMENT_INTENT

invoice_metadatahash

optional

Hash[Symbol, String]

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

tax_typeunion

optional

:NONE | :STRIPE | :ANROK | :PRECALCULATED

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

:NONE

:STRIPE

:ANROK

:PRECALCULATED

threshold_amountFloat

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

total_contract_valueFloat

optional

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

usage_filterobject

optional

{ current, initial, updates}

Hide ParametersShow Parameters

currentgroup_keyStringgroup_valuesarraystarting_atTimeBaseUsageFilter

initialgroup_keyStringgroup_valuesarraystarting_atTimeBaseUsageFilter

updatesarray

Array[{ group_key, group_values, starting_at}]

Hide ParametersShow Parameters

group_keyString

group_valuesarray

Array[String]

starting_atTime

formatdate-time

Credit

Creditclass

ShowShow

idString

formatuuid

productobject

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

typeunion

:CREDIT

Hide ParametersShow Parameters

:CREDIT

access_scheduleschedule_itemsarraycredit_typeCreditTypeDataScheduleDuration

optional

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

applicable_contract_idsarray

optional

Array[String]

applicable_product_idsarray

optional

Array[String]

applicable_product_tagsarray

optional

Array[String]

balanceFloat

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.

contractobject

optional

{ id}

Hide ParametersShow Parameters

idString

formatuuid

custom_fieldshash

optional

Hash[Symbol, String]

descriptionString

optional

hierarchy_configurationobject

optional

{ child_access}

Optional configuration for credit hierarchy access control

Hide ParametersShow Parameters

child_accessunion

{ type} | { type} | { contract_ids, type}

Hide ParametersShow Parameters

CommitHierarchyChildAccessAllclass

Hide ParametersShow Parameters

typeunion

:ALL

Hide ParametersShow Parameters

:ALL

CommitHierarchyChildAccessNoneclass

Hide ParametersShow Parameters

typeunion

:NONE

Hide ParametersShow Parameters

:NONE

CommitHierarchyChildAccessContractIDsclass

Hide ParametersShow Parameters

contract_idsarray

Array[String]

typeunion

:CONTRACT_IDS

Hide ParametersShow Parameters

:CONTRACT_IDS

ledgerarray

optional

Array[{ amount, segment_id, timestamp, type} | { amount, invoice_id, segment_id, 3 more} | { amount, segment_id, timestamp, type} | 4 more]

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

Hide ParametersShow Parameters

CreditSegmentStartLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_SEGMENT_START

Hide ParametersShow Parameters

:CREDIT_SEGMENT_START

CreditAutomatedInvoiceDeductionLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_AUTOMATED_INVOICE_DEDUCTION

Hide ParametersShow Parameters

:CREDIT_AUTOMATED_INVOICE_DEDUCTION

contract_idString

optional

formatuuid

CreditExpirationLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_EXPIRATION

Hide ParametersShow Parameters

:CREDIT_EXPIRATION

CreditCanceledLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_CANCELED

Hide ParametersShow Parameters

:CREDIT_CANCELED

contract_idString

optional

formatuuid

CreditCreditedLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

invoice_idString

formatuuid

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_CREDITED

Hide ParametersShow Parameters

:CREDIT_CREDITED

contract_idString

optional

formatuuid

CreditManualLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

reasonString

timestampTime

formatdate-time

typeunion

:CREDIT_MANUAL

Hide ParametersShow Parameters

:CREDIT_MANUAL

CreditSeatBasedAdjustmentLedgerEntryclass

Hide ParametersShow Parameters

amountFloat

segment_idString

formatuuid

timestampTime

formatdate-time

typeunion

:CREDIT_SEAT_BASED_ADJUSTMENT

Hide ParametersShow Parameters

:CREDIT_SEAT_BASED_ADJUSTMENT

nameString

optional

netsuite_sales_order_idString

optional

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

priorityFloat

optional

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

rate_typeunion

optional

:COMMIT_RATE | :LIST_RATE

Hide ParametersShow Parameters

:COMMIT_RATE

:LIST_RATE

salesforce_opportunity_idString

optional

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

specifiersarray

optional

Array[{ presentation_group_values, pricing_group_values, product_id, product_tags}]

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown.

Hide ParametersShow Parameters

presentation_group_valueshash

optional

Hash[Symbol, String]

pricing_group_valueshash

optional

Hash[Symbol, String]

product_idString

optional

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

formatuuid

product_tagsarray

optional

Array[String]

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

uniqueness_keyString

optional

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

minLength1

maxLength128

Credit Type Data

CreditTypeDataclass

ShowShow

idString

formatuuid

nameString

Discount

Discountclass

ShowShow

idString

formatuuid

productobject

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

schedulecredit_typeCreditTypeDatado_not_invoiceboolschedule_itemsarraySchedulePointInTime

custom_fieldshash

optional

Hash[Symbol, String]

nameString

optional

minLength1

netsuite_sales_order_idString

optional

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

Event Type Filter

EventTypeFilterclass

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

ShowShow

in_valuesarray

optional

Array[String]

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

not_in_valuesarray

optional

Array[String]

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

ID

IDclass

ShowShow

idString

formatuuid

Override

Overrideclass

ShowShow

idString

formatuuid

starting_atTime

formatdate-time

applicable_product_tagsarray

optional

Array[String]

credit_typeidStringnameStringCreditTypeData

optional

ending_beforeTime

optional

formatdate-time

entitledbool

optional

is_commit_specificbool

optional

is_proratedbool

optional

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

multiplierFloat

optional

override_specifiersarray

optional

Array[{ billing_frequency, commit_ids, presentation_group_values, 5 more}]

Hide ParametersShow Parameters

billing_frequencyunion

optional

:MONTHLY | :QUARTERLY | :ANNUAL | :WEEKLY

Hide ParametersShow Parameters

:MONTHLY

:QUARTERLY

:ANNUAL

:WEEKLY

commit_idsarray

optional

Array[String]

presentation_group_valueshash

optional

Hash[Symbol, String]

pricing_group_valueshash

optional

Hash[Symbol, String]

product_idString

optional

formatuuid

product_tagsarray

optional

Array[String]

recurring_commit_idsarray

optional

Array[String]

recurring_credit_idsarray

optional

Array[String]

override_tiersarray

optional

Array[{ multiplier, size}]

Hide ParametersShow Parameters

multiplierFloat

sizeFloat

optional

overwrite_rateobject

optional

{ rate_type, credit_type, custom_rate, 4 more}

Hide ParametersShow Parameters

rate_typeunion

:FLAT | :PERCENTAGE | :SUBSCRIPTION | 2 more

Hide ParametersShow Parameters

:FLAT

:PERCENTAGE

:SUBSCRIPTION

:TIERED

:CUSTOM

credit_typeidStringnameStringCreditTypeData

optional

custom_ratehash

optional

Hash[Symbol, untyped]

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

is_proratedbool

optional

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

priceFloat

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.

quantityFloat

optional

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

tiersarray

optional

Array[priceFloatsizeFloatTier]

Only set for TIERED rate_type.

Hide ParametersShow Parameters

priceFloat

sizeFloat

optional

priceFloat

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.

priorityFloat

optional

productobject

optional

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

quantityFloat

optional

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

rate_typeunion

optional

:FLAT | :PERCENTAGE | :SUBSCRIPTION | 2 more

Hide ParametersShow Parameters

:FLAT

:PERCENTAGE

:SUBSCRIPTION

:TIERED

:CUSTOM

targetunion

optional

:COMMIT_RATE | :LIST_RATE

Hide ParametersShow Parameters

:COMMIT_RATE

:LIST_RATE

tiersarray

optional

Array[priceFloatsizeFloatTier]

Only set for TIERED rate_type.

Hide ParametersShow Parameters

priceFloat

sizeFloat

optional

typeunion

optional

:OVERWRITE | :MULTIPLIER | :TIERED

Hide ParametersShow Parameters

:OVERWRITE

:MULTIPLIER

:TIERED

valuehash

optional

Hash[Symbol, untyped]

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

Property Filter

PropertyFilterclass

ShowShow

nameString

The name of the event property.

existsbool

optional

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

in_valuesarray

optional

Array[String]

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

not_in_valuesarray

optional

Array[String]

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

Pro Service

ProServiceclass

ShowShow

idString

formatuuid

max_amountFloat

Maximum amount for the term.

product_idString

formatuuid

quantityFloat

Quantity for the charge. Will be multiplied by unit_price to determine the amount.

unit_priceFloat

Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified.

custom_fieldshash

optional

Hash[Symbol, String]

descriptionString

optional

netsuite_sales_order_idString

optional

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

Rate

Rateclass

ShowShow

rate_typeunion

:FLAT | :PERCENTAGE | :SUBSCRIPTION | 2 more

Hide ParametersShow Parameters

:FLAT

:PERCENTAGE

:SUBSCRIPTION

:CUSTOM

:TIERED

credit_typeidStringnameStringCreditTypeData

optional

custom_ratehash

optional

Hash[Symbol, untyped]

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

is_proratedbool

optional

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

priceFloat

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.

pricing_group_valueshash

optional

Hash[Symbol, String]

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

quantityFloat

optional

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

tiersarray

optional

Array[priceFloatsizeFloatTier]

Only set for TIERED rate_type.

Hide ParametersShow Parameters

priceFloat

sizeFloat

optional

use_list_pricesbool

optional

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

Scheduled Charge

ScheduledChargeclass

ShowShow

idString

formatuuid

productobject

{ id, name}

Hide ParametersShow Parameters

idString

formatuuid

nameString

schedulecredit_typeCreditTypeDatado_not_invoiceboolschedule_itemsarraySchedulePointInTime

archived_atTime

optional

formatdate-time

custom_fieldshash

optional

Hash[Symbol, String]

nameString

optional

displayed on invoices

minLength1

netsuite_sales_order_idString

optional

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

Schedule Duration

ScheduleDurationclass

ShowShow

schedule_itemsarray

Array[{ id, amount, ending_before, starting_at}]

Hide ParametersShow Parameters

idString

formatuuid

amountFloat

ending_beforeTime

formatdate-time

starting_atTime

formatdate-time

credit_typeidStringnameStringCreditTypeData

optional

Schedule Point In Time

SchedulePointInTimeclass

ShowShow

credit_typeidStringnameStringCreditTypeData

optional

do_not_invoicebool

optional

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

schedule_itemsarray

optional

Array[{ id, amount, quantity, 3 more}]

Hide ParametersShow Parameters

idString

formatuuid

amountFloat

quantityFloat

timestampTime

formatdate-time

unit_priceFloat

invoice_idString

optional

formatuuid

Tier

Tierclass

ShowShow

priceFloat

sizeFloat

optional