List seat balances

curl --request POST \
  --url https://api.metronome.com/v1/contracts/seatBalances/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contract_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subscription_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "seat_ids": [
    "<string>"
  ],
  "include_credits_and_commits": false,
  "include_ledgers": false,
  "starting_at": "2023-11-07T05:31:56Z",
  "effective_before": "2023-11-07T05:31:56Z",
  "covering_date": "2023-11-07T05:31:56Z",
  "limit": 123,
  "cursor": "<string>"
}
'

{
  "data": [
    {
      "seat_id": "<string>",
      "balances": [
        {
          "credit_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "balance": 123,
          "starting_balance": 123
        }
      ],
      "commits": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "balance": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "end_date": "2023-11-07T05:31:56Z",
          "ledger_entries": [
            {
              "type": "PREPAID_COMMIT_SEGMENT_START",
              "amount": 123,
              "timestamp": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "credits": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "balance": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "end_date": "2023-11-07T05:31:56Z",
          "ledger_entries": [
            {
              "type": "CREDIT_SEGMENT_START",
              "amount": 123,
              "timestamp": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "seats_included": 123,
    "seats_available_for_next_page": 123,
    "next_page": "<string>"
  }
}

Credits and commits

List seat balances

Retrieve detailed balance for seat-based credits and commits from the contract’s subscriptions, broken down by individual seats.

Use this endpoint to:

Display per-seat balance information in customer dashboards
Filter balance data by subscription or specific seats

Key response fields:

An array of seat balance objects containing:

Seat id
Balance: current total balance across all commits and credits

Usage guidelines:

Date filtering: use covering_date OR starting_at/ending_before to filter balance data by time range
Set include_credits_and_commits=true for detailed commits and credits breakdown per seat
Set include_ledgers=true for detailed transaction history per commit/credit per seat

POST

contracts

seatBalances

list

List seat balances

curl --request POST \
  --url https://api.metronome.com/v1/contracts/seatBalances/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contract_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "subscription_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "seat_ids": [
    "<string>"
  ],
  "include_credits_and_commits": false,
  "include_ledgers": false,
  "starting_at": "2023-11-07T05:31:56Z",
  "effective_before": "2023-11-07T05:31:56Z",
  "covering_date": "2023-11-07T05:31:56Z",
  "limit": 123,
  "cursor": "<string>"
}
'

{
  "data": [
    {
      "seat_id": "<string>",
      "balances": [
        {
          "credit_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "balance": 123,
          "starting_balance": 123
        }
      ],
      "commits": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "balance": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "end_date": "2023-11-07T05:31:56Z",
          "ledger_entries": [
            {
              "type": "PREPAID_COMMIT_SEGMENT_START",
              "amount": 123,
              "timestamp": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ],
      "credits": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "balance": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "end_date": "2023-11-07T05:31:56Z",
          "ledger_entries": [
            {
              "type": "CREDIT_SEGMENT_START",
              "amount": 123,
              "timestamp": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "seats_included": 123,
    "seats_available_for_next_page": 123,
    "next_page": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

List seat-level balances for commits and credits.

customer_id

string<uuid>

required

The customer ID to retrieve seat balances for

contract_id

string<uuid>

required

The contract ID to retrieve seat balances for

subscription_ids

string<uuid>[]

Optional filter to only include seats from specific subscriptions. If subscriptions ids are not mapped to SEAT_BASED subscriptions, error will be returned.

seat_ids

string[]

Optional filter to only include specific seats

include_credits_and_commits

boolean

default:false

Include credits and commits in the response

include_ledgers

boolean

default:false

Include ledger entries for each commit and commit. include_credits_and_commits must be set to true for include_ledgers=true to apply.

starting_at

string<date-time>

Include only commits or credits with access effective on or after this date (cannot be used with covering_date).

effective_before

string<date-time>

Include only commits or credits with access effective on or before this date (cannot be used with covering_date).

covering_date

string<date-time>

Include only commits or credits with access that cover this specific date (cannot be used with starting_at or ending_before).

limit

integer

Maximum number of seats to return. Range: 1-100. Default: 25. When include_credits_and_commits = true, if the total commits/credits across all seats exceeds 100, a limit of 100 applies to the total credits and commits. Seats are included greedily to maximize the number of seats returned. Example: if seat 1 has 98 commits and seat 2 has 10 commits, both seats will be returned (total: 108 commits). Each returned seat includes all of its associated credits and commits.

cursor

string

Page token from a previous response to retrieve the next page

Response

Success

data

object[]

required

Show child attributes

data.seat_id

string

required

The unique identifier for the seat

data.balances

object[]

required

Show child attributes

data.balances.credit_type_id

string<uuid>

required

data.balances.balance

number

required

The total balance across all commits and credits for this seat, of this credit type.

data.balances.starting_balance

number

required

The total initial balances of all commits and credits for this seat, of this credit type.

data.commits

object[] | null

Array of commits applicable to this seat with their balances

Show child attributes

data.commits.id

string<uuid>

required

The commit or credit ID

data.commits.balance

number

required

The current balance for this commit for this specific seat

data.commits.start_date

string<date-time>

required

The datetime when the commit becomes active

data.commits.end_date

string<date-time> | null

The datetime when the commit expires

data.commits.ledger_entries

object[]

Transaction history for this commit for this seat (only included if include_ledgers=true)

Show child attributes

data.commits.ledger_entries.type

enum<string>

required

Commit ledger type

Available options:

PREPAID_COMMIT_SEGMENT_START,

PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION,

PREPAID_COMMIT_ROLLOVER,

PREPAID_COMMIT_EXPIRATION,

PREPAID_COMMIT_CANCELED,

PREPAID_COMMIT_CREDITED,

PREPAID_COMMIT_MANUAL,

PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT

data.commits.ledger_entries.amount

number

required

Amount of the ledger entry

data.commits.ledger_entries.timestamp

string<date-time>

required

The datetime when the ledger is created

data.credits

object[]

Array of credits applicable to this seat with their balances

Show child attributes

data.credits.id

string<uuid>

required

The credit ID

data.credits.balance

number

required

The current balance for this credit for this specific seat

data.credits.start_date

string<date-time>

required

The datetime when the credit becomes active

data.credits.end_date

string<date-time> | null

The datetime when the credit expires

data.credits.ledger_entries

object[]

Transaction history for this credit for this seat (only included if include_ledgers=true)

Show child attributes

data.credits.ledger_entries.type

enum<string>

required

Credit ledger type

Available options:

CREDIT_SEGMENT_START,

CREDIT_AUTOMATED_INVOICE_DEDUCTION,

CREDIT_EXPIRATION,

CREDIT_CANCELED,

CREDIT_CREDITED,

CREDIT_MANUAL,

CREDIT_SEAT_BASED_ADJUSTMENT

data.credits.ledger_entries.amount

number

required

Amount of the ledger entry

data.credits.ledger_entries.timestamp

string<date-time>

required

The datetime when the ledger is created

pagination

object

required

Show child attributes

pagination.seats_included

number

required

Number of seats included in this response

pagination.seats_available_for_next_page

number

required

Number of seats available to fetch in the next page

pagination.next_page

string | null

Token to retrieve the next page of results. Null if no more pages available

List balances

Edit a commit

⌘I

GET STARTED

ESSENTIALS

ENDPOINTS

List seat balances

Use this endpoint to:

Key response fields:

Usage guidelines:

Authorizations

Body

Response