> ## Documentation Index > Fetch the complete documentation index at: https://docs.metronome.com/llms.txt > Use this file to discover all available pages before exploring further. # List customer contracts (v1) > Retrieves all contracts for a specific customer, including pricing, terms, credits, and commitments. Use this to view a customer's contract history and current agreements for billing management. Returns contract details with optional ledgers and balance information. ⚠️ Note: This is the legacy v1 endpoint - new integrations should use the v2 endpoint for enhanced features. ## OpenAPI ````yaml /openapi.json post /v1/contracts/list openapi: 3.0.1 info: title: Metronome version: 1.0.0 servers: - url: https://api.metronome.com description: Production server security: - bearerAuth: [] tags: - name: Customers description: >- [Customers](https://docs.metronome.com/provisioning/create-customers/) in Metronome represent your users for all billing and reporting. Use these endpoints to create, retrieve, update, and archive customers and their billing configuration. - name: Billable metrics description: >- [Billable metrics](https://docs.metronome.com/understanding-metronome/how-metronome-works#billable-metrics) in Metronome represent the various consumption components that Metronome meters and aggregates. - name: Usage description: >- [Usage events](https://docs.metronome.com/connecting-metronome/send-usage-data/) are the basis for billable metrics. Use these endpoints to send usage events to Metronome and retrieve aggregated event data. - name: Products description: Products are the items that customers purchase. - name: Rate cards description: Rate cards are used to define default pricing for products. - name: Contracts description: >- A contract defines a customer’s products, pricing, discounts, commitments, and more. Use these endpoints to create and update contracts data. - name: Credits and commits description: Credits and commits are used to manage customer balances. - name: Invoices description: >- [Invoices](https://docs.metronome.com/invoicing/) reflect how much a customer spent during a period, which is the basis for billing. Metronome automatically generates invoices based upon your pricing, packaging, and usage events. Use these endpoints to retrieve invoices. - name: Alerts description: >- [Alerts](https://docs.metronome.com/connecting-metronome/alerts/) monitor customer spending, balances, and other billing factors. Use these endpoints to create, retrieve, and archive customer alerts. To view sample alert payloads by alert type, navigate [here.](https://docs.metronome.com/manage-product-access/create-manage-alerts/#webhook-notifications) - name: Custom fields description: >- [Custom fields](https://docs.metronome.com/integrations/custom-fields/) enable adding additional data to Metronome entities. Use these endpoints to create, retrieve, update, and delete custom fields. - name: Security description: >- [Security](https://docs.metronome.com/developer-resources/security/) endpoints allow you to retrieve security-related data. - name: Settings description: >- Use these endpoints to configure a billing API key, a webhook secret, or invoice finalization behavior. - name: Named schedules description: >- Named schedules are used for storing custom data that can change over time. Named schedules are often used in custom pricing logic. paths: /v1/contracts/list: post: tags: - Contracts summary: List customer contracts (v1) description: > Retrieves all contracts for a specific customer, including pricing, terms, credits, and commitments. Use this to view a customer's contract history and current agreements for billing management. Returns contract details with optional ledgers and balance information. ⚠️ Note: This is the legacy v1 endpoint - new integrations should use the v2 endpoint for enhanced features. operationId: listContracts-v1 requestBody: description: List all contracts for a customer content: application/json: schema: type: object required: - customer_id properties: customer_id: type: string format: uuid include_ledgers: type: boolean description: >- Include commit ledgers in the response. Setting this flag may cause the query to be slower. include_balance: type: boolean description: >- Include the balance of credits and commits in the response. Setting this flag may cause the query to be slower. include_archived: type: boolean description: Include archived contracts in the response starting_at: description: >- 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. type: string format: date-time covering_date: type: string format: date-time description: >- 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. example: customer_id: 9b85c1c1-5238-4f2a-a409-61412905e1e1 responses: '200': description: Success content: application/json: schema: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/Contract' example: data: - id: d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc customer_id: e3fd63fd-fc9f-4153-a543-1fc2261a0e1c initial: name: My contract rate_card_id: 92f3080d-27ca-4306-a23f-2430de61851e starting_at: '2020-01-01T00:00:00.000Z' net_payment_terms_days: 7 ending_before: '2022-01-01T00:00:00.000Z' commits: - id: 62c0cb84-bf3f-48b9-9bcf-a8ddf8c1cf35 type: PREPAID name: My test commit description: My test commit description product: id: 2e30f074-d04c-412e-a134-851ebfa5ceb2 name: My product A rollover_fraction: 0.1 applicable_product_ids: - 13a2179b-f0cb-460b-85a1-cd42964ca533 access_schedule: credit_type: id: 2714e483-4ff1-48e4-9e25-ac732e8f24f2 name: USD (cents) schedule_items: - id: 2d45952c-5a6e-43a9-8aab-f61ee21be81a amount: 10000000 starting_at: '2020-02-01T00:00:00.000Z' ending_before: '2021-02-01T00:00:00.000Z' invoice_schedule: credit_type: id: 2714e483-4ff1-48e4-9e25-ac732e8f24f2 name: USD (cents) schedule_items: - id: f15e4e23-f74e-4de4-9b3a-8b07434116c4 invoice_id: 525b9759-7bbd-4a05-aab1-d7c43c976b57 amount: 10000000 unit_price: 10000000 quantity: 1 timestamp: '2020-03-01T00:00:00.000Z' do_not_invoice: false ledger: - invoice_id: 525b9759-7bbd-4a05-aab1-d7c43c976b57 amount: 10000000 timestamp: '2020-03-01T00:00:00.000Z' type: PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION segment_id: 2d45952c-5a6e-43a9-8aab-f61ee21be81a created_at: '2020-01-01T00:00:00.000Z' overrides: - id: 6cf3292a-e85c-4be6-822c-e25ba9d19757 created_at: '2020-01-01T00:00:00.000Z' product: id: eae8903b-693b-41a7-8c0b-f23748c9a9c8 name: My product B starting_at: '2020-01-01T00:00:00.000Z' type: MULTIPLIER multiplier: 0.1 scheduled_charges: [] scheduled_charges_on_usage_invoices: ALL transitions: - type: RENEWAL from_contract_id: 9bf48856-b430-42f4-844f-4d2ea85bcff8 to_contract_id: d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc reseller_royalties: [] usage_statement_schedule: frequency: MONTHLY billing_anchor_date: '2020-01-01T00:00:00.000Z' created_at: '2019-12-31T14:23:55.234Z' created_by: Alice current: rate_card_id: 92f3080d-27ca-4306-a23f-2430de61851e starting_at: '2020-01-01T00:00:00.000Z' net_payment_terms_days: 7 ending_before: '2022-01-01T00:00:00.000Z' commits: - id: 62c0cb84-bf3f-48b9-9bcf-a8ddf8c1cf35 type: PREPAID name: My test commit description: My test commit description product: id: 2e30f074-d04c-412e-a134-851ebfa5ceb2 name: My product A rollover_fraction: 0.1 applicable_product_ids: - 13a2179b-f0cb-460b-85a1-cd42964ca533 access_schedule: credit_type: id: 2714e483-4ff1-48e4-9e25-ac732e8f24f2 name: USD (cents) schedule_items: - id: 2d45952c-5a6e-43a9-8aab-f61ee21be81a amount: 10000000 starting_at: '2020-02-01T00:00:00.000Z' ending_before: '2021-02-01T00:00:00.000Z' invoice_schedule: credit_type: id: 2714e483-4ff1-48e4-9e25-ac732e8f24f2 name: USD (cents) schedule_items: - id: f15e4e23-f74e-4de4-9b3a-8b07434116c4 invoice_id: 525b9759-7bbd-4a05-aab1-d7c43c976b57 amount: 10000000 unit_price: 10000000 quantity: 1 timestamp: '2020-03-01T00:00:00.000Z' do_not_invoice: false created_at: '2020-01-01T00:00:00.000Z' overrides: - id: 6cf3292a-e85c-4be6-822c-e25ba9d19757 created_at: '2020-01-01T00:00:00.000Z' product: id: eae8903b-693b-41a7-8c0b-f23748c9a9c8 name: My product B starting_at: '2020-01-01T00:00:00.000Z' type: MULTIPLIER multiplier: 0.1 scheduled_charges: - id: 8e511ff1-3fd5-4d86-bc89-1e80239874bf name: My test scheduled charge product: id: 2e30f074-d04c-412e-a134-851ebfa5ceb2 name: My product A schedule: schedule_items: - id: 6ca40ebc-9c01-484e-a64e-4e47fbbd0ebe invoice_id: 5cced82b-5464-41b4-9ea7-3e080e0a4dba amount: 1000000 unit_price: 1000000 quantity: 1 timestamp: '2020-02-15T00:00:00.000Z' scheduled_charges_on_usage_invoices: ALL transitions: - type: RENEWAL from_contract_id: 9bf48856-b430-42f4-844f-4d2ea85bcff8 to_contract_id: d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc reseller_royalties: [] usage_statement_schedule: frequency: MONTHLY billing_anchor_date: '2020-01-01T00:00:00.000Z' created_at: '2019-12-31T14:23:55.234Z' created_by: Alice amendments: - id: 4e2fab26-31ea-473c-b07d-1ce10e7c0146 starting_at: '2020-04-01T00:00:00.000Z' scheduled_charges: - id: 8e511ff1-3fd5-4d86-bc89-1e80239874bf name: My test scheduled charge product: id: 2e30f074-d04c-412e-a134-851ebfa5ceb2 name: My product A schedule: schedule_items: - id: 6ca40ebc-9c01-484e-a64e-4e47fbbd0ebe invoice_id: 5cced82b-5464-41b4-9ea7-3e080e0a4dba amount: 1000000 unit_price: 1000000 quantity: 1 timestamp: '2020-02-15T00:00:00.000Z' commits: [] overrides: [] created_at: '2019-12-31T16:12:45.123Z' created_by: Bob custom_fields: x_account_id: KyVnHhSBWl7eY2bl '404': $ref: '#/components/responses/NotFound' components: schemas: Contract: type: object required: - id - customer_id - initial - current - amendments properties: id: type: string format: uuid archived_at: type: string format: date-time description: >- RFC 3339 timestamp indicating when the contract was archived. If not returned, the contract is not archived. customer_id: type: string format: uuid package_id: type: string format: uuid description: ID of the package this contract was created from, if applicable. uniqueness_key: $ref: '#/components/schemas/UniquenessKey' initial: $ref: '#/components/schemas/ContractWithoutAmendments' current: $ref: '#/components/schemas/ContractWithoutAmendments' amendments: type: array items: $ref: '#/components/schemas/ContractAmendment' custom_fields: $ref: '#/components/schemas/CustomField' x-cf-entity: contract customer_billing_provider_configuration: type: object description: The billing provider configuration associated with a contract. required: - billing_provider - delivery_method - archived_at properties: billing_provider: $ref: '#/components/schemas/BillingProviderType' delivery_method: $ref: '#/components/schemas/BillingProviderDeliveryMethodType' id: type: string format: uuid configuration: type: object additionalProperties: true description: >- Configuration for the billing provider. The structure of this object is specific to the billing provider. archived_at: type: string format: date-time nullable: true scheduled_charges_on_usage_invoices: $ref: '#/components/schemas/ScheduledChargesOnUsageInvoices' subscriptions: $ref: '#/components/schemas/Subscriptions' spend_threshold_configuration: $ref: '#/components/schemas/SpendThresholdConfiguration' prepaid_balance_threshold_configuration: $ref: '#/components/schemas/PrepaidBalanceThresholdConfiguration' UniquenessKey: type: string minLength: 1 maxLength: 128 description: >- 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. ContractWithoutAmendments: type: object required: - starting_at - commits - overrides - scheduled_charges - transitions - created_at - created_by - usage_statement_schedule properties: name: type: string salesforce_opportunity_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. rate_card_id: type: string format: uuid starting_at: type: string format: date-time commits: type: array items: $ref: '#/components/schemas/Commit' credits: type: array items: $ref: '#/components/schemas/Credit' recurring_commits: type: array items: $ref: '#/components/schemas/RecurringCommit' recurring_credits: type: array items: $ref: '#/components/schemas/RecurringCredit' overrides: type: array items: $ref: '#/components/schemas/Override' discounts: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: array description: This field's availability is dependent on your client's items: $ref: '#/components/schemas/Discount' professional_services: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: array description: >- This field's availability is dependent on your client's configuration. items: $ref: '#/components/schemas/ProService' scheduled_charges: type: array items: $ref: '#/components/schemas/ScheduledCharge' scheduled_charges_on_usage_invoices: $ref: '#/components/schemas/ScheduledChargesOnUsageInvoices' transitions: type: array items: $ref: '#/components/schemas/ContractTransition' reseller_royalties: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: array description: >- This field's availability is dependent on your client's configuration. items: $ref: '#/components/schemas/ResellerRoyalty' created_at: type: string format: date-time created_by: type: string netsuite_sales_order_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. net_payment_terms_days: type: number ending_before: type: string format: date-time total_contract_value: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: number description: >- This field's availability is dependent on your client's configuration. usage_filter: $ref: '#/components/schemas/UsageFilter' usage_statement_schedule: $ref: '#/components/schemas/UsageStatementSchedule' spend_threshold_configuration: $ref: '#/components/schemas/SpendThresholdConfiguration' prepaid_balance_threshold_configuration: $ref: '#/components/schemas/PrepaidBalanceThresholdConfiguration' hierarchy_configuration: $ref: '#/components/schemas/HierarchyConfiguration' ContractAmendment: type: object required: - id - starting_at - commits - overrides - scheduled_charges - created_at - created_by properties: id: type: string format: uuid salesforce_opportunity_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. starting_at: type: string format: date-time commits: type: array items: $ref: '#/components/schemas/Commit' credits: type: array items: $ref: '#/components/schemas/Credit' overrides: type: array items: $ref: '#/components/schemas/Override' discounts: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: array description: >- This field's availability is dependent on your client's configuration. items: $ref: '#/components/schemas/Discount' professional_services: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: array description: >- This field's availability is dependent on your client's configuration. items: $ref: '#/components/schemas/ProService' scheduled_charges: type: array items: $ref: '#/components/schemas/ScheduledCharge' reseller_royalties: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: array description: >- This field's availability is dependent on your client's configuration. items: $ref: '#/components/schemas/ResellerRoyaltyOrUpdate' created_at: type: string format: date-time created_by: type: string netsuite_sales_order_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. CustomField: type: object description: 'Custom fields to be added eg. { "key1": "value1", "key2": "value2" }' additionalProperties: type: string BillingProviderType: type: string enum: - aws_marketplace - stripe - netsuite - custom - azure_marketplace - quickbooks_online - workday - gcp_marketplace - metronome x-mint-enum: netsuite: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf custom: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf workday: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf gcp_marketplace: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf BillingProviderDeliveryMethodType: type: string enum: - direct_to_billing_provider - aws_sqs - tackle - aws_sns ScheduledChargesOnUsageInvoices: type: string description: >- 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. enum: - ALL Subscriptions: type: array description: List of subscriptions on the contract. items: $ref: '#/components/schemas/Subscription' SpendThresholdConfiguration: type: object required: - is_enabled - threshold_amount - commit - payment_gate_config properties: is_enabled: type: boolean description: >- 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. threshold_amount: description: >- Specify the threshold amount for the contract. Each time the contract's usage hits this amount, a threshold charge will be initiated. type: number commit: $ref: '#/components/schemas/SpendThresholdCommit' payment_gate_config: $ref: '#/components/schemas/PaymentGateConfig' discount_configuration: $ref: '#/components/schemas/DiscountConfiguration' x-mint: groups: - ff:threshold-billing-discounts PrepaidBalanceThresholdConfiguration: type: object required: - is_enabled - threshold_amount - recharge_to_amount - commit - payment_gate_config properties: is_enabled: type: boolean description: >- 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. threshold_amount: description: >- Specify the threshold amount for the contract. Each time the contract's prepaid balance lowers to this amount, a threshold charge will be initiated. type: number recharge_to_amount: description: Specify the amount the balance should be recharged to. type: number custom_credit_type_id: description: >- 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. type: string format: uuid commit: $ref: '#/components/schemas/PrepaidBalanceThresholdCommit' payment_gate_config: $ref: '#/components/schemas/PaymentGateConfig' discount_configuration: $ref: '#/components/schemas/DiscountConfiguration' x-mint: groups: - ff:threshold-billing-discounts Error: required: - message type: object properties: message: type: string Commit: type: object required: - id - type - product - created_at properties: id: type: string format: uuid contract: required: - id type: object properties: id: type: string format: uuid type: type: string enum: - PREPAID - POSTPAID rate_type: type: string enum: - COMMIT_RATE - LIST_RATE name: type: string priority: type: number description: >- If multiple credits or commits are applicable, the one with the lower priority will apply first. product: type: object required: - id - name properties: id: type: string format: uuid name: type: string access_schedule: $ref: '#/components/schemas/ScheduleDuration' description: >- The schedule that the customer will gain access to the credits purposed with this commit. invoice_schedule: $ref: '#/components/schemas/SchedulePointInTime' description: The schedule that the customer will be invoiced for this commit. invoice_contract: type: object required: - id properties: id: type: string format: uuid description: The contract that this commit will be billed on. recurring_commit_id: type: string format: uuid description: >- The ID of the recurring commit that this commit was generated from, if applicable. subscription_config: type: object properties: subscription_id: type: string format: uuid allocation: $ref: '#/components/schemas/SubscriptionConfigAllocation' apply_seat_increase_config: $ref: '#/components/schemas/ApplySeatIncreaseConfigForRecurringCommit' description: >- The subscription configuration for this commit, if it was generated from a recurring commit with a subscription attached. rolled_over_from: type: object required: - contract_id - commit_id properties: commit_id: type: string format: uuid contract_id: type: string format: uuid description: type: string rollover_fraction: type: number applicable_product_ids: type: array items: type: string format: uuid applicable_product_tags: type: array items: type: string specifiers: type: array description: >- 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. items: $ref: '#/components/schemas/CommitSpecifier' applicable_contract_ids: type: array items: type: string format: uuid netsuite_sales_order_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. amount: type: number description: (DEPRECATED) Use access_schedule + invoice_schedule instead. salesforce_opportunity_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. ledger: type: array items: $ref: '#/components/schemas/CommitLedger' description: >- A list of ordered events that impact the balance of a commit. For example, an invoice deduction or a rollover. balance: $ref: '#/components/schemas/BalanceForCommitsAndCredits' custom_fields: $ref: '#/components/schemas/CustomField' x-cf-entity: commit uniqueness_key: $ref: '#/components/schemas/UniquenessKeyForCommitsAndCredits' archived_at: type: string format: date-time description: >- RFC 3339 timestamp indicating when the commit was archived. If not provided, the commit is not archived. hierarchy_configuration: $ref: '#/components/schemas/CommitHierarchyConfiguration' description: Optional configuration for commit hierarchy access control created_at: type: string format: date-time description: > 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 Credit: type: object required: - id - type - product properties: id: type: string format: uuid contract: required: - id type: object properties: id: type: string format: uuid type: type: string enum: - CREDIT name: type: string priority: type: number description: >- If multiple credits or commits are applicable, the one with the lower priority will apply first. product: type: object required: - id - name properties: id: type: string format: uuid name: type: string access_schedule: $ref: '#/components/schemas/ScheduleDuration' description: The schedule that the customer will gain access to the credits. description: type: string recurring_credit_id: type: string format: uuid description: >- The ID of the recurring credit that this credit was generated from, if applicable. subscription_config: type: object properties: subscription_id: type: string format: uuid allocation: $ref: '#/components/schemas/SubscriptionConfigAllocation' apply_seat_increase_config: $ref: '#/components/schemas/ApplySeatIncreaseConfigForRecurringCommit' description: >- The subscription configuration for this credit, if it was generated from a recurring credit with a subscription attached. applicable_product_ids: type: array items: type: string format: uuid applicable_product_tags: type: array items: type: string specifiers: type: array description: >- 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. items: $ref: '#/components/schemas/CommitSpecifier' applicable_contract_ids: type: array items: type: string format: uuid netsuite_sales_order_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. salesforce_opportunity_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. ledger: type: array items: $ref: '#/components/schemas/CreditLedger' description: >- A list of ordered events that impact the balance of a credit. For example, an invoice deduction or an expiration. balance: $ref: '#/components/schemas/BalanceForCommitsAndCredits' custom_fields: $ref: '#/components/schemas/CustomField' x-cf-entity: contract_credit rate_type: type: string enum: - COMMIT_RATE - LIST_RATE uniqueness_key: $ref: '#/components/schemas/UniquenessKeyForCommitsAndCredits' hierarchy_configuration: $ref: '#/components/schemas/CommitHierarchyConfiguration' description: Optional configuration for credit hierarchy access control rolled_over_from: type: object required: - contract_id - credit_id properties: credit_id: type: string format: uuid contract_id: type: string format: uuid RecurringCommit: allOf: - $ref: '#/components/schemas/RecurringCredit' - type: object properties: invoice_amount: type: object required: - unit_price - quantity - credit_type_id properties: unit_price: type: number quantity: type: number credit_type_id: type: string format: uuid description: >- The amount the customer should be billed for the commit. Not required. RecurringCredit: type: object required: - id - product - access_amount - priority - commit_duration - starting_at - rate_type properties: id: type: string format: uuid contract: required: - id type: object properties: id: type: string format: uuid name: type: string description: >- Displayed on invoices. Will be passed through to the individual commits product: type: object required: - id - name properties: id: type: string format: uuid name: type: string access_amount: type: object required: - unit_price - credit_type_id properties: unit_price: type: number quantity: type: number credit_type_id: type: string format: uuid description: The amount of commit to grant. description: type: string description: Will be passed down to the individual commits rollover_fraction: type: number description: >- 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. priority: type: number description: Will be passed down to the individual commits applicable_product_ids: type: array items: type: string format: uuid description: Will be passed down to the individual commits applicable_product_tags: type: array items: type: string description: Will be passed down to the individual commits specifiers: type: array description: >- 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. items: $ref: '#/components/schemas/CommitSpecifier' netsuite_sales_order_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: Will be passed down to the individual commits rate_type: type: string enum: - COMMIT_RATE - commit_rate - LIST_RATE - list_rate description: Whether the created commits will use the commit rate or list rate starting_at: type: string format: date-time description: Determines the start time for the first commit ending_before: type: string format: date-time description: >- Determines when the contract will stop creating recurring commits. Optional commit_duration: type: object required: - value properties: value: type: number unit: type: string enum: - periods - PERIODS description: The amount of time the created commits will be valid for recurrence_frequency: type: string enum: - MONTHLY - monthly - QUARTERLY - quarterly - ANNUAL - annual - WEEKLY - weekly description: >- 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. proration: type: string enum: - NONE - none - FIRST - first - LAST - last - FIRST_AND_LAST - first_and_last description: >- 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). subscription_config: $ref: '#/components/schemas/RecurringCommitSubscriptionConfig' description: Attach a subscription to the recurring commit/credit. hierarchy_configuration: $ref: '#/components/schemas/CommitHierarchyConfiguration' description: >- Optional configuration for recurring commit/credit hierarchy access control Override: type: object required: - id - created_at - starting_at properties: id: type: string format: uuid created_at: type: string format: date-time product: type: object required: - id - name properties: id: type: string format: uuid name: type: string applicable_product_tags: type: array items: type: string override_specifiers: type: array items: $ref: '#/components/schemas/OverrideSpecifier' starting_at: type: string format: date-time ending_before: type: string format: date-time entitled: type: boolean type: type: string enum: - OVERWRITE - MULTIPLIER - TIERED priority: type: number multiplier: type: number overwrite_rate: $ref: '#/components/schemas/OverwriteRate' override_tiers: type: array items: $ref: '#/components/schemas/OverrideTier' is_commit_specific: type: boolean target: type: string enum: - COMMIT_RATE - LIST_RATE rate_type: type: string enum: - FLAT - flat - PERCENTAGE - percentage - SUBSCRIPTION - subscription - TIERED - tiered - TIERED_PERCENTAGE - tiered_percentage - CUSTOM - custom x-mint-enum: CUSTOM: - client_id:5b9e3072-415b-4842-94f0-0b6700c8b6be - client_id:179e395f-5349-4fe2-bf12-64ab4e5bc560 - client_id:f157d376-0781-4ef3-9db9-775a9052148e - client_id:7dd2f652-7629-4925-9069-77f5c5d3db37 - client_id:c0ce3dc0-6d3e-4f6b-aadf-dfb90f2bf9f5 - client_id:cf874b25-ca3b-460b-b6fe-5f33b3c2ea33 - client_id:97c07a0c-70db-448a-a1d4-adcd2b8bd1c7 custom: - client_id:5b9e3072-415b-4842-94f0-0b6700c8b6be - client_id:179e395f-5349-4fe2-bf12-64ab4e5bc560 - client_id:f157d376-0781-4ef3-9db9-775a9052148e - client_id:7dd2f652-7629-4925-9069-77f5c5d3db37 - client_id:c0ce3dc0-6d3e-4f6b-aadf-dfb90f2bf9f5 - client_id:cf874b25-ca3b-460b-b6fe-5f33b3c2ea33 - client_id:97c07a0c-70db-448a-a1d4-adcd2b8bd1c7 SUBSCRIPTION: - ff:legacy-subscriptions-enabled subscription: - ff:legacy-subscriptions-enabled TIERED_PERCENTAGE: - ff:support-charge-ga tiered_percentage: - ff:support-charge-ga price: type: number description: >- 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. quantity: type: number x-mint: groups: - ff:legacy-subscriptions-enabled description: Default quantity. For SUBSCRIPTION rate_type, this must be >=0. is_prorated: type: boolean x-mint: groups: - ff:legacy-subscriptions-enabled description: >- Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true. tiers: type: array items: $ref: '#/components/schemas/Tier' description: Only set for TIERED rate_type. value: type: object additionalProperties: true description: >- Only set for CUSTOM rate_type. This field is interpreted by custom rate processors. credit_type: $ref: '#/components/schemas/CreditType' Discount: type: object required: - id - product - schedule properties: id: type: string format: uuid product: type: object required: - id - name properties: id: type: string format: uuid name: type: string schedule: $ref: '#/components/schemas/SchedulePointInTime' name: type: string minLength: 1 netsuite_sales_order_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. custom_fields: $ref: '#/components/schemas/CustomField' x-cf-entity: discount ProService: type: object required: - id - product_id - unit_price - quantity - max_amount properties: id: type: string format: uuid description: type: string product_id: type: string format: uuid netsuite_sales_order_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. unit_price: type: number description: >- Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified. quantity: type: number description: >- Quantity for the charge. Will be multiplied by unit_price to determine the amount. max_amount: type: number description: Maximum amount for the term. custom_fields: $ref: '#/components/schemas/CustomField' x-cf-entity: professional_service ScheduledCharge: type: object required: - id - product - schedule properties: id: type: string format: uuid product: type: object required: - id - name properties: id: type: string format: uuid name: type: string schedule: $ref: '#/components/schemas/SchedulePointInTime' name: type: string minLength: 1 description: displayed on invoices netsuite_sales_order_id: x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 type: string description: >- This field's availability is dependent on your client's configuration. custom_fields: $ref: '#/components/schemas/CustomField' x-cf-entity: scheduled_charge archived_at: type: string format: date-time ContractTransition: type: object required: - type - from_contract_id - to_contract_id properties: type: type: string enum: - SUPERSEDE - RENEWAL from_contract_id: type: string format: uuid to_contract_id: type: string format: uuid ResellerRoyalty: type: object required: - reseller_type - starting_at - fraction - netsuite_reseller_id properties: reseller_type: $ref: '#/components/schemas/ResellerType' fraction: type: number applicable_product_tags: type: array items: type: string applicable_product_ids: type: array items: type: string netsuite_reseller_id: type: string starting_at: type: string format: date-time ending_before: type: string format: date-time reseller_contract_value: type: number aws_account_number: type: string aws_payer_reference_id: type: string aws_offer_id: type: string gcp_account_id: type: string gcp_offer_id: type: string UsageFilter: type: object required: - initial - current - updates properties: initial: $ref: '#/components/schemas/BaseUsageFilter' current: $ref: '#/components/schemas/BaseUsageFilter' nullable: true updates: type: array items: $ref: '#/components/schemas/BaseUsageFilterWithRequiredStartingAt' UsageStatementSchedule: type: object required: - frequency - billing_anchor_date properties: frequency: type: string enum: - MONTHLY - monthly - QUARTERLY - quarterly - ANNUAL - annual - WEEKLY - weekly billing_anchor_date: type: string format: date-time description: >- Contract usage statements follow a selected cadence based on this date. HierarchyConfiguration: oneOf: - $ref: '#/components/schemas/ParentHierarchyConfiguration' - $ref: '#/components/schemas/ChildHierarchyConfiguration' description: > Either a **parent** configuration with a list of children or a **child** configuration with a single parent. ResellerRoyaltyOrUpdate: type: object required: - reseller_type properties: reseller_type: $ref: '#/components/schemas/ResellerType' fraction: type: number netsuite_reseller_id: type: string starting_at: type: string format: date-time ending_before: type: string format: date-time nullable: true reseller_contract_value: type: number aws_account_number: type: string aws_payer_reference_id: type: string aws_offer_id: type: string gcp_account_id: type: string gcp_offer_id: type: string Subscription: required: - subscription_rate - collection_schedule - proration - quantity_schedule - starting_at - quantity_management_mode - billing_periods type: object properties: id: type: string format: uuid subscription_rate: $ref: '#/components/schemas/SubscriptionRate' name: type: string description: type: string collection_schedule: type: string enum: - ADVANCE - ARREARS - advance - arrears proration: $ref: '#/components/schemas/SubscriptionProration' quantity_schedule: type: array description: >- List of quantity schedule items for the subscription. Only includes the current quantity and future quantity changes. items: $ref: '#/components/schemas/SubscriptionQuantitySchedule' billing_periods: $ref: '#/components/schemas/SubscriptionBillingPeriods' quantity_management_mode: type: string enum: - SEAT_BASED - seat_based - QUANTITY_ONLY - quantity_only description: >- 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. seat_config: $ref: '#/components/schemas/SubscriptionSeatConfig' starting_at: type: string format: date-time ending_before: type: string format: date-time fiat_credit_type_id: type: string format: uuid custom_fields: $ref: '#/components/schemas/CustomField' x-cf-entity: subscription SpendThresholdCommit: type: object allOf: - $ref: '#/components/schemas/BaseThresholdCommit' PaymentGateConfig: type: object required: - payment_gate_type properties: payment_gate_type: type: string enum: - NONE - STRIPE - EXTERNAL description: >- 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. tax_type: type: string enum: - NONE - STRIPE - ANROK - PRECALCULATED description: >- 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. stripe_config: description: Only applicable if using STRIPE as your payment gate type. type: object required: - payment_type properties: payment_type: type: string enum: - INVOICE - PAYMENT_INTENT description: If left blank, will default to INVOICE invoice_metadata: type: object additionalProperties: type: string description: >- Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as your payment type. precalculated_tax_config: description: Only applicable if using PRECALCULATED as your tax type. type: object required: - tax_amount properties: tax_amount: type: number description: >- Amount of tax to be applied. This should be in the same currency and denomination as the commit's invoice schedule tax_name: type: string description: >- Name of the tax to be applied. This may be used in an invoice line item description. DiscountConfiguration: type: object required: - payment_fraction properties: payment_fraction: type: number description: >- The fraction of the original amount that the customer pays after applying the discount. For example, 0.85 means the customer pays 85% of the original amount (a 15% discount). PrepaidBalanceThresholdCommit: type: object allOf: - $ref: '#/components/schemas/BaseThresholdCommit' - type: object properties: applicable_product_ids: type: array items: type: string format: uuid description: >- Which products the threshold commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products. applicable_product_tags: type: array items: type: string description: >- 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. specifiers: x-mint: groups: - ff:commit-specifiers type: array description: >- List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`. items: $ref: '#/components/schemas/CommitSpecifierInput' ScheduleDuration: type: object required: - schedule_items properties: credit_type: $ref: '#/components/schemas/CreditType' schedule_items: type: array items: type: object required: - id - amount - starting_at - ending_before properties: id: type: string format: uuid amount: type: number starting_at: type: string format: date-time ending_before: type: string format: date-time SchedulePointInTime: type: object properties: credit_type: $ref: '#/components/schemas/CreditType' schedule_items: type: array items: type: object required: - id - amount - unit_price - quantity - timestamp properties: id: type: string format: uuid invoice_id: type: string format: uuid nullable: true amount: type: number unit_price: type: number quantity: type: number timestamp: type: string format: date-time do_not_invoice: type: boolean description: >- This field is only applicable to commit invoice schedules. If true, this schedule will not generate an invoice. default: false SubscriptionConfigAllocation: type: string enum: - INDIVIDUAL - POOLED ApplySeatIncreaseConfigForRecurringCommit: type: object required: - is_prorated properties: is_prorated: type: boolean description: Indicates whether a mid-period seat increase should be prorated. CommitSpecifier: type: object properties: product_id: type: string format: uuid description: >- If provided, the specifier will only apply to the product with the specified ID. product_tags: type: array items: type: string description: >- If provided, the specifier will only apply to products with all the specified tags. pricing_group_values: type: object additionalProperties: type: string presentation_group_values: type: object additionalProperties: type: string exclude: x-stainless-skip: true x-mint: groups: - ff:exclude-specifiers-ga type: array description: >- If provided, the specifier will not apply to product usage that matches the inclusion criteria and any of the excluding values. items: $ref: '#/components/schemas/ExcludeSpecifier' CommitLedger: oneOf: - $ref: '#/components/schemas/PrepaidCommitSegmentStartLedgerEntry' - $ref: >- #/components/schemas/PrepaidCommitAutomatedInvoiceDeductionLedgerEntry - $ref: '#/components/schemas/PrepaidCommitRolloverLedgerEntry' - $ref: '#/components/schemas/PrepaidCommitExpirationLedgerEntry' - $ref: '#/components/schemas/PrepaidCommitCanceledLedgerEntry' x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 - $ref: '#/components/schemas/PrepaidCommitCreditedLedgerEntry' x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 - $ref: '#/components/schemas/PrepaidCommitSeatBasedAdjustmentLedgerEntry' - $ref: '#/components/schemas/PostpaidCommitInitialBalanceLedgerEntry' - $ref: >- #/components/schemas/PostpaidCommitAutomatedInvoiceDeductionLedgerEntry - $ref: '#/components/schemas/PostpaidCommitRolloverLedgerEntry' - $ref: '#/components/schemas/PostpaidCommitTrueupLedgerEntry' - $ref: '#/components/schemas/PrepaidCommitManualLedgerEntry' - $ref: '#/components/schemas/PostpaidCommitManualLedgerEntry' - $ref: '#/components/schemas/PostpaidCommitExpirationLedgerEntry' BalanceForCommitsAndCredits: type: number description: >- 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. UniquenessKeyForCommitsAndCredits: type: string minLength: 1 maxLength: 128 description: >- 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. CommitHierarchyConfiguration: type: object required: - child_access properties: child_access: oneOf: - $ref: '#/components/schemas/CommitHierarchyChildAccessAll' - $ref: '#/components/schemas/CommitHierarchyChildAccessNone' - $ref: '#/components/schemas/CommitHierarchyChildAccessContractIds' CreditLedger: oneOf: - $ref: '#/components/schemas/CreditSegmentStartLedgerEntry' - $ref: '#/components/schemas/CreditAutomatedInvoiceDeductionLedgerEntry' - $ref: '#/components/schemas/CreditExpirationLedgerEntry' - $ref: '#/components/schemas/CreditCanceledLedgerEntry' x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 - $ref: '#/components/schemas/CreditCreditedLedgerEntry' x-mint: groups: - client_id:e3147d6d-4101-4cd1-9888-ce3afeeac5b2 - $ref: '#/components/schemas/CreditManualLedgerEntry' - $ref: '#/components/schemas/CreditSeatBasedAdjustmentLedgerEntry' - $ref: '#/components/schemas/CreditRolloverLedgerEntry' RecurringCommitSubscriptionConfig: type: object required: - allocation - apply_seat_increase_config - subscription_id properties: allocation: $ref: '#/components/schemas/SubscriptionConfigAllocation' apply_seat_increase_config: $ref: '#/components/schemas/ApplySeatIncreaseConfigForRecurringCommit' subscription_id: type: string format: uuid OverrideSpecifier: type: object properties: product_id: type: string format: uuid product_tags: type: array items: type: string pricing_group_values: type: object additionalProperties: type: string presentation_group_values: type: object additionalProperties: type: string nullable: true commit_ids: type: array items: type: string recurring_commit_ids: type: array items: type: string billing_frequency: type: string enum: - MONTHLY - QUARTERLY - ANNUAL - WEEKLY - monthly - quarterly - annual - weekly exclude: x-stainless-skip: true x-mint: groups: - ff:exclude-specifiers-ga type: array description: >- If provided, the specifier will not apply to product usage that matches the inclusion criteria and any of the excluding values. items: $ref: '#/components/schemas/ExcludeSpecifier' OverwriteRate: type: object required: - rate_type properties: rate_type: type: string enum: - FLAT - flat - PERCENTAGE - percentage - SUBSCRIPTION - subscription - TIERED - tiered - TIERED_PERCENTAGE - tiered_percentage - CUSTOM - custom x-mint-enum: CUSTOM: - client_id:5b9e3072-415b-4842-94f0-0b6700c8b6be - client_id:179e395f-5349-4fe2-bf12-64ab4e5bc560 - client_id:f157d376-0781-4ef3-9db9-775a9052148e - client_id:7dd2f652-7629-4925-9069-77f5c5d3db37 - client_id:c0ce3dc0-6d3e-4f6b-aadf-dfb90f2bf9f5 - client_id:cf874b25-ca3b-460b-b6fe-5f33b3c2ea33 - client_id:97c07a0c-70db-448a-a1d4-adcd2b8bd1c7 custom: - client_id:5b9e3072-415b-4842-94f0-0b6700c8b6be - client_id:179e395f-5349-4fe2-bf12-64ab4e5bc560 - client_id:f157d376-0781-4ef3-9db9-775a9052148e - client_id:7dd2f652-7629-4925-9069-77f5c5d3db37 - client_id:c0ce3dc0-6d3e-4f6b-aadf-dfb90f2bf9f5 - client_id:cf874b25-ca3b-460b-b6fe-5f33b3c2ea33 - client_id:97c07a0c-70db-448a-a1d4-adcd2b8bd1c7 SUBSCRIPTION: - ff:legacy-subscriptions-enabled subscription: - ff:legacy-subscriptions-enabled TIERED_PERCENTAGE: - ff:support-charge-ga tiered_percentage: - ff:support-charge-ga price: type: number description: >- 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. quantity: type: number x-mint: groups: - ff:legacy-subscriptions-enabled description: Default quantity. For SUBSCRIPTION rate_type, this must be >=0. is_prorated: type: boolean x-mint: groups: - ff:legacy-subscriptions-enabled description: >- Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true. tiers: type: array items: $ref: '#/components/schemas/Tier' description: Only set for TIERED rate_type. minimum_config: $ref: '#/components/schemas/MinimumConfig' x-stainless-skip: true x-mint: groups: - ff:support-charge-ga custom_rate: x-mint: groups: - client_id:5b9e3072-415b-4842-94f0-0b6700c8b6be - client_id:179e395f-5349-4fe2-bf12-64ab4e5bc560 - client_id:f157d376-0781-4ef3-9db9-775a9052148e - client_id:7dd2f652-7629-4925-9069-77f5c5d3db37 - client_id:c0ce3dc0-6d3e-4f6b-aadf-dfb90f2bf9f5 - client_id:cf874b25-ca3b-460b-b6fe-5f33b3c2ea33 - client_id:97c07a0c-70db-448a-a1d4-adcd2b8bd1c7 type: object additionalProperties: true description: >- Only set for CUSTOM rate_type. This field is interpreted by custom rate processors. credit_type: $ref: '#/components/schemas/CreditType' OverrideTier: type: object required: - multiplier properties: size: type: number multiplier: type: number Tier: type: object required: - price properties: size: type: number price: type: number CreditType: required: - name - id type: object properties: name: type: string id: type: string format: uuid ResellerType: type: string enum: - AWS - AWS_PRO_SERVICE - GCP - GCP_PRO_SERVICE BaseUsageFilter: type: object required: - group_key - group_values properties: group_key: type: string group_values: type: array items: type: string starting_at: type: string format: date-time BaseUsageFilterWithRequiredStartingAt: type: object required: - group_key - group_values - starting_at properties: group_key: type: string group_values: type: array items: type: string starting_at: type: string format: date-time ParentHierarchyConfiguration: type: object required: - children properties: children: type: array items: $ref: '#/components/schemas/HierarchyLink' description: List of contracts that belong to this parent. parent_behavior: type: object properties: invoice_consolidation_type: type: string enum: - CONCATENATE - NONE description: >- Indicates the desired behavior of consolidated invoices generated by the parent in a customer hierarchy **CONCATENATE**: Statements on the invoices of child customers will be appended to the consolidated invoice **NONE**: Do not generate consolidated invoices ChildHierarchyConfiguration: type: object required: - parent properties: parent: $ref: '#/components/schemas/HierarchyLink' description: The single parent contract/customer for this child. payer: type: string enum: - SELF - PARENT description: |- Indicates which customer should pay for the child's invoice charges **SELF**: The child pays for its own invoice charges **PARENT**: The parent pays for the child's invoice charges usage_statement_behavior: type: string enum: - CONSOLIDATE - SEPARATE description: >- Indicates the behavior of the child's invoice statements on the parent's invoices. **CONSOLIDATE**: Child's invoice statements will be added to parent's consolidated invoices **SEPARATE**: Child's invoice statements will appear not appear on parent's consolidated invoices SubscriptionRate: type: object required: - billing_frequency - product properties: billing_frequency: type: string enum: - MONTHLY - QUARTERLY - ANNUAL - WEEKLY - monthly - quarterly - annual - weekly product: type: object required: - id - name properties: id: type: string format: uuid name: type: string SubscriptionProration: type: object required: - is_prorated - invoice_behavior properties: is_prorated: type: boolean invoice_behavior: type: string enum: - BILL_IMMEDIATELY - BILL_ON_NEXT_COLLECTION_DATE - bill_immediately - bill_on_next_collection_date SubscriptionQuantitySchedule: type: object required: - quantity - starting_at properties: quantity: type: number starting_at: type: string format: date-time ending_before: type: string format: date-time SubscriptionBillingPeriods: type: object description: Previous, current, and next billing periods for the subscription. properties: previous: $ref: '#/components/schemas/SubscriptionBillingPeriod' current: $ref: '#/components/schemas/SubscriptionBillingPeriod' next: $ref: '#/components/schemas/SubscriptionBillingPeriod' SubscriptionSeatConfig: type: object required: - seat_group_key properties: seat_group_key: type: string description: >- 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. BaseThresholdCommit: type: object required: - product_id properties: product_id: type: string description: >- The commit product that will be used to generate the line item for commit payment. name: type: string description: >- Specify the name of the line item for the threshold charge. If left blank, it will default to the commit product name. description: type: string priority: type: number description: >- The priority of the commit, used to determine drawdown order. Lower priority commits are consumed first. Defaults to 100 if not specified. CommitSpecifierInput: type: object properties: product_id: type: string format: uuid description: >- If provided, the specifier will only apply to the product with the specified ID. product_tags: type: array items: type: string description: >- If provided, the specifier will only apply to products with all the specified tags. pricing_group_values: type: object additionalProperties: type: string description: >- If provided, the specifier will apply to product usage with these set of pricing group values. presentation_group_values: type: object additionalProperties: type: string description: >- If provided, the specifier will apply to product usage with these set of presentation group values. exclude: x-stainless-skip: true x-mint: groups: - ff:exclude-specifiers-ga type: array description: >- If provided, the specifier will not apply to product usage that matches the inclusion criteria and any of the excluding values. items: $ref: '#/components/schemas/ExcludeSpecifier' ExcludeSpecifier: type: object properties: product_tags: type: array items: type: string description: >- If provided, the specifier will not apply to products with all the specified tags. PrepaidCommitSegmentStartLedgerEntry: type: object required: - type - timestamp - amount - segment_id properties: type: type: string enum: - PREPAID_COMMIT_SEGMENT_START timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid PrepaidCommitAutomatedInvoiceDeductionLedgerEntry: type: object required: - type - timestamp - amount - invoice_id - segment_id properties: type: type: string enum: - PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid invoice_id: type: string format: uuid contract_id: x-mint: groups: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf type: string format: uuid PrepaidCommitRolloverLedgerEntry: type: object required: - type - timestamp - amount - new_contract_id - segment_id properties: type: type: string enum: - PREPAID_COMMIT_ROLLOVER timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid new_contract_id: type: string format: uuid PrepaidCommitExpirationLedgerEntry: type: object required: - type - timestamp - amount - segment_id properties: type: type: string enum: - PREPAID_COMMIT_EXPIRATION timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid PrepaidCommitCanceledLedgerEntry: type: object required: - type - timestamp - amount - invoice_id - segment_id properties: type: type: string enum: - PREPAID_COMMIT_CANCELED timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid invoice_id: type: string format: uuid contract_id: x-mint: groups: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf type: string format: uuid PrepaidCommitCreditedLedgerEntry: type: object required: - type - timestamp - amount - invoice_id - segment_id properties: type: type: string enum: - PREPAID_COMMIT_CREDITED timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid invoice_id: type: string format: uuid contract_id: x-mint: groups: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf type: string format: uuid PrepaidCommitSeatBasedAdjustmentLedgerEntry: type: object required: - type - timestamp - amount - segment_id properties: type: type: string enum: - PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid PostpaidCommitInitialBalanceLedgerEntry: type: object required: - type - timestamp - amount properties: type: type: string enum: - POSTPAID_COMMIT_INITIAL_BALANCE timestamp: type: string format: date-time amount: type: number PostpaidCommitAutomatedInvoiceDeductionLedgerEntry: type: object required: - type - timestamp - amount - invoice_id - segment_id properties: type: type: string enum: - POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid invoice_id: type: string format: uuid contract_id: x-mint: groups: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf type: string format: uuid PostpaidCommitRolloverLedgerEntry: type: object required: - type - timestamp - amount - new_contract_id - segment_id properties: type: type: string enum: - POSTPAID_COMMIT_ROLLOVER timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid new_contract_id: type: string format: uuid PostpaidCommitTrueupLedgerEntry: type: object required: - type - timestamp - amount - invoice_id properties: type: type: string enum: - POSTPAID_COMMIT_TRUEUP timestamp: type: string format: date-time amount: type: number invoice_id: type: string format: uuid contract_id: x-mint: groups: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf type: string format: uuid PrepaidCommitManualLedgerEntry: type: object required: - type - timestamp - amount - reason properties: type: type: string enum: - PREPAID_COMMIT_MANUAL timestamp: type: string format: date-time amount: type: number reason: type: string PostpaidCommitManualLedgerEntry: type: object required: - type - timestamp - amount - reason properties: type: type: string enum: - POSTPAID_COMMIT_MANUAL timestamp: type: string format: date-time amount: type: number reason: type: string PostpaidCommitExpirationLedgerEntry: type: object required: - type - timestamp - amount properties: type: type: string enum: - POSTPAID_COMMIT_EXPIRATION timestamp: type: string format: date-time amount: type: number CommitHierarchyChildAccessAll: type: object required: - type properties: type: type: string enum: - ALL - all CommitHierarchyChildAccessNone: type: object required: - type properties: type: type: string enum: - NONE - none CommitHierarchyChildAccessContractIds: type: object required: - type - contract_ids properties: type: type: string enum: - CONTRACT_IDS - contract_ids contract_ids: type: array minItems: 1 items: type: string format: uuid CreditSegmentStartLedgerEntry: type: object required: - type - timestamp - amount - segment_id properties: type: type: string enum: - CREDIT_SEGMENT_START timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid CreditAutomatedInvoiceDeductionLedgerEntry: type: object required: - type - timestamp - amount - invoice_id - segment_id properties: type: type: string enum: - CREDIT_AUTOMATED_INVOICE_DEDUCTION timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid invoice_id: type: string format: uuid contract_id: x-mint: groups: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf type: string format: uuid CreditExpirationLedgerEntry: type: object required: - type - timestamp - amount - segment_id properties: type: type: string enum: - CREDIT_EXPIRATION timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid CreditCanceledLedgerEntry: type: object required: - type - timestamp - amount - invoice_id - segment_id properties: type: type: string enum: - CREDIT_CANCELED timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid invoice_id: type: string format: uuid contract_id: x-mint: groups: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf type: string format: uuid CreditCreditedLedgerEntry: type: object required: - type - timestamp - amount - invoice_id - segment_id properties: type: type: string enum: - CREDIT_CREDITED timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid invoice_id: type: string format: uuid contract_id: x-mint: groups: - client_id:11db091c-975b-4908-9f67-b1ceb126acdf type: string format: uuid CreditManualLedgerEntry: type: object required: - type - timestamp - amount - reason properties: type: type: string enum: - CREDIT_MANUAL timestamp: type: string format: date-time amount: type: number reason: type: string CreditSeatBasedAdjustmentLedgerEntry: type: object required: - type - timestamp - amount - segment_id properties: type: type: string enum: - CREDIT_SEAT_BASED_ADJUSTMENT timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid CreditRolloverLedgerEntry: type: object required: - type - timestamp - amount - new_contract_id - segment_id properties: type: type: string enum: - CREDIT_ROLLOVER timestamp: type: string format: date-time amount: type: number segment_id: type: string format: uuid new_contract_id: type: string format: uuid MinimumConfig: type: object description: >- Only set for TIERED_PERCENTAGE or PERCENTAGE rate_type. Any commit-specific overrides will not apply if there is a minimum set on the rate/applied override. required: - minimum properties: minimum: type: number HierarchyLink: type: object required: - contract_id - customer_id properties: contract_id: type: string format: uuid customer_id: type: string format: uuid SubscriptionBillingPeriod: type: object required: - starting_at - ending_before properties: starting_at: type: string format: date-time ending_before: type: string format: date-time responses: NotFound: description: The specified resource was not found content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: bearerAuth: type: http scheme: bearer ````