List customer contracts (v1)

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

List all contracts for a customer

customer_id

string<uuid>

required

include_ledgers

boolean

Include commit ledgers in the response. Setting this flag may cause the query to be slower.

include_balance

boolean

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

include_archived

boolean

Include archived contracts in the response

starting_at

string<date-time>

Optional RFC 3339 timestamp. If provided, the response will include only contracts where effective_at is on or after the provided date. This cannot be provided if the covering_date filter is provided.

covering_date

string<date-time>

Optional RFC 3339 timestamp. If provided, the response will include only contracts effective on the provided date. This cannot be provided if the starting_at filter is provided.

Response

Success

data

object[]

required

Show child attributes

data.id

string<uuid>

required

data.customer_id

string<uuid>

required

data.initial

object

required

Show child attributes

data.initial.starting_at

string<date-time>

required

data.initial.commits

object[]

required

Show child attributes

data.initial.commits.id

string<uuid>

required

data.initial.commits.type

enum<string>

required

Available options:

PREPAID,

POSTPAID

data.initial.commits.product

object

required

Show child attributes

data.initial.commits.product.id

string<uuid>

required

data.initial.commits.product.name

string

required

data.initial.commits.created_at

string<date-time>

required

Timestamp of when the commit was created.

Recurring commits: latter of commit service period date and parent commit start date
Rollover commits: when the new contract started

data.initial.commits.contract

object

Show child attributes

data.initial.commits.contract.id

string<uuid>

required

data.initial.commits.rate_type

enum<string>

Available options:

COMMIT_RATE,

LIST_RATE

data.initial.commits.name

string

data.initial.commits.priority

number

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

data.initial.commits.access_schedule

object

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

Show child attributes

data.initial.commits.access_schedule.schedule_items

object[]

required

Show child attributes

data.initial.commits.access_schedule.schedule_items.id

string<uuid>

required

data.initial.commits.access_schedule.schedule_items.amount

number

required

data.initial.commits.access_schedule.schedule_items.starting_at

string<date-time>

required

data.initial.commits.access_schedule.schedule_items.ending_before

string<date-time>

required

data.initial.commits.access_schedule.credit_type

object

Show child attributes

data.initial.commits.access_schedule.credit_type.name

string

required

data.initial.commits.access_schedule.credit_type.id

string<uuid>

required

data.initial.commits.invoice_schedule

object

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

Show child attributes

data.initial.commits.invoice_schedule.credit_type

object

Show child attributes

data.initial.commits.invoice_schedule.credit_type.name

string

required

data.initial.commits.invoice_schedule.credit_type.id

string<uuid>

required

data.initial.commits.invoice_schedule.schedule_items

object[]

Show child attributes

data.initial.commits.invoice_schedule.schedule_items.id

string<uuid>

required

data.initial.commits.invoice_schedule.schedule_items.amount

number

required

data.initial.commits.invoice_schedule.schedule_items.unit_price

number

required

data.initial.commits.invoice_schedule.schedule_items.quantity

number

required

data.initial.commits.invoice_schedule.schedule_items.timestamp

string<date-time>

required

data.initial.commits.invoice_schedule.schedule_items.invoice_id

string<uuid> | null

data.initial.commits.invoice_schedule.do_not_invoice

boolean

default:false

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

data.initial.commits.invoice_contract

object

The contract that this commit will be billed on.

Show child attributes

data.initial.commits.invoice_contract.id

string<uuid>

required

data.initial.commits.rolled_over_from

object

Show child attributes

data.initial.commits.rolled_over_from.commit_id

string<uuid>

required

data.initial.commits.rolled_over_from.contract_id

string<uuid>

required

data.initial.commits.description

string

data.initial.commits.rollover_fraction

number

data.initial.commits.applicable_product_ids

string<uuid>[]

data.initial.commits.applicable_product_tags

string[]

data.initial.commits.specifiers

object[]

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.

Show child attributes

data.initial.commits.specifiers.product_id

string<uuid>

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

data.initial.commits.specifiers.product_tags

string[]

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

data.initial.commits.specifiers.pricing_group_values

object

Show child attributes

data.initial.commits.specifiers.pricing_group_values.{key}

string

data.initial.commits.specifiers.presentation_group_values

object

Show child attributes

data.initial.commits.specifiers.presentation_group_values.{key}

string

data.initial.commits.applicable_contract_ids

string<uuid>[]

data.initial.commits.amount

number

(DEPRECATED) Use access_schedule + invoice_schedule instead.

data.initial.commits.ledger

object[]

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

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12

Show child attributes

data.initial.commits.ledger.type

enum<string>

required

Available options:

PREPAID_COMMIT_SEGMENT_START

data.initial.commits.ledger.timestamp

string<date-time>

required

data.initial.commits.ledger.amount

number

required

data.initial.commits.ledger.segment_id

string<uuid>

required

data.initial.commits.balance

number

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.

data.initial.commits.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.initial.commits.custom_fields.{key}

string

data.initial.commits.uniqueness_key

string

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.

Required string length: 1 - 128

data.initial.commits.archived_at

string<date-time>

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

data.initial.overrides

object[]

required

Show child attributes

data.initial.overrides.id

string<uuid>

required

data.initial.overrides.starting_at

string<date-time>

required

data.initial.overrides.product

object

Show child attributes

data.initial.overrides.product.id

string<uuid>

required

data.initial.overrides.product.name

string

required

data.initial.overrides.applicable_product_tags

string[]

data.initial.overrides.override_specifiers

object[]

Show child attributes

data.initial.overrides.override_specifiers.product_id

string<uuid>

data.initial.overrides.override_specifiers.product_tags

string[]

data.initial.overrides.override_specifiers.pricing_group_values

object

Show child attributes

data.initial.overrides.override_specifiers.pricing_group_values.{key}

string

data.initial.overrides.override_specifiers.presentation_group_values

object

Show child attributes

data.initial.overrides.override_specifiers.presentation_group_values.{key}

string | null

data.initial.overrides.override_specifiers.commit_ids

string[]

data.initial.overrides.override_specifiers.recurring_commit_ids

string[]

data.initial.overrides.override_specifiers.recurring_credit_ids

string[]

data.initial.overrides.override_specifiers.billing_frequency

enum<string>

Available options:

MONTHLY,

QUARTERLY,

ANNUAL,

WEEKLY,

monthly,

quarterly,

annual,

weekly

data.initial.overrides.ending_before

string<date-time>

data.initial.overrides.entitled

boolean

data.initial.overrides.type

enum<string>

Available options:

OVERWRITE,

MULTIPLIER,

TIERED

data.initial.overrides.priority

number

data.initial.overrides.multiplier

number

data.initial.overrides.overwrite_rate

object

Show child attributes

data.initial.overrides.overwrite_rate.rate_type

enum<string>

required

Available options:

FLAT,

flat,

PERCENTAGE,

percentage,

TIERED,

tiered

data.initial.overrides.overwrite_rate.price

number

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.

data.initial.overrides.overwrite_rate.tiers

object[]

Only set for TIERED rate_type.

Show child attributes

data.initial.overrides.overwrite_rate.tiers.price

number

required

data.initial.overrides.overwrite_rate.tiers.size

number

data.initial.overrides.overwrite_rate.credit_type

object

Show child attributes

data.initial.overrides.overwrite_rate.credit_type.name

string

required

data.initial.overrides.overwrite_rate.credit_type.id

string<uuid>

required

data.initial.overrides.override_tiers

object[]

Show child attributes

data.initial.overrides.override_tiers.multiplier

number

required

data.initial.overrides.override_tiers.size

number

data.initial.overrides.is_commit_specific

boolean

data.initial.overrides.target

enum<string>

Available options:

COMMIT_RATE,

LIST_RATE

data.initial.overrides.rate_type

enum<string>

Available options:

FLAT,

flat,

PERCENTAGE,

percentage,

TIERED,

tiered

data.initial.overrides.price

number

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.

data.initial.overrides.tiers

object[]

Only set for TIERED rate_type.

Show child attributes

data.initial.overrides.tiers.price

number

required

data.initial.overrides.tiers.size

number

data.initial.overrides.value

object

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

data.initial.overrides.credit_type

object

Show child attributes

data.initial.overrides.credit_type.name

string

required

data.initial.overrides.credit_type.id

string<uuid>

required

data.initial.scheduled_charges

object[]

required

Show child attributes

data.initial.scheduled_charges.id

string<uuid>

required

data.initial.scheduled_charges.product

