List
List customer contracts (v1)
post/v1/contracts/list
This is the v1 endpoint to list all contracts for a customer. New clients should implement using the v2 endpoint.
Body Parameters
customer_idstring
formatuuid
covering_datestring
optional
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.
formatdate-time
include_archivedboolean
optional
Include archived contracts in the response
include_balanceboolean
optional
Include the balance of credits and commits in the response. Setting this flag may cause the query to be slower.
include_ledgersboolean
optional
Include commit ledgers in the response. Setting this flag may cause the query to be slower.
starting_atstring
optional
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.
formatdate-time
Returns
dataarray of object
curl https://api.metronome.com/v1/contracts/list \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
-d '{
"customer_id": "9b85c1c1-5238-4f2a-a409-61412905e1e1"
}'
200 Example
{
"data": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amendments": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"commits": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"type": "PREPAID",
"access_schedule": {
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"ending_before": "2019-12-27T18:11:19.117Z",
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
}
},
"amount": 0,
"applicable_contract_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"archived_at": "2019-12-27T18:11:19.117Z",
"balance": 0,
"contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"custom_fields": {
"foo": "string"
},
"description": "description",
"hierarchy_configuration": {
"child_access": {
"type": "ALL"
}
},
"invoice_contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"invoice_schedule": {
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"do_not_invoice": true,
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"quantity": 0,
"timestamp": "2019-12-27T18:11:19.117Z",
"unit_price": 0,
"invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"ledger": [
{
"amount": 0,
"segment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"timestamp": "2019-12-27T18:11:19.117Z",
"type": "PREPAID_COMMIT_SEGMENT_START"
}
],
"name": "name",
"netsuite_sales_order_id": "netsuite_sales_order_id",
"priority": 0,
"rate_type": "COMMIT_RATE",
"rolled_over_from": {
"commit_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"rollover_fraction": 0,
"salesforce_opportunity_id": "salesforce_opportunity_id",
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
],
"uniqueness_key": "x"
}
],
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": "created_by",
"overrides": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"starting_at": "2019-12-27T18:11:19.117Z",
"applicable_product_tags": [
"string"
],
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"ending_before": "2019-12-27T18:11:19.117Z",
"entitled": true,
"is_commit_specific": true,
"is_prorated": true,
"multiplier": 0,
"override_specifiers": [
{
"billing_frequency": "MONTHLY",
"commit_ids": [
"string"
],
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
],
"recurring_commit_ids": [
"string"
],
"recurring_credit_ids": [
"string"
]
}
],
"override_tiers": [
{
"multiplier": 0,
"size": 0
}
],
"overwrite_rate": {
"rate_type": "FLAT",
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"custom_rate": {
"foo": "bar"
},
"is_prorated": true,
"price": 0,
"quantity": 0,
"tiers": [
{
"price": 0,
"size": 0
}
]
},
"price": 0,
"priority": 0,
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"quantity": 0,
"rate_type": "FLAT",
"target": "COMMIT_RATE",
"tiers": [
{
"price": 0,
"size": 0
}
],
"type": "OVERWRITE",
"value": {
"foo": "bar"
}
}
],
"scheduled_charges": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"schedule": {
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"do_not_invoice": true,
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"quantity": 0,
"timestamp": "2019-12-27T18:11:19.117Z",
"unit_price": 0,
"invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"archived_at": "2019-12-27T18:11:19.117Z",
"custom_fields": {
"foo": "string"
},
"name": "x",
"netsuite_sales_order_id": "netsuite_sales_order_id"
}
],
"starting_at": "2019-12-27T18:11:19.117Z",
"credits": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"type": "CREDIT",
"access_schedule": {
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"ending_before": "2019-12-27T18:11:19.117Z",
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
}
},
"applicable_contract_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"balance": 0,
"contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"custom_fields": {
"foo": "string"
},
"description": "description",
"hierarchy_configuration": {
"child_access": {
"type": "ALL"
}
},
"ledger": [
{
"amount": 0,
"segment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"timestamp": "2019-12-27T18:11:19.117Z",
"type": "CREDIT_SEGMENT_START"
}
],
"name": "name",
"netsuite_sales_order_id": "netsuite_sales_order_id",
"priority": 0,
"rate_type": "COMMIT_RATE",
"salesforce_opportunity_id": "salesforce_opportunity_id",
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
],
"uniqueness_key": "x"
}
],
"discounts": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"schedule": {
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"do_not_invoice": true,
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"quantity": 0,
"timestamp": "2019-12-27T18:11:19.117Z",
"unit_price": 0,
"invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"custom_fields": {
"foo": "string"
},
"name": "x",
"netsuite_sales_order_id": "netsuite_sales_order_id"
}
],
"netsuite_sales_order_id": "netsuite_sales_order_id",
"professional_services": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"max_amount": 0,
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"quantity": 0,
"unit_price": 0,
"custom_fields": {
"foo": "string"
},
"description": "description",
"netsuite_sales_order_id": "netsuite_sales_order_id"
}
],
"reseller_royalties": [
{
"reseller_type": "AWS",
"aws_account_number": "aws_account_number",
"aws_offer_id": "aws_offer_id",
"aws_payer_reference_id": "aws_payer_reference_id",
"ending_before": "2019-12-27T18:11:19.117Z",
"fraction": 0,
"gcp_account_id": "gcp_account_id",
"gcp_offer_id": "gcp_offer_id",
"netsuite_reseller_id": "netsuite_reseller_id",
"reseller_contract_value": 0,
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"salesforce_opportunity_id": "salesforce_opportunity_id"
}
],
"current": {
"commits": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"type": "PREPAID",
"access_schedule": {
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"ending_before": "2019-12-27T18:11:19.117Z",
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
}
},
"amount": 0,
"applicable_contract_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"archived_at": "2019-12-27T18:11:19.117Z",
"balance": 0,
"contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"custom_fields": {
"foo": "string"
},
"description": "description",
"hierarchy_configuration": {
"child_access": {
"type": "ALL"
}
},
"invoice_contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"invoice_schedule": {
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"do_not_invoice": true,
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"quantity": 0,
"timestamp": "2019-12-27T18:11:19.117Z",
"unit_price": 0,
"invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"ledger": [
{
"amount": 0,
"segment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"timestamp": "2019-12-27T18:11:19.117Z",
"type": "PREPAID_COMMIT_SEGMENT_START"
}
],
"name": "name",
"netsuite_sales_order_id": "netsuite_sales_order_id",
"priority": 0,
"rate_type": "COMMIT_RATE",
"rolled_over_from": {
"commit_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"rollover_fraction": 0,
"salesforce_opportunity_id": "salesforce_opportunity_id",
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
],
"uniqueness_key": "x"
}
],
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": "created_by",
"overrides": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"starting_at": "2019-12-27T18:11:19.117Z",
"applicable_product_tags": [
"string"
],
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"ending_before": "2019-12-27T18:11:19.117Z",
"entitled": true,
"is_commit_specific": true,
"is_prorated": true,
"multiplier": 0,
"override_specifiers": [
{
"billing_frequency": "MONTHLY",
"commit_ids": [
"string"
],
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
],
"recurring_commit_ids": [
"string"
],
"recurring_credit_ids": [
"string"
]
}
],
"override_tiers": [
{
"multiplier": 0,
"size": 0
}
],
"overwrite_rate": {
"rate_type": "FLAT",
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"custom_rate": {
"foo": "bar"
},
"is_prorated": true,
"price": 0,
"quantity": 0,
"tiers": [
{
"price": 0,
"size": 0
}
]
},
"price": 0,
"priority": 0,
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"quantity": 0,
"rate_type": "FLAT",
"target": "COMMIT_RATE",
"tiers": [
{
"price": 0,
"size": 0
}
],
"type": "OVERWRITE",
"value": {
"foo": "bar"
}
}
],
"scheduled_charges": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"schedule": {
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"do_not_invoice": true,
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"quantity": 0,
"timestamp": "2019-12-27T18:11:19.117Z",
"unit_price": 0,
"invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"archived_at": "2019-12-27T18:11:19.117Z",
"custom_fields": {
"foo": "string"
},
"name": "x",
"netsuite_sales_order_id": "netsuite_sales_order_id"
}
],
"starting_at": "2019-12-27T18:11:19.117Z",
"transitions": [
{
"from_contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"to_contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"type": "SUPERSEDE"
}
],
"usage_statement_schedule": {
"billing_anchor_date": "2019-12-27T18:11:19.117Z",
"frequency": "MONTHLY"
},
"credits": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"type": "CREDIT",
"access_schedule": {
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"ending_before": "2019-12-27T18:11:19.117Z",
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
}
},
"applicable_contract_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"balance": 0,
"contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"custom_fields": {
"foo": "string"
},
"description": "description",
"hierarchy_configuration": {
"child_access": {
"type": "ALL"
}
},
"ledger": [
{
"amount": 0,
"segment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"timestamp": "2019-12-27T18:11:19.117Z",
"type": "CREDIT_SEGMENT_START"
}
],
"name": "name",
"netsuite_sales_order_id": "netsuite_sales_order_id",
"priority": 0,
"rate_type": "COMMIT_RATE",
"salesforce_opportunity_id": "salesforce_opportunity_id",
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
],
"uniqueness_key": "x"
}
],
"discounts": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"schedule": {
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"do_not_invoice": true,
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"quantity": 0,
"timestamp": "2019-12-27T18:11:19.117Z",
"unit_price": 0,
"invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"custom_fields": {
"foo": "string"
},
"name": "x",
"netsuite_sales_order_id": "netsuite_sales_order_id"
}
],
"ending_before": "2019-12-27T18:11:19.117Z",
"hierarchy_configuration": {
"children": [
{
"contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"name": "name",
"net_payment_terms_days": 0,
"netsuite_sales_order_id": "netsuite_sales_order_id",
"prepaid_balance_threshold_configuration": {
"commit": {
"product_id": "product_id",
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"description": "description",
"name": "name",
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
]
},
"is_enabled": true,
"payment_gate_config": {
"payment_gate_type": "NONE",
"precalculated_tax_config": {
"tax_amount": 0,
"tax_name": "tax_name"
},
"stripe_config": {
"payment_type": "INVOICE",
"invoice_metadata": {
"foo": "string"
}
},
"tax_type": "NONE"
},
"recharge_to_amount": 0,
"threshold_amount": 0,
"custom_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"professional_services": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"max_amount": 0,
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"quantity": 0,
"unit_price": 0,
"custom_fields": {
"foo": "string"
},
"description": "description",
"netsuite_sales_order_id": "netsuite_sales_order_id"
}
],
"rate_card_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"recurring_commits": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"access_amount": {
"credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"unit_price": 0,
"quantity": 0
},
"commit_duration": {
"value": 0,
"unit": "PERIODS"
},
"priority": 0,
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"rate_type": "COMMIT_RATE",
"starting_at": "2019-12-27T18:11:19.117Z",
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"description": "description",
"ending_before": "2019-12-27T18:11:19.117Z",
"hierarchy_configuration": {
"child_access": {
"type": "ALL"
}
},
"invoice_amount": {
"credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"quantity": 0,
"unit_price": 0
},
"name": "name",
"netsuite_sales_order_id": "netsuite_sales_order_id",
"proration": "NONE",
"recurrence_frequency": "MONTHLY",
"rollover_fraction": 0,
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
],
"subscription_config": {
"allocation": "INDIVIDUAL",
"apply_seat_increase_config": {
"is_prorated": true
},
"subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
}
],
"recurring_credits": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"access_amount": {
"credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"unit_price": 0,
"quantity": 0
},
"commit_duration": {
"value": 0,
"unit": "PERIODS"
},
"priority": 0,
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"rate_type": "COMMIT_RATE",
"starting_at": "2019-12-27T18:11:19.117Z",
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"description": "description",
"ending_before": "2019-12-27T18:11:19.117Z",
"hierarchy_configuration": {
"child_access": {
"type": "ALL"
}
},
"name": "name",
"netsuite_sales_order_id": "netsuite_sales_order_id",
"proration": "NONE",
"recurrence_frequency": "MONTHLY",
"rollover_fraction": 0,
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
],
"subscription_config": {
"allocation": "INDIVIDUAL",
"apply_seat_increase_config": {
"is_prorated": true
},
"subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
}
],
"reseller_royalties": [
{
"fraction": 0,
"netsuite_reseller_id": "netsuite_reseller_id",
"reseller_type": "AWS",
"starting_at": "2019-12-27T18:11:19.117Z",
"applicable_product_ids": [
"string"
],
"applicable_product_tags": [
"string"
],
"aws_account_number": "aws_account_number",
"aws_offer_id": "aws_offer_id",
"aws_payer_reference_id": "aws_payer_reference_id",
"ending_before": "2019-12-27T18:11:19.117Z",
"gcp_account_id": "gcp_account_id",
"gcp_offer_id": "gcp_offer_id",
"reseller_contract_value": 0
}
],
"salesforce_opportunity_id": "salesforce_opportunity_id",
"scheduled_charges_on_usage_invoices": "ALL",
"spend_threshold_configuration": {
"commit": {
"product_id": "product_id",
"description": "description",
"name": "name"
},
"is_enabled": true,
"payment_gate_config": {
"payment_gate_type": "NONE",
"precalculated_tax_config": {
"tax_amount": 0,
"tax_name": "tax_name"
},
"stripe_config": {
"payment_type": "INVOICE",
"invoice_metadata": {
"foo": "string"
}
},
"tax_type": "NONE"
},
"threshold_amount": 0
},
"total_contract_value": 0,
"usage_filter": {
"current": {
"group_key": "group_key",
"group_values": [
"string"
],
"starting_at": "2019-12-27T18:11:19.117Z"
},
"initial": {
"group_key": "group_key",
"group_values": [
"string"
],
"starting_at": "2019-12-27T18:11:19.117Z"
},
"updates": [
{
"group_key": "group_key",
"group_values": [
"string"
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
]
}
},
"customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"initial": {
"commits": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"type": "PREPAID",
"access_schedule": {
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"ending_before": "2019-12-27T18:11:19.117Z",
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
}
},
"amount": 0,
"applicable_contract_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"archived_at": "2019-12-27T18:11:19.117Z",
"balance": 0,
"contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"custom_fields": {
"foo": "string"
},
"description": "description",
"hierarchy_configuration": {
"child_access": {
"type": "ALL"
}
},
"invoice_contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"invoice_schedule": {
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"do_not_invoice": true,
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"quantity": 0,
"timestamp": "2019-12-27T18:11:19.117Z",
"unit_price": 0,
"invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"ledger": [
{
"amount": 0,
"segment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"timestamp": "2019-12-27T18:11:19.117Z",
"type": "PREPAID_COMMIT_SEGMENT_START"
}
],
"name": "name",
"netsuite_sales_order_id": "netsuite_sales_order_id",
"priority": 0,
"rate_type": "COMMIT_RATE",
"rolled_over_from": {
"commit_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"rollover_fraction": 0,
"salesforce_opportunity_id": "salesforce_opportunity_id",
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
],
"uniqueness_key": "x"
}
],
"created_at": "2019-12-27T18:11:19.117Z",
"created_by": "created_by",
"overrides": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"starting_at": "2019-12-27T18:11:19.117Z",
"applicable_product_tags": [
"string"
],
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"ending_before": "2019-12-27T18:11:19.117Z",
"entitled": true,
"is_commit_specific": true,
"is_prorated": true,
"multiplier": 0,
"override_specifiers": [
{
"billing_frequency": "MONTHLY",
"commit_ids": [
"string"
],
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
],
"recurring_commit_ids": [
"string"
],
"recurring_credit_ids": [
"string"
]
}
],
"override_tiers": [
{
"multiplier": 0,
"size": 0
}
],
"overwrite_rate": {
"rate_type": "FLAT",
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"custom_rate": {
"foo": "bar"
},
"is_prorated": true,
"price": 0,
"quantity": 0,
"tiers": [
{
"price": 0,
"size": 0
}
]
},
"price": 0,
"priority": 0,
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"quantity": 0,
"rate_type": "FLAT",
"target": "COMMIT_RATE",
"tiers": [
{
"price": 0,
"size": 0
}
],
"type": "OVERWRITE",
"value": {
"foo": "bar"
}
}
],
"scheduled_charges": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"schedule": {
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"do_not_invoice": true,
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"quantity": 0,
"timestamp": "2019-12-27T18:11:19.117Z",
"unit_price": 0,
"invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"archived_at": "2019-12-27T18:11:19.117Z",
"custom_fields": {
"foo": "string"
},
"name": "x",
"netsuite_sales_order_id": "netsuite_sales_order_id"
}
],
"starting_at": "2019-12-27T18:11:19.117Z",
"transitions": [
{
"from_contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"to_contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"type": "SUPERSEDE"
}
],
"usage_statement_schedule": {
"billing_anchor_date": "2019-12-27T18:11:19.117Z",
"frequency": "MONTHLY"
},
"credits": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"type": "CREDIT",
"access_schedule": {
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"ending_before": "2019-12-27T18:11:19.117Z",
"starting_at": "2019-12-27T18:11:19.117Z"
}
],
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
}
},
"applicable_contract_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"balance": 0,
"contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"custom_fields": {
"foo": "string"
},
"description": "description",
"hierarchy_configuration": {
"child_access": {
"type": "ALL"
}
},
"ledger": [
{
"amount": 0,
"segment_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"timestamp": "2019-12-27T18:11:19.117Z",
"type": "CREDIT_SEGMENT_START"
}
],
"name": "name",
"netsuite_sales_order_id": "netsuite_sales_order_id",
"priority": 0,
"rate_type": "COMMIT_RATE",
"salesforce_opportunity_id": "salesforce_opportunity_id",
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
],
"uniqueness_key": "x"
}
],
"discounts": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"schedule": {
"credit_type": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"do_not_invoice": true,
"schedule_items": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"amount": 0,
"quantity": 0,
"timestamp": "2019-12-27T18:11:19.117Z",
"unit_price": 0,
"invoice_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"custom_fields": {
"foo": "string"
},
"name": "x",
"netsuite_sales_order_id": "netsuite_sales_order_id"
}
],
"ending_before": "2019-12-27T18:11:19.117Z",
"hierarchy_configuration": {
"children": [
{
"contract_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"customer_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
]
},
"name": "name",
"net_payment_terms_days": 0,
"netsuite_sales_order_id": "netsuite_sales_order_id",
"prepaid_balance_threshold_configuration": {
"commit": {
"product_id": "product_id",
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"description": "description",
"name": "name",
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
]
},
"is_enabled": true,
"payment_gate_config": {
"payment_gate_type": "NONE",
"precalculated_tax_config": {
"tax_amount": 0,
"tax_name": "tax_name"
},
"stripe_config": {
"payment_type": "INVOICE",
"invoice_metadata": {
"foo": "string"
}
},
"tax_type": "NONE"
},
"recharge_to_amount": 0,
"threshold_amount": 0,
"custom_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"professional_services": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"max_amount": 0,
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"quantity": 0,
"unit_price": 0,
"custom_fields": {
"foo": "string"
},
"description": "description",
"netsuite_sales_order_id": "netsuite_sales_order_id"
}
],
"rate_card_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"recurring_commits": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"access_amount": {
"credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"unit_price": 0,
"quantity": 0
},
"commit_duration": {
"value": 0,
"unit": "PERIODS"
},
"priority": 0,
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"rate_type": "COMMIT_RATE",
"starting_at": "2019-12-27T18:11:19.117Z",
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"description": "description",
"ending_before": "2019-12-27T18:11:19.117Z",
"hierarchy_configuration": {
"child_access": {
"type": "ALL"
}
},
"invoice_amount": {
"credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"quantity": 0,
"unit_price": 0
},
"name": "name",
"netsuite_sales_order_id": "netsuite_sales_order_id",
"proration": "NONE",
"recurrence_frequency": "MONTHLY",
"rollover_fraction": 0,
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
],
"subscription_config": {
"allocation": "INDIVIDUAL",
"apply_seat_increase_config": {
"is_prorated": true
},
"subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
}
],
"recurring_credits": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"access_amount": {
"credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"unit_price": 0,
"quantity": 0
},
"commit_duration": {
"value": 0,
"unit": "PERIODS"
},
"priority": 0,
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
},
"rate_type": "COMMIT_RATE",
"starting_at": "2019-12-27T18:11:19.117Z",
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"contract": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"description": "description",
"ending_before": "2019-12-27T18:11:19.117Z",
"hierarchy_configuration": {
"child_access": {
"type": "ALL"
}
},
"name": "name",
"netsuite_sales_order_id": "netsuite_sales_order_id",
"proration": "NONE",
"recurrence_frequency": "MONTHLY",
"rollover_fraction": 0,
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
],
"subscription_config": {
"allocation": "INDIVIDUAL",
"apply_seat_increase_config": {
"is_prorated": true
},
"subscription_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
}
],
"reseller_royalties": [
{
"fraction": 0,
"netsuite_reseller_id": "netsuite_reseller_id",
"reseller_type": "AWS",
"starting_at": "2019-12-27T18:11:19.117Z",
"applicable_product_ids": [
"string"
],
"applicable_product_tags": [
"string"
],
"aws_account_number": "aws_account_number",
"aws_offer_id": "aws_offer_id",
"aws_payer_reference_id": "aws_payer_reference_id",
"ending_before": "2019-12-27T18:11:19.117Z",
"gcp_account_id": "gcp_account_id",
"gcp_offer_id": "gcp_offer_id",
"reseller_contract_value": 0
}
],
"salesforce_opportunity_id": "salesforce_opportunity_id",
"scheduled_charges_on_usage_invoices": "ALL",
"spend_threshold_configuration": {
"commit": {
"product_id": "product_id",
"description": "description",
"name": "name"
},
"is_enabled": true,
"payment_gate_config": {
"payment_gate_type": "NONE",
"precalculated_tax_config": {
"tax_amount": 0,
"tax_name": "tax_name"
},
"stripe_config": {
"payment_type": "INVOICE",
"invoice_metadata": {
"foo": "string"
}
},
"tax_type": "NONE"
},
"threshold_amount": 0
},
"total_contract_value": 0,
"usage_filter": {
"current": {
"group_key": "group_key",
"group_values": [
"string"
],
"starting_at": "2019-12-27T18:11:19.117Z"
},
"initial": {
"group_key": "group_key",
"group_values": [
"string"
],
"starting_at": "2019-12-27T18:11:19.117Z"
},
"updates": [
{
"group_key": "group_key",
"group_values": [
"string"
],
"starting_at": "2019-12-27T18:11:19.117Z"
}
]
}
},
"archived_at": "2019-12-27T18:11:19.117Z",
"custom_fields": {
"foo": "string"
},
"customer_billing_provider_configuration": {
"billing_provider": "aws_marketplace",
"delivery_method": "direct_to_billing_provider",
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"configuration": {
"foo": "bar"
}
},
"prepaid_balance_threshold_configuration": {
"commit": {
"product_id": "product_id",
"applicable_product_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"applicable_product_tags": [
"string"
],
"description": "description",
"name": "name",
"specifiers": [
{
"presentation_group_values": {
"foo": "string"
},
"pricing_group_values": {
"foo": "string"
},
"product_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"product_tags": [
"string"
]
}
]
},
"is_enabled": true,
"payment_gate_config": {
"payment_gate_type": "NONE",
"precalculated_tax_config": {
"tax_amount": 0,
"tax_name": "tax_name"
},
"stripe_config": {
"payment_type": "INVOICE",
"invoice_metadata": {
"foo": "string"
}
},
"tax_type": "NONE"
},
"recharge_to_amount": 0,
"threshold_amount": 0,
"custom_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
},
"priority": 0,
"scheduled_charges_on_usage_invoices": "ALL",
"spend_threshold_configuration": {
"commit": {
"product_id": "product_id",
"description": "description",
"name": "name"
},
"is_enabled": true,
"payment_gate_config": {
"payment_gate_type": "NONE",
"precalculated_tax_config": {
"tax_amount": 0,
"tax_name": "tax_name"
},
"stripe_config": {
"payment_type": "INVOICE",
"invoice_metadata": {
"foo": "string"
}
},
"tax_type": "NONE"
},
"threshold_amount": 0
},
"subscriptions": [
{
"collection_schedule": "ADVANCE",
"proration": {
"invoice_behavior": "BILL_IMMEDIATELY",
"is_prorated": true
},
"quantity_schedule": [
{
"quantity": 0,
"starting_at": "2019-12-27T18:11:19.117Z",
"ending_before": "2019-12-27T18:11:19.117Z"
}
],
"starting_at": "2019-12-27T18:11:19.117Z",
"subscription_rate": {
"billing_frequency": "MONTHLY",
"product": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
}
},
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"custom_fields": {
"foo": "string"
},
"description": "description",
"ending_before": "2019-12-27T18:11:19.117Z",
"fiat_credit_type_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"name": "name"
}
],
"uniqueness_key": "x"
}
]
}