object

required

Show child attributes

data.initial.scheduled_charges.product.id

string<uuid>

required

data.initial.scheduled_charges.product.name

string

required

data.initial.scheduled_charges.schedule

object

required

Show child attributes

data.initial.scheduled_charges.schedule.credit_type

object

Show child attributes

data.initial.scheduled_charges.schedule.credit_type.name

string

required

data.initial.scheduled_charges.schedule.credit_type.id

string<uuid>

required

data.initial.scheduled_charges.schedule.schedule_items

object[]

Show child attributes

data.initial.scheduled_charges.schedule.schedule_items.id

string<uuid>

required

data.initial.scheduled_charges.schedule.schedule_items.amount

number

required

data.initial.scheduled_charges.schedule.schedule_items.unit_price

number

required

data.initial.scheduled_charges.schedule.schedule_items.quantity

number

required

data.initial.scheduled_charges.schedule.schedule_items.timestamp

string<date-time>

required

data.initial.scheduled_charges.schedule.schedule_items.invoice_id

string<uuid> | null

data.initial.scheduled_charges.schedule.do_not_invoice

boolean

default:false

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

data.initial.scheduled_charges.name

string

displayed on invoices

Minimum string length: 1

data.initial.scheduled_charges.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.initial.scheduled_charges.custom_fields.{key}

string

data.initial.scheduled_charges.archived_at

string<date-time>

data.initial.transitions

object[]

required

Show child attributes

data.initial.transitions.type

enum<string>

required

Available options:

SUPERSEDE,

RENEWAL

data.initial.transitions.from_contract_id

string<uuid>

required

data.initial.transitions.to_contract_id

string<uuid>

required

data.initial.created_at

string<date-time>

required

data.initial.created_by

string

required

data.initial.usage_statement_schedule

object

required

Show child attributes

data.initial.usage_statement_schedule.frequency

enum<string>

required

Available options:

MONTHLY,

monthly,

QUARTERLY,

quarterly,

ANNUAL,

annual,

WEEKLY,

weekly

data.initial.usage_statement_schedule.billing_anchor_date

string<date-time>

required

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

data.initial.name

string

data.initial.rate_card_id

string<uuid>

data.initial.credits

object[]

Show child attributes

data.initial.credits.id

string<uuid>

required

data.initial.credits.type

enum<string>

required

Available options:

CREDIT

data.initial.credits.product

object

required

Show child attributes

data.initial.credits.product.id

string<uuid>

required

data.initial.credits.product.name

string

required

data.initial.credits.contract

object

Show child attributes

data.initial.credits.contract.id

string<uuid>

required

data.initial.credits.name

string

data.initial.credits.priority

number

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

data.initial.credits.access_schedule

object

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

Show child attributes

data.initial.credits.access_schedule.schedule_items

object[]

required

Show child attributes

data.initial.credits.access_schedule.schedule_items.id

string<uuid>

required

data.initial.credits.access_schedule.schedule_items.amount

number

required

data.initial.credits.access_schedule.schedule_items.starting_at

string<date-time>

required

data.initial.credits.access_schedule.schedule_items.ending_before

string<date-time>

required

data.initial.credits.access_schedule.credit_type

object

Show child attributes

data.initial.credits.access_schedule.credit_type.name

string

required

data.initial.credits.access_schedule.credit_type.id

string<uuid>

required

data.initial.credits.description

string

data.initial.credits.applicable_product_ids

string<uuid>[]

data.initial.credits.applicable_product_tags

string[]

data.initial.credits.specifiers

object[]

Show child attributes

data.initial.credits.specifiers.product_id

string<uuid>

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

data.initial.credits.specifiers.product_tags

string[]

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

data.initial.credits.specifiers.pricing_group_values

object

Show child attributes

data.initial.credits.specifiers.pricing_group_values.{key}

string

data.initial.credits.specifiers.presentation_group_values

object

Show child attributes

data.initial.credits.specifiers.presentation_group_values.{key}

string

data.initial.credits.applicable_contract_ids

string<uuid>[]

data.initial.credits.ledger

object[]

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

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

data.initial.credits.ledger.type

enum<string>

required

Available options:

CREDIT_SEGMENT_START

data.initial.credits.ledger.timestamp

string<date-time>

required

data.initial.credits.ledger.amount

number

required

data.initial.credits.ledger.segment_id

string<uuid>

required

data.initial.credits.balance

number

data.initial.credits.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.initial.credits.custom_fields.{key}

string

data.initial.credits.rate_type

enum<string>

Available options:

COMMIT_RATE,

LIST_RATE

data.initial.credits.uniqueness_key

string

Required string length: 1 - 128

data.initial.recurring_commits

object[]

Show child attributes

data.initial.recurring_commits.id

string<uuid>

required

data.initial.recurring_commits.product

object

required

Show child attributes

data.initial.recurring_commits.product.id

string<uuid>

required

data.initial.recurring_commits.product.name

string

required

data.initial.recurring_commits.access_amount

object

required

The amount of commit to grant.

Show child attributes

data.initial.recurring_commits.access_amount.unit_price

number

required

data.initial.recurring_commits.access_amount.credit_type_id

string<uuid>

required

data.initial.recurring_commits.access_amount.quantity

number

data.initial.recurring_commits.priority

number

required

Will be passed down to the individual commits

data.initial.recurring_commits.rate_type

enum<string>

required

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

Available options:

COMMIT_RATE,

commit_rate,

LIST_RATE,

list_rate

data.initial.recurring_commits.starting_at

string<date-time>

required

Determines the start time for the first commit

data.initial.recurring_commits.commit_duration

object

required

The amount of time the created commits will be valid for

Show child attributes

data.initial.recurring_commits.commit_duration.value

number

required

data.initial.recurring_commits.commit_duration.unit

enum<string>

Available options:

periods,

PERIODS

data.initial.recurring_commits.contract

object

Show child attributes

data.initial.recurring_commits.contract.id

string<uuid>

required

data.initial.recurring_commits.name

string

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

data.initial.recurring_commits.description

string

Will be passed down to the individual commits

data.initial.recurring_commits.rollover_fraction

number

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.

data.initial.recurring_commits.applicable_product_ids

string<uuid>[]

Will be passed down to the individual commits

data.initial.recurring_commits.applicable_product_tags

string[]

Will be passed down to the individual commits

data.initial.recurring_commits.specifiers

object[]

Show child attributes

data.initial.recurring_commits.specifiers.product_id

string<uuid>

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

data.initial.recurring_commits.specifiers.product_tags

string[]

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

data.initial.recurring_commits.specifiers.pricing_group_values

object

Show child attributes

data.initial.recurring_commits.specifiers.pricing_group_values.{key}

string

data.initial.recurring_commits.specifiers.presentation_group_values

object

Show child attributes

data.initial.recurring_commits.specifiers.presentation_group_values.{key}

string

data.initial.recurring_commits.ending_before

string<date-time>

Determines when the contract will stop creating recurring commits. Optional

data.initial.recurring_commits.recurrence_frequency

enum<string>

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.

Available options:

MONTHLY,

monthly,

QUARTERLY,

quarterly,

ANNUAL,

annual,

WEEKLY,

weekly

data.initial.recurring_commits.proration

enum<string>

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

Available options:

NONE,

none,

FIRST,

first,

LAST,

last,

FIRST_AND_LAST,

first_and_last

data.initial.recurring_commits.subscription_config

object

Attach a subscription to the recurring commit/credit.

Show child attributes

data.initial.recurring_commits.subscription_config.allocation

enum<string>

required

Available options:

INDIVIDUAL,

POOLED

data.initial.recurring_commits.subscription_config.apply_seat_increase_config

object

required

Show child attributes

data.initial.recurring_commits.subscription_config.apply_seat_increase_config.is_prorated

boolean

required

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

data.initial.recurring_commits.subscription_config.subscription_id

string<uuid>

required

data.initial.recurring_commits.invoice_amount

object

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

Show child attributes

data.initial.recurring_commits.invoice_amount.unit_price

number

required

data.initial.recurring_commits.invoice_amount.quantity

number

required

data.initial.recurring_commits.invoice_amount.credit_type_id

string<uuid>

required

data.initial.recurring_credits

object[]

Show child attributes

data.initial.recurring_credits.id

string<uuid>

required

data.initial.recurring_credits.product

object

required

Show child attributes

data.initial.recurring_credits.product.id

string<uuid>

required

data.initial.recurring_credits.product.name

string

required

data.initial.recurring_credits.access_amount

object

required

The amount of commit to grant.

Show child attributes

data.initial.recurring_credits.access_amount.unit_price

number

required

data.initial.recurring_credits.access_amount.credit_type_id

string<uuid>

required

data.initial.recurring_credits.access_amount.quantity

number

data.initial.recurring_credits.priority

number

required

Will be passed down to the individual commits

data.initial.recurring_credits.rate_type

enum<string>

required

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

Available options:

COMMIT_RATE,

commit_rate,

LIST_RATE,

list_rate

data.initial.recurring_credits.starting_at

string<date-time>

required

Determines the start time for the first commit

data.initial.recurring_credits.commit_duration

object

required

The amount of time the created commits will be valid for

Show child attributes

data.initial.recurring_credits.commit_duration.value

number

required

data.initial.recurring_credits.commit_duration.unit

enum<string>

Available options:

periods,

PERIODS

data.initial.recurring_credits.contract

object

Show child attributes

data.initial.recurring_credits.contract.id

string<uuid>

required

data.initial.recurring_credits.name

string

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

data.initial.recurring_credits.description

string

Will be passed down to the individual commits

data.initial.recurring_credits.rollover_fraction

number

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.

data.initial.recurring_credits.applicable_product_ids

string<uuid>[]

Will be passed down to the individual commits

data.initial.recurring_credits.applicable_product_tags

string[]

Will be passed down to the individual commits

data.initial.recurring_credits.specifiers

object[]

Show child attributes

data.initial.recurring_credits.specifiers.product_id

string<uuid>

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

data.initial.recurring_credits.specifiers.product_tags

string[]

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

data.initial.recurring_credits.specifiers.pricing_group_values

object

Show child attributes

data.initial.recurring_credits.specifiers.pricing_group_values.{key}

string

data.initial.recurring_credits.specifiers.presentation_group_values

object

Show child attributes

data.initial.recurring_credits.specifiers.presentation_group_values.{key}

string

data.initial.recurring_credits.ending_before

string<date-time>

Determines when the contract will stop creating recurring commits. Optional

data.initial.recurring_credits.recurrence_frequency

enum<string>

Available options:

MONTHLY,

monthly,

QUARTERLY,

quarterly,

ANNUAL,

annual,

WEEKLY,

weekly

data.initial.recurring_credits.proration

enum<string>

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

Available options:

NONE,

none,

FIRST,

first,

LAST,

last,

FIRST_AND_LAST,

first_and_last

data.initial.recurring_credits.subscription_config

object

Attach a subscription to the recurring commit/credit.

Show child attributes

data.initial.recurring_credits.subscription_config.allocation

enum<string>

required

Available options:

INDIVIDUAL,

POOLED

data.initial.recurring_credits.subscription_config.apply_seat_increase_config

object

required

Show child attributes

data.initial.recurring_credits.subscription_config.apply_seat_increase_config.is_prorated

boolean

required

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

data.initial.recurring_credits.subscription_config.subscription_id

string<uuid>

required

data.initial.scheduled_charges_on_usage_invoices

enum<string>

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.

Available options:

ALL

data.initial.net_payment_terms_days

number

data.initial.ending_before

string<date-time>

data.initial.usage_filter

object

Show child attributes

data.initial.usage_filter.initial

object

required

Show child attributes

data.initial.usage_filter.initial.group_key

string

required

data.initial.usage_filter.initial.group_values

string[]

required

data.initial.usage_filter.initial.starting_at

string<date-time>

data.initial.usage_filter.current

object

required

Show child attributes

data.initial.usage_filter.current.group_key

string

required

data.initial.usage_filter.current.group_values

string[]

required

data.initial.usage_filter.current.starting_at

string<date-time>

data.initial.usage_filter.updates

object[]

required

Show child attributes

data.initial.usage_filter.updates.group_key

string

required

data.initial.usage_filter.updates.group_values

string[]

required

data.initial.usage_filter.updates.starting_at

string<date-time>

required

data.initial.spend_threshold_configuration

object

Show child attributes

data.initial.spend_threshold_configuration.is_enabled

boolean

required

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.

data.initial.spend_threshold_configuration.threshold_amount

number

required

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

data.initial.spend_threshold_configuration.commit

object

required

Show child attributes

data.initial.spend_threshold_configuration.commit.product_id

string

required

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

data.initial.spend_threshold_configuration.commit.name

string

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

data.initial.spend_threshold_configuration.commit.description

string

data.initial.spend_threshold_configuration.payment_gate_config

object

required

Show child attributes

data.initial.spend_threshold_configuration.payment_gate_config.payment_gate_type

enum<string>

required

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.

Available options:

NONE,

STRIPE,

EXTERNAL

data.initial.spend_threshold_configuration.payment_gate_config.tax_type

enum<string>

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.

Available options:

NONE,

STRIPE,

ANROK,

AVALARA,

PRECALCULATED

data.initial.spend_threshold_configuration.payment_gate_config.stripe_config

object

Only applicable if using STRIPE as your payment gate type.

Show child attributes

data.initial.spend_threshold_configuration.payment_gate_config.stripe_config.payment_type

enum<string>

required

If left blank, will default to INVOICE

Available options:

INVOICE,

PAYMENT_INTENT

data.initial.spend_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata

object

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

Show child attributes

data.initial.spend_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata.{key}

string

data.initial.spend_threshold_configuration.payment_gate_config.precalculated_tax_config

object

Only applicable if using PRECALCULATED as your tax type.

Show child attributes

data.initial.spend_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_amount

number

required

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

data.initial.spend_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_name

string

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

data.initial.prepaid_balance_threshold_configuration

object

Show child attributes

data.initial.prepaid_balance_threshold_configuration.is_enabled

boolean

required

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.

data.initial.prepaid_balance_threshold_configuration.threshold_amount

number

required

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

data.initial.prepaid_balance_threshold_configuration.recharge_to_amount

number

required

Specify the amount the balance should be recharged to.

data.initial.prepaid_balance_threshold_configuration.commit

object

required

Show child attributes

data.initial.prepaid_balance_threshold_configuration.commit.product_id

string

required

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

data.initial.prepaid_balance_threshold_configuration.commit.name

string

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

data.initial.prepaid_balance_threshold_configuration.commit.description

string

data.initial.prepaid_balance_threshold_configuration.commit.applicable_product_ids

string<uuid>[]

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.

data.initial.prepaid_balance_threshold_configuration.commit.applicable_product_tags

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.

data.initial.prepaid_balance_threshold_configuration.payment_gate_config

object

required

Show child attributes

data.initial.prepaid_balance_threshold_configuration.payment_gate_config.payment_gate_type

enum<string>

required

Available options:

NONE,

STRIPE,

EXTERNAL

data.initial.prepaid_balance_threshold_configuration.payment_gate_config.tax_type

enum<string>

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.

Available options:

NONE,

STRIPE,

ANROK,

AVALARA,

PRECALCULATED

data.initial.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config

object

Only applicable if using STRIPE as your payment gate type.

Show child attributes

data.initial.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config.payment_type

enum<string>

required

If left blank, will default to INVOICE

Available options:

INVOICE,

PAYMENT_INTENT

data.initial.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata

object

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

Show child attributes

data.initial.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata.{key}

string

data.initial.prepaid_balance_threshold_configuration.payment_gate_config.precalculated_tax_config

object

Only applicable if using PRECALCULATED as your tax type.

Show child attributes

data.initial.prepaid_balance_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_amount

number

required

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

data.initial.prepaid_balance_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_name

string

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

data.initial.prepaid_balance_threshold_configuration.custom_credit_type_id

string<uuid>

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.

data.initial.hierarchy_configuration

object

data.current

object

required

Show child attributes

data.current.starting_at

string<date-time>

required

data.current.commits

object[]

required

Show child attributes

data.current.commits.id

string<uuid>

required

data.current.commits.type

enum<string>

required

Available options:

PREPAID,

POSTPAID

data.current.commits.product

object

required

Show child attributes

data.current.commits.product.id

string<uuid>

required

data.current.commits.product.name

string

required

data.current.commits.created_at

string<date-time>

required

Timestamp of when the commit was created.

Recurring commits: latter of commit service period date and parent commit start date
Rollover commits: when the new contract started

data.current.commits.contract

object

Show child attributes

data.current.commits.contract.id

string<uuid>

required

data.current.commits.rate_type

enum<string>

Available options:

COMMIT_RATE,

LIST_RATE

data.current.commits.name

string

data.current.commits.priority

number

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

data.current.commits.access_schedule

object

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

Show child attributes

data.current.commits.access_schedule.schedule_items

object[]

required

Show child attributes

data.current.commits.access_schedule.schedule_items.id

string<uuid>

required

data.current.commits.access_schedule.schedule_items.amount

number

required

data.current.commits.access_schedule.schedule_items.starting_at

string<date-time>

required

data.current.commits.access_schedule.schedule_items.ending_before

string<date-time>

required

data.current.commits.access_schedule.credit_type

object

Show child attributes

data.current.commits.access_schedule.credit_type.name

string

required

data.current.commits.access_schedule.credit_type.id

string<uuid>

required

data.current.commits.invoice_schedule

object

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

Show child attributes

data.current.commits.invoice_schedule.credit_type

object

Show child attributes

data.current.commits.invoice_schedule.credit_type.name

string

required

data.current.commits.invoice_schedule.credit_type.id

string<uuid>

required

data.current.commits.invoice_schedule.schedule_items

object[]

Show child attributes

data.current.commits.invoice_schedule.schedule_items.id

string<uuid>

required

data.current.commits.invoice_schedule.schedule_items.amount

number

required

data.current.commits.invoice_schedule.schedule_items.unit_price

number

required

data.current.commits.invoice_schedule.schedule_items.quantity

number

required

data.current.commits.invoice_schedule.schedule_items.timestamp

string<date-time>

required

data.current.commits.invoice_schedule.schedule_items.invoice_id

string<uuid> | null

data.current.commits.invoice_schedule.do_not_invoice

boolean

default:false

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

data.current.commits.invoice_contract

object

The contract that this commit will be billed on.

Show child attributes

data.current.commits.invoice_contract.id

string<uuid>

required

data.current.commits.rolled_over_from

object

Show child attributes

data.current.commits.rolled_over_from.commit_id

string<uuid>

required

data.current.commits.rolled_over_from.contract_id

string<uuid>

required

data.current.commits.description

string

data.current.commits.rollover_fraction

number

data.current.commits.applicable_product_ids

string<uuid>[]

data.current.commits.applicable_product_tags

string[]

data.current.commits.specifiers

object[]

Show child attributes

data.current.commits.specifiers.product_id

string<uuid>

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

data.current.commits.specifiers.product_tags

string[]

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

data.current.commits.specifiers.pricing_group_values

object

Show child attributes

data.current.commits.specifiers.pricing_group_values.{key}

string

data.current.commits.specifiers.presentation_group_values

object

Show child attributes

data.current.commits.specifiers.presentation_group_values.{key}

string

data.current.commits.applicable_contract_ids

string<uuid>[]

data.current.commits.amount

number

(DEPRECATED) Use access_schedule + invoice_schedule instead.

data.current.commits.ledger

object[]

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

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12

Show child attributes

data.current.commits.ledger.type

enum<string>

required

Available options:

PREPAID_COMMIT_SEGMENT_START

data.current.commits.ledger.timestamp

string<date-time>

required

data.current.commits.ledger.amount

number

required

data.current.commits.ledger.segment_id

string<uuid>

required

data.current.commits.balance

number

data.current.commits.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.current.commits.custom_fields.{key}

string

data.current.commits.uniqueness_key

string

Required string length: 1 - 128

data.current.commits.archived_at

string<date-time>

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

data.current.overrides

object[]

required

Show child attributes

data.current.overrides.id

string<uuid>

required

data.current.overrides.starting_at

string<date-time>

required

data.current.overrides.product

object

Show child attributes

data.current.overrides.product.id

string<uuid>

required

data.current.overrides.product.name

string

required

data.current.overrides.applicable_product_tags

string[]

data.current.overrides.override_specifiers

object[]

Show child attributes

data.current.overrides.override_specifiers.product_id

string<uuid>

data.current.overrides.override_specifiers.product_tags

string[]

data.current.overrides.override_specifiers.pricing_group_values

object

Show child attributes

data.current.overrides.override_specifiers.pricing_group_values.{key}

string

data.current.overrides.override_specifiers.presentation_group_values

object

Show child attributes

data.current.overrides.override_specifiers.presentation_group_values.{key}

string | null

data.current.overrides.override_specifiers.commit_ids

string[]

data.current.overrides.override_specifiers.recurring_commit_ids

string[]

data.current.overrides.override_specifiers.recurring_credit_ids

string[]

data.current.overrides.override_specifiers.billing_frequency

enum<string>

Available options:

MONTHLY,

QUARTERLY,

ANNUAL,

WEEKLY,

monthly,

quarterly,

annual,

weekly

data.current.overrides.ending_before

string<date-time>

data.current.overrides.entitled

boolean

data.current.overrides.type

enum<string>

Available options:

OVERWRITE,

MULTIPLIER,

TIERED

data.current.overrides.priority

number

data.current.overrides.multiplier

number

data.current.overrides.overwrite_rate

object

Show child attributes

data.current.overrides.overwrite_rate.rate_type

enum<string>

required

Available options:

FLAT,

flat,

PERCENTAGE,

percentage,

TIERED,

tiered

data.current.overrides.overwrite_rate.price

number

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.

data.current.overrides.overwrite_rate.tiers

object[]

Only set for TIERED rate_type.

Show child attributes

data.current.overrides.overwrite_rate.tiers.price

number

required

data.current.overrides.overwrite_rate.tiers.size

number

data.current.overrides.overwrite_rate.credit_type

object

Show child attributes

data.current.overrides.overwrite_rate.credit_type.name

string

required

data.current.overrides.overwrite_rate.credit_type.id

string<uuid>

required

data.current.overrides.override_tiers

object[]

Show child attributes

data.current.overrides.override_tiers.multiplier

number

required

data.current.overrides.override_tiers.size

number

data.current.overrides.is_commit_specific

boolean

data.current.overrides.target

enum<string>

Available options:

COMMIT_RATE,

LIST_RATE

data.current.overrides.rate_type

enum<string>

Available options:

FLAT,

flat,

PERCENTAGE,

percentage,

TIERED,

tiered

data.current.overrides.price

number

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.

data.current.overrides.tiers

object[]

Only set for TIERED rate_type.

Show child attributes

data.current.overrides.tiers.price

number

required

data.current.overrides.tiers.size

number

data.current.overrides.value

object

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

data.current.overrides.credit_type

object

Show child attributes

data.current.overrides.credit_type.name

string

required

data.current.overrides.credit_type.id

string<uuid>

required

data.current.scheduled_charges

object[]

required

Show child attributes

data.current.scheduled_charges.id

string<uuid>

required

data.current.scheduled_charges.product

object

required

Show child attributes

data.current.scheduled_charges.product.id

string<uuid>

required

data.current.scheduled_charges.product.name

string

required

data.current.scheduled_charges.schedule

object

required

Show child attributes

data.current.scheduled_charges.schedule.credit_type

object

Show child attributes

data.current.scheduled_charges.schedule.credit_type.name

string

required

data.current.scheduled_charges.schedule.credit_type.id

string<uuid>

required

data.current.scheduled_charges.schedule.schedule_items

object[]

Show child attributes

data.current.scheduled_charges.schedule.schedule_items.id

string<uuid>

required

data.current.scheduled_charges.schedule.schedule_items.amount

number

required

data.current.scheduled_charges.schedule.schedule_items.unit_price

number

required

data.current.scheduled_charges.schedule.schedule_items.quantity

number

required

data.current.scheduled_charges.schedule.schedule_items.timestamp

string<date-time>

required

data.current.scheduled_charges.schedule.schedule_items.invoice_id

string<uuid> | null

data.current.scheduled_charges.schedule.do_not_invoice

boolean

default:false

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

data.current.scheduled_charges.name

string

displayed on invoices

Minimum string length: 1

data.current.scheduled_charges.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.current.scheduled_charges.custom_fields.{key}

string

data.current.scheduled_charges.archived_at

string<date-time>

data.current.transitions

object[]

required

Show child attributes

data.current.transitions.type

enum<string>

required

Available options:

SUPERSEDE,

RENEWAL

data.current.transitions.from_contract_id

string<uuid>

required

data.current.transitions.to_contract_id

string<uuid>

required

data.current.created_at

string<date-time>

required

data.current.created_by

string

required

data.current.usage_statement_schedule

object

required

Show child attributes

data.current.usage_statement_schedule.frequency

enum<string>

required

Available options:

MONTHLY,

monthly,

QUARTERLY,

quarterly,

ANNUAL,

annual,

WEEKLY,

weekly

data.current.usage_statement_schedule.billing_anchor_date

string<date-time>

required

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

data.current.name

string

data.current.rate_card_id

string<uuid>

data.current.credits

object[]

Show child attributes

data.current.credits.id

string<uuid>

required

data.current.credits.type

enum<string>

required

Available options:

CREDIT

data.current.credits.product

object

required

Show child attributes

data.current.credits.product.id

string<uuid>

required

data.current.credits.product.name

string

required

data.current.credits.contract

object

Show child attributes

data.current.credits.contract.id

string<uuid>

required

data.current.credits.name

string

data.current.credits.priority

number

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

data.current.credits.access_schedule

object

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

Show child attributes

data.current.credits.access_schedule.schedule_items

object[]

required

Show child attributes

data.current.credits.access_schedule.schedule_items.id

string<uuid>

required

data.current.credits.access_schedule.schedule_items.amount

number

required

data.current.credits.access_schedule.schedule_items.starting_at

string<date-time>

required

data.current.credits.access_schedule.schedule_items.ending_before

string<date-time>

required

data.current.credits.access_schedule.credit_type

object

Show child attributes

data.current.credits.access_schedule.credit_type.name

string

required

data.current.credits.access_schedule.credit_type.id

string<uuid>

required

data.current.credits.description

string

data.current.credits.applicable_product_ids

string<uuid>[]

data.current.credits.applicable_product_tags

string[]

data.current.credits.specifiers

object[]

Show child attributes

data.current.credits.specifiers.product_id

string<uuid>

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

data.current.credits.specifiers.product_tags

string[]

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

data.current.credits.specifiers.pricing_group_values

object

Show child attributes

data.current.credits.specifiers.pricing_group_values.{key}

string

data.current.credits.specifiers.presentation_group_values

object

Show child attributes

data.current.credits.specifiers.presentation_group_values.{key}

string

data.current.credits.applicable_contract_ids

string<uuid>[]

data.current.credits.ledger

object[]

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

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

data.current.credits.ledger.type

enum<string>

required

Available options:

CREDIT_SEGMENT_START

data.current.credits.ledger.timestamp

string<date-time>

required

data.current.credits.ledger.amount

number

required

data.current.credits.ledger.segment_id

string<uuid>

required

data.current.credits.balance

number

data.current.credits.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.current.credits.custom_fields.{key}

string

data.current.credits.rate_type

enum<string>

Available options:

COMMIT_RATE,

LIST_RATE

data.current.credits.uniqueness_key

string

Required string length: 1 - 128

data.current.recurring_commits

object[]

Show child attributes

data.current.recurring_commits.id

string<uuid>

required

data.current.recurring_commits.product

object

required

Show child attributes

data.current.recurring_commits.product.id

string<uuid>

required

data.current.recurring_commits.product.name

string

required

data.current.recurring_commits.access_amount

object

required

The amount of commit to grant.

Show child attributes

data.current.recurring_commits.access_amount.unit_price

number

required

data.current.recurring_commits.access_amount.credit_type_id

string<uuid>

required

data.current.recurring_commits.access_amount.quantity

number

data.current.recurring_commits.priority

number

required

Will be passed down to the individual commits

data.current.recurring_commits.rate_type

enum<string>

required

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

Available options:

COMMIT_RATE,

commit_rate,

LIST_RATE,

list_rate

data.current.recurring_commits.starting_at

string<date-time>

required

Determines the start time for the first commit

data.current.recurring_commits.commit_duration

object

required

The amount of time the created commits will be valid for

Show child attributes

data.current.recurring_commits.commit_duration.value

number

required

data.current.recurring_commits.commit_duration.unit

enum<string>

Available options:

periods,

PERIODS

data.current.recurring_commits.contract

object

Show child attributes

data.current.recurring_commits.contract.id

string<uuid>

required

data.current.recurring_commits.name

string

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

data.current.recurring_commits.description

string

Will be passed down to the individual commits

data.current.recurring_commits.rollover_fraction

number

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.

data.current.recurring_commits.applicable_product_ids

string<uuid>[]

Will be passed down to the individual commits

data.current.recurring_commits.applicable_product_tags

string[]

Will be passed down to the individual commits

data.current.recurring_commits.specifiers

object[]

Show child attributes

data.current.recurring_commits.specifiers.product_id

string<uuid>

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

data.current.recurring_commits.specifiers.product_tags

string[]

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

data.current.recurring_commits.specifiers.pricing_group_values

object

Show child attributes

data.current.recurring_commits.specifiers.pricing_group_values.{key}

string

data.current.recurring_commits.specifiers.presentation_group_values

object

Show child attributes

data.current.recurring_commits.specifiers.presentation_group_values.{key}

string

data.current.recurring_commits.ending_before

string<date-time>

Determines when the contract will stop creating recurring commits. Optional

data.current.recurring_commits.recurrence_frequency

enum<string>

Available options:

MONTHLY,

monthly,

QUARTERLY,

quarterly,

ANNUAL,

annual,

WEEKLY,

weekly

data.current.recurring_commits.proration

enum<string>

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

Available options:

NONE,

none,

FIRST,

first,

LAST,

last,

FIRST_AND_LAST,

first_and_last

data.current.recurring_commits.subscription_config

object

Attach a subscription to the recurring commit/credit.

Show child attributes

data.current.recurring_commits.subscription_config.allocation

enum<string>

required

Available options:

INDIVIDUAL,

POOLED

data.current.recurring_commits.subscription_config.apply_seat_increase_config

object

required

Show child attributes

data.current.recurring_commits.subscription_config.apply_seat_increase_config.is_prorated

boolean

required

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

data.current.recurring_commits.subscription_config.subscription_id

string<uuid>

required

data.current.recurring_commits.invoice_amount

object

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

Show child attributes

data.current.recurring_commits.invoice_amount.unit_price

number

required

data.current.recurring_commits.invoice_amount.quantity

number

required

data.current.recurring_commits.invoice_amount.credit_type_id

string<uuid>

required

data.current.recurring_credits

object[]

Show child attributes

data.current.recurring_credits.id

string<uuid>

required

data.current.recurring_credits.product

object

required

Show child attributes

data.current.recurring_credits.product.id

string<uuid>

required

data.current.recurring_credits.product.name

string

required

data.current.recurring_credits.access_amount

object

required

The amount of commit to grant.

Show child attributes

data.current.recurring_credits.access_amount.unit_price

number

required

data.current.recurring_credits.access_amount.credit_type_id

string<uuid>

required

data.current.recurring_credits.access_amount.quantity

number

data.current.recurring_credits.priority

number

required

Will be passed down to the individual commits

data.current.recurring_credits.rate_type

enum<string>

required

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

Available options:

COMMIT_RATE,

commit_rate,

LIST_RATE,

list_rate

data.current.recurring_credits.starting_at

string<date-time>

required

Determines the start time for the first commit

data.current.recurring_credits.commit_duration

object

required

The amount of time the created commits will be valid for

Show child attributes

data.current.recurring_credits.commit_duration.value

number

required

data.current.recurring_credits.commit_duration.unit

enum<string>

Available options:

periods,

PERIODS

data.current.recurring_credits.contract

object

Show child attributes

data.current.recurring_credits.contract.id

string<uuid>

required

data.current.recurring_credits.name

string

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

data.current.recurring_credits.description

string

Will be passed down to the individual commits

data.current.recurring_credits.rollover_fraction

number

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.

data.current.recurring_credits.applicable_product_ids

string<uuid>[]

Will be passed down to the individual commits

data.current.recurring_credits.applicable_product_tags

string[]

Will be passed down to the individual commits

data.current.recurring_credits.specifiers

object[]

Show child attributes

data.current.recurring_credits.specifiers.product_id

string<uuid>

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

data.current.recurring_credits.specifiers.product_tags

string[]

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

data.current.recurring_credits.specifiers.pricing_group_values

object

Show child attributes

data.current.recurring_credits.specifiers.pricing_group_values.{key}

string

data.current.recurring_credits.specifiers.presentation_group_values

object

Show child attributes

data.current.recurring_credits.specifiers.presentation_group_values.{key}

string

data.current.recurring_credits.ending_before

string<date-time>

Determines when the contract will stop creating recurring commits. Optional

data.current.recurring_credits.recurrence_frequency

enum<string>

Available options:

MONTHLY,

monthly,

QUARTERLY,

quarterly,

ANNUAL,

annual,

WEEKLY,

weekly

data.current.recurring_credits.proration

enum<string>

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

Available options:

NONE,

none,

FIRST,

first,

LAST,

last,

FIRST_AND_LAST,

first_and_last

data.current.recurring_credits.subscription_config

object

Attach a subscription to the recurring commit/credit.

Show child attributes

data.current.recurring_credits.subscription_config.allocation

enum<string>

required

Available options:

INDIVIDUAL,

POOLED

data.current.recurring_credits.subscription_config.apply_seat_increase_config

object

required

Show child attributes

data.current.recurring_credits.subscription_config.apply_seat_increase_config.is_prorated

boolean

required

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

data.current.recurring_credits.subscription_config.subscription_id

string<uuid>

required

data.current.scheduled_charges_on_usage_invoices

enum<string>

Available options:

ALL

data.current.net_payment_terms_days

number

data.current.ending_before

string<date-time>

data.current.usage_filter

object

Show child attributes

data.current.usage_filter.initial

object

required

Show child attributes

data.current.usage_filter.initial.group_key

string

required

data.current.usage_filter.initial.group_values

string[]

required

data.current.usage_filter.initial.starting_at

string<date-time>

data.current.usage_filter.current

object

required

Show child attributes

data.current.usage_filter.current.group_key

string

required

data.current.usage_filter.current.group_values

string[]

required

data.current.usage_filter.current.starting_at

string<date-time>

data.current.usage_filter.updates

object[]

required

Show child attributes

data.current.usage_filter.updates.group_key

string

required

data.current.usage_filter.updates.group_values

string[]

required

data.current.usage_filter.updates.starting_at

string<date-time>

required

data.current.spend_threshold_configuration

object

Show child attributes

data.current.spend_threshold_configuration.is_enabled

boolean

required

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.

data.current.spend_threshold_configuration.threshold_amount

number

required

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

data.current.spend_threshold_configuration.commit

object

required

Show child attributes

data.current.spend_threshold_configuration.commit.product_id

string

required

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

data.current.spend_threshold_configuration.commit.name

string

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

data.current.spend_threshold_configuration.commit.description

string

data.current.spend_threshold_configuration.payment_gate_config

object

required

Show child attributes

data.current.spend_threshold_configuration.payment_gate_config.payment_gate_type

enum<string>

required

Available options:

NONE,

STRIPE,

EXTERNAL

data.current.spend_threshold_configuration.payment_gate_config.tax_type

enum<string>

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.

Available options:

NONE,

STRIPE,

ANROK,

AVALARA,

PRECALCULATED

data.current.spend_threshold_configuration.payment_gate_config.stripe_config

object

Only applicable if using STRIPE as your payment gate type.

Show child attributes

data.current.spend_threshold_configuration.payment_gate_config.stripe_config.payment_type

enum<string>

required

If left blank, will default to INVOICE

Available options:

INVOICE,

PAYMENT_INTENT

data.current.spend_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata

object

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

Show child attributes

data.current.spend_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata.{key}

string

data.current.spend_threshold_configuration.payment_gate_config.precalculated_tax_config

object

Only applicable if using PRECALCULATED as your tax type.

Show child attributes

data.current.spend_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_amount

number

required

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

data.current.spend_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_name

string

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

data.current.prepaid_balance_threshold_configuration

object

Show child attributes

data.current.prepaid_balance_threshold_configuration.is_enabled

boolean

required

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.

data.current.prepaid_balance_threshold_configuration.threshold_amount

number

required

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

data.current.prepaid_balance_threshold_configuration.recharge_to_amount

number

required

Specify the amount the balance should be recharged to.

data.current.prepaid_balance_threshold_configuration.commit

object

required

Show child attributes

data.current.prepaid_balance_threshold_configuration.commit.product_id

string

required

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

data.current.prepaid_balance_threshold_configuration.commit.name

string

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

data.current.prepaid_balance_threshold_configuration.commit.description

string

data.current.prepaid_balance_threshold_configuration.commit.applicable_product_ids

string<uuid>[]

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.

data.current.prepaid_balance_threshold_configuration.commit.applicable_product_tags

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.

data.current.prepaid_balance_threshold_configuration.payment_gate_config

object

required

Show child attributes

data.current.prepaid_balance_threshold_configuration.payment_gate_config.payment_gate_type

enum<string>

required

Available options:

NONE,

STRIPE,

EXTERNAL

data.current.prepaid_balance_threshold_configuration.payment_gate_config.tax_type

enum<string>

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.

Available options:

NONE,

STRIPE,

ANROK,

AVALARA,

PRECALCULATED

data.current.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config

object

Only applicable if using STRIPE as your payment gate type.

Show child attributes

data.current.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config.payment_type

enum<string>

required

If left blank, will default to INVOICE

Available options:

INVOICE,

PAYMENT_INTENT

data.current.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata

object

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

Show child attributes

data.current.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata.{key}

string

data.current.prepaid_balance_threshold_configuration.payment_gate_config.precalculated_tax_config

object

Only applicable if using PRECALCULATED as your tax type.

Show child attributes

data.current.prepaid_balance_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_amount

number

required

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

data.current.prepaid_balance_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_name

string

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

data.current.prepaid_balance_threshold_configuration.custom_credit_type_id

string<uuid>

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.

data.current.hierarchy_configuration

object

data.amendments

object[]

required

Show child attributes

data.amendments.id

string<uuid>

required

data.amendments.starting_at

string<date-time>

required

data.amendments.commits

object[]

required

Show child attributes

data.amendments.commits.id

string<uuid>

required

data.amendments.commits.type

enum<string>

required

Available options:

PREPAID,

POSTPAID

data.amendments.commits.product

object

required

Show child attributes

data.amendments.commits.product.id

string<uuid>

required

data.amendments.commits.product.name

string

required

data.amendments.commits.created_at

string<date-time>

required

Timestamp of when the commit was created.

Recurring commits: latter of commit service period date and parent commit start date
Rollover commits: when the new contract started

data.amendments.commits.contract

object

Show child attributes

data.amendments.commits.contract.id

string<uuid>

required

data.amendments.commits.rate_type

enum<string>

Available options:

COMMIT_RATE,

LIST_RATE

data.amendments.commits.name

string

data.amendments.commits.priority

number

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

data.amendments.commits.access_schedule

object

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

Show child attributes

data.amendments.commits.access_schedule.schedule_items

object[]

required

Show child attributes

data.amendments.commits.access_schedule.schedule_items.id

string<uuid>

required

data.amendments.commits.access_schedule.schedule_items.amount

number

required

data.amendments.commits.access_schedule.schedule_items.starting_at

string<date-time>

required

data.amendments.commits.access_schedule.schedule_items.ending_before

string<date-time>

required

data.amendments.commits.access_schedule.credit_type

object

Show child attributes

data.amendments.commits.access_schedule.credit_type.name

string

required

data.amendments.commits.access_schedule.credit_type.id

string<uuid>

required

data.amendments.commits.invoice_schedule

object

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

Show child attributes

data.amendments.commits.invoice_schedule.credit_type

object

Show child attributes

data.amendments.commits.invoice_schedule.credit_type.name

string

required

data.amendments.commits.invoice_schedule.credit_type.id

string<uuid>

required

data.amendments.commits.invoice_schedule.schedule_items

object[]

Show child attributes

data.amendments.commits.invoice_schedule.schedule_items.id

string<uuid>

required

data.amendments.commits.invoice_schedule.schedule_items.amount

number

required

data.amendments.commits.invoice_schedule.schedule_items.unit_price

number

required

data.amendments.commits.invoice_schedule.schedule_items.quantity

number

required

data.amendments.commits.invoice_schedule.schedule_items.timestamp

string<date-time>

required

data.amendments.commits.invoice_schedule.schedule_items.invoice_id

string<uuid> | null

data.amendments.commits.invoice_schedule.do_not_invoice

boolean

default:false

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

data.amendments.commits.invoice_contract

object

The contract that this commit will be billed on.

Show child attributes

data.amendments.commits.invoice_contract.id

string<uuid>

required

data.amendments.commits.rolled_over_from

object

Show child attributes

data.amendments.commits.rolled_over_from.commit_id

string<uuid>

required

data.amendments.commits.rolled_over_from.contract_id

string<uuid>

required

data.amendments.commits.description

string

data.amendments.commits.rollover_fraction

number

data.amendments.commits.applicable_product_ids

string<uuid>[]

data.amendments.commits.applicable_product_tags

string[]

data.amendments.commits.specifiers

object[]

Show child attributes

data.amendments.commits.specifiers.product_id

string<uuid>

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

data.amendments.commits.specifiers.product_tags

string[]

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

data.amendments.commits.specifiers.pricing_group_values

object

Show child attributes

data.amendments.commits.specifiers.pricing_group_values.{key}

string

data.amendments.commits.specifiers.presentation_group_values

object

Show child attributes

data.amendments.commits.specifiers.presentation_group_values.{key}

string

data.amendments.commits.applicable_contract_ids

string<uuid>[]

data.amendments.commits.amount

number

(DEPRECATED) Use access_schedule + invoice_schedule instead.

data.amendments.commits.ledger

object[]

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

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12

Show child attributes

data.amendments.commits.ledger.type

enum<string>

required

Available options:

PREPAID_COMMIT_SEGMENT_START

data.amendments.commits.ledger.timestamp

string<date-time>

required

data.amendments.commits.ledger.amount

number

required

data.amendments.commits.ledger.segment_id

string<uuid>

required

data.amendments.commits.balance

number

data.amendments.commits.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.amendments.commits.custom_fields.{key}

string

data.amendments.commits.uniqueness_key

string

Required string length: 1 - 128

data.amendments.commits.archived_at

string<date-time>

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

data.amendments.overrides

object[]

required

Show child attributes

data.amendments.overrides.id

string<uuid>

required

data.amendments.overrides.starting_at

string<date-time>

required

data.amendments.overrides.product

object

Show child attributes

data.amendments.overrides.product.id

string<uuid>

required

data.amendments.overrides.product.name

string

required

data.amendments.overrides.applicable_product_tags

string[]

data.amendments.overrides.override_specifiers

object[]

Show child attributes

data.amendments.overrides.override_specifiers.product_id

string<uuid>

data.amendments.overrides.override_specifiers.product_tags

string[]

data.amendments.overrides.override_specifiers.pricing_group_values

object

Show child attributes

data.amendments.overrides.override_specifiers.pricing_group_values.{key}

string

data.amendments.overrides.override_specifiers.presentation_group_values

object

Show child attributes

data.amendments.overrides.override_specifiers.presentation_group_values.{key}

string | null

data.amendments.overrides.override_specifiers.commit_ids

string[]

data.amendments.overrides.override_specifiers.recurring_commit_ids

string[]

data.amendments.overrides.override_specifiers.recurring_credit_ids

string[]

data.amendments.overrides.override_specifiers.billing_frequency

enum<string>

Available options:

MONTHLY,

QUARTERLY,

ANNUAL,

WEEKLY,

monthly,

quarterly,

annual,

weekly

data.amendments.overrides.ending_before

string<date-time>

data.amendments.overrides.entitled

boolean

data.amendments.overrides.type

enum<string>

Available options:

OVERWRITE,

MULTIPLIER,

TIERED

data.amendments.overrides.priority

number

data.amendments.overrides.multiplier

number

data.amendments.overrides.overwrite_rate

object

Show child attributes

data.amendments.overrides.overwrite_rate.rate_type

enum<string>

required

Available options:

FLAT,

flat,

PERCENTAGE,

percentage,

TIERED,

tiered

data.amendments.overrides.overwrite_rate.price

number

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.

data.amendments.overrides.overwrite_rate.tiers

object[]

Only set for TIERED rate_type.

Show child attributes

data.amendments.overrides.overwrite_rate.tiers.price

number

required

data.amendments.overrides.overwrite_rate.tiers.size

number

data.amendments.overrides.overwrite_rate.credit_type

object

Show child attributes

data.amendments.overrides.overwrite_rate.credit_type.name

string

required

data.amendments.overrides.overwrite_rate.credit_type.id

string<uuid>

required

data.amendments.overrides.override_tiers

object[]

Show child attributes

data.amendments.overrides.override_tiers.multiplier

number

required

data.amendments.overrides.override_tiers.size

number

data.amendments.overrides.is_commit_specific

boolean

data.amendments.overrides.target

enum<string>

Available options:

COMMIT_RATE,

LIST_RATE

data.amendments.overrides.rate_type

enum<string>

Available options:

FLAT,

flat,

PERCENTAGE,

percentage,

TIERED,

tiered

data.amendments.overrides.price

number

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.

data.amendments.overrides.tiers

object[]

Only set for TIERED rate_type.

Show child attributes

data.amendments.overrides.tiers.price

number

required

data.amendments.overrides.tiers.size

number

data.amendments.overrides.value

object

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

data.amendments.overrides.credit_type

object

Show child attributes

data.amendments.overrides.credit_type.name

string

required

data.amendments.overrides.credit_type.id

string<uuid>

required

data.amendments.scheduled_charges

object[]

required

Show child attributes

data.amendments.scheduled_charges.id

string<uuid>

required

data.amendments.scheduled_charges.product

object

required

Show child attributes

data.amendments.scheduled_charges.product.id

string<uuid>

required

data.amendments.scheduled_charges.product.name

string

required

data.amendments.scheduled_charges.schedule

object

required

Show child attributes

data.amendments.scheduled_charges.schedule.credit_type

object

Show child attributes

data.amendments.scheduled_charges.schedule.credit_type.name

string

required

data.amendments.scheduled_charges.schedule.credit_type.id

string<uuid>

required

data.amendments.scheduled_charges.schedule.schedule_items

object[]

Show child attributes

data.amendments.scheduled_charges.schedule.schedule_items.id

string<uuid>

required

data.amendments.scheduled_charges.schedule.schedule_items.amount

number

required

data.amendments.scheduled_charges.schedule.schedule_items.unit_price

number

required

data.amendments.scheduled_charges.schedule.schedule_items.quantity

number

required

data.amendments.scheduled_charges.schedule.schedule_items.timestamp

string<date-time>

required

data.amendments.scheduled_charges.schedule.schedule_items.invoice_id

string<uuid> | null

data.amendments.scheduled_charges.schedule.do_not_invoice

boolean

default:false

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

data.amendments.scheduled_charges.name

string

displayed on invoices

Minimum string length: 1

data.amendments.scheduled_charges.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.amendments.scheduled_charges.custom_fields.{key}

string

data.amendments.scheduled_charges.archived_at

string<date-time>

data.amendments.created_at

string<date-time>

required

data.amendments.created_by

string

required

data.amendments.credits

object[]

Show child attributes

data.amendments.credits.id

string<uuid>

required

data.amendments.credits.type

enum<string>

required

Available options:

CREDIT

data.amendments.credits.product

object

required

Show child attributes

data.amendments.credits.product.id

string<uuid>

required

data.amendments.credits.product.name

string

required

data.amendments.credits.contract

object

Show child attributes

data.amendments.credits.contract.id

string<uuid>

required

data.amendments.credits.name

string

data.amendments.credits.priority

number

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

data.amendments.credits.access_schedule

object

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

Show child attributes

data.amendments.credits.access_schedule.schedule_items

object[]

required

Show child attributes

data.amendments.credits.access_schedule.schedule_items.id

string<uuid>

required

data.amendments.credits.access_schedule.schedule_items.amount

number

required

data.amendments.credits.access_schedule.schedule_items.starting_at

string<date-time>

required

data.amendments.credits.access_schedule.schedule_items.ending_before

string<date-time>

required

data.amendments.credits.access_schedule.credit_type

object

Show child attributes

data.amendments.credits.access_schedule.credit_type.name

string

required

data.amendments.credits.access_schedule.credit_type.id

string<uuid>

required

data.amendments.credits.description

string

data.amendments.credits.applicable_product_ids

string<uuid>[]

data.amendments.credits.applicable_product_tags

string[]

data.amendments.credits.specifiers

object[]

Show child attributes

data.amendments.credits.specifiers.product_id

string<uuid>

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

data.amendments.credits.specifiers.product_tags

string[]

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

data.amendments.credits.specifiers.pricing_group_values

object

Show child attributes

data.amendments.credits.specifiers.pricing_group_values.{key}

string

data.amendments.credits.specifiers.presentation_group_values

object

Show child attributes

data.amendments.credits.specifiers.presentation_group_values.{key}

string

data.amendments.credits.applicable_contract_ids

string<uuid>[]

data.amendments.credits.ledger

object[]

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

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

data.amendments.credits.ledger.type

enum<string>

required

Available options:

CREDIT_SEGMENT_START

data.amendments.credits.ledger.timestamp

string<date-time>

required

data.amendments.credits.ledger.amount

number

required

data.amendments.credits.ledger.segment_id

string<uuid>

required

data.amendments.credits.balance

number

data.amendments.credits.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.amendments.credits.custom_fields.{key}

string

data.amendments.credits.rate_type

enum<string>

Available options:

COMMIT_RATE,

LIST_RATE

data.amendments.credits.uniqueness_key

string

Required string length: 1 - 128

data.archived_at

string<date-time>

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

data.uniqueness_key

string

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.

Required string length: 1 - 128

data.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.custom_fields.{key}

string

data.customer_billing_provider_configuration

object

The billing provider configuration associated with a contract.

Show child attributes

data.customer_billing_provider_configuration.billing_provider

enum<string>

required

Available options:

aws_marketplace,

stripe,

azure_marketplace,

quickbooks_online,

metronome

data.customer_billing_provider_configuration.delivery_method

enum<string>

required

Available options:

direct_to_billing_provider,

aws_sqs,

tackle,

aws_sns

data.customer_billing_provider_configuration.archived_at

string<date-time> | null

required

data.customer_billing_provider_configuration.id

string<uuid>

data.customer_billing_provider_configuration.configuration

object

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

data.scheduled_charges_on_usage_invoices

enum<string>

Available options:

ALL

data.subscriptions

object[]

List of subscriptions on the contract.

Show child attributes

data.subscriptions.subscription_rate

object

required

Show child attributes

data.subscriptions.subscription_rate.billing_frequency

enum<string>

required

Available options:

MONTHLY,

QUARTERLY,

ANNUAL,

WEEKLY,

monthly,

quarterly,

annual,

weekly

data.subscriptions.subscription_rate.product

object

required

Show child attributes

data.subscriptions.subscription_rate.product.id

string<uuid>

required

data.subscriptions.subscription_rate.product.name

string

required

data.subscriptions.collection_schedule

enum<string>

required

Available options:

ADVANCE,

ARREARS,

advance,

arrears

data.subscriptions.proration

object

required

Show child attributes

data.subscriptions.proration.is_prorated

boolean

required

data.subscriptions.proration.invoice_behavior

enum<string>

required

Available options:

BILL_IMMEDIATELY,

BILL_ON_NEXT_COLLECTION_DATE,

bill_immediately,

bill_on_next_collection_date

data.subscriptions.quantity_schedule

object[]

required

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

Show child attributes

data.subscriptions.quantity_schedule.quantity

number

required

data.subscriptions.quantity_schedule.starting_at

string<date-time>

required

data.subscriptions.quantity_schedule.ending_before

string<date-time>

data.subscriptions.billing_periods

object

required

Previous, current, and next billing periods for the subscription.

Show child attributes

data.subscriptions.billing_periods.previous

object

Show child attributes

data.subscriptions.billing_periods.previous.starting_at

string<date-time>

required

data.subscriptions.billing_periods.previous.ending_before

string<date-time>

required

data.subscriptions.billing_periods.current

object

Show child attributes

data.subscriptions.billing_periods.current.starting_at

string<date-time>

required

data.subscriptions.billing_periods.current.ending_before

string<date-time>

required

data.subscriptions.billing_periods.next

object

Show child attributes

data.subscriptions.billing_periods.next.starting_at

string<date-time>

required

data.subscriptions.billing_periods.next.ending_before

string<date-time>

required

data.subscriptions.quantity_management_mode

enum<string>

required

Determines how the subscription's quantity is controlled. Defaults to QUANTITY_ONLY. QUANTITY_ONLY: The subscription quantity is specified directly on the subscription. initial_quantity must be provided with this option. Compatible with recurring commits/credits that use POOLED allocation. SEAT_BASED: Use when you want to pass specific seat identifiers (e.g. add user_123) to increment and decrement a subscription quantity, rather than directly providing the quantity. You must use a SEAT_BASED subscription to use a linked recurring credit with an allocation per seat. seat_config must be provided with this option.

Available options:

SEAT_BASED,

seat_based,

QUANTITY_ONLY,

quantity_only

data.subscriptions.starting_at

string<date-time>

required

data.subscriptions.id

string<uuid>

data.subscriptions.name

string

data.subscriptions.description

string

data.subscriptions.seat_config

object

Show child attributes

data.subscriptions.seat_config.seat_group_key

string

required

The property name, sent on usage events, that identifies the seat ID associated with the usage event. For example, the property name might be seat_id or user_id. The property must be set as a group key on billable metrics and a presentation/pricing group key on contract products. This allows linked recurring credits with an allocation per seat to be consumed by only one seat's usage.

data.subscriptions.ending_before

string<date-time>

data.subscriptions.fiat_credit_type_id

string<uuid>

data.subscriptions.custom_fields

object

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Show child attributes

data.subscriptions.custom_fields.{key}

string

data.spend_threshold_configuration

object

Show child attributes

data.spend_threshold_configuration.is_enabled

boolean

required

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.

data.spend_threshold_configuration.threshold_amount

number

required

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

data.spend_threshold_configuration.commit

object

required

Show child attributes

data.spend_threshold_configuration.commit.product_id

string

required

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

data.spend_threshold_configuration.commit.name

string

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

data.spend_threshold_configuration.commit.description

string

data.spend_threshold_configuration.payment_gate_config

object

required

Show child attributes

data.spend_threshold_configuration.payment_gate_config.payment_gate_type

enum<string>

required

Available options:

NONE,

STRIPE,

EXTERNAL

data.spend_threshold_configuration.payment_gate_config.tax_type

enum<string>

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.

Available options:

NONE,

STRIPE,

ANROK,

AVALARA,

PRECALCULATED

data.spend_threshold_configuration.payment_gate_config.stripe_config

object

Only applicable if using STRIPE as your payment gate type.

Show child attributes

data.spend_threshold_configuration.payment_gate_config.stripe_config.payment_type

enum<string>

required

If left blank, will default to INVOICE

Available options:

INVOICE,

PAYMENT_INTENT

data.spend_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata

object

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

Show child attributes

data.spend_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata.{key}

string

data.spend_threshold_configuration.payment_gate_config.precalculated_tax_config

object

Only applicable if using PRECALCULATED as your tax type.

Show child attributes

data.spend_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_amount

number

required

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

data.spend_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_name

string

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

data.prepaid_balance_threshold_configuration

object

Show child attributes

data.prepaid_balance_threshold_configuration.is_enabled

boolean

required

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.

data.prepaid_balance_threshold_configuration.threshold_amount

number

required

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

data.prepaid_balance_threshold_configuration.recharge_to_amount

number

required

Specify the amount the balance should be recharged to.

data.prepaid_balance_threshold_configuration.commit

object

required

Show child attributes

data.prepaid_balance_threshold_configuration.commit.product_id

string

required

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

data.prepaid_balance_threshold_configuration.commit.name

string

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

data.prepaid_balance_threshold_configuration.commit.description

string

data.prepaid_balance_threshold_configuration.commit.applicable_product_ids

string<uuid>[]

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.

data.prepaid_balance_threshold_configuration.commit.applicable_product_tags

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.

data.prepaid_balance_threshold_configuration.payment_gate_config

object

required

Show child attributes

data.prepaid_balance_threshold_configuration.payment_gate_config.payment_gate_type

enum<string>

required

Available options:

NONE,

STRIPE,

EXTERNAL

data.prepaid_balance_threshold_configuration.payment_gate_config.tax_type

enum<string>

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.

Available options:

NONE,

STRIPE,

ANROK,

AVALARA,

PRECALCULATED

data.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config

object

Only applicable if using STRIPE as your payment gate type.

Show child attributes

data.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config.payment_type

enum<string>

required

If left blank, will default to INVOICE

Available options:

INVOICE,

PAYMENT_INTENT

data.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata

object

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

Show child attributes

data.prepaid_balance_threshold_configuration.payment_gate_config.stripe_config.invoice_metadata.{key}

string

data.prepaid_balance_threshold_configuration.payment_gate_config.precalculated_tax_config

object

Only applicable if using PRECALCULATED as your tax type.

Show child attributes

data.prepaid_balance_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_amount

number

required

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

data.prepaid_balance_threshold_configuration.payment_gate_config.precalculated_tax_config.tax_name

string

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

data.prepaid_balance_threshold_configuration.custom_credit_type_id

string<uuid>

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.

GET STARTED

ESSENTIALS

ENDPOINTS

List customer contracts (v1)

Authorizations

Body

Response