Skip to main content
POST
/
v1
/
contracts
/
customerBalances
/
list
List balances
curl --request POST \
  --url https://api.metronome.com/v1/contracts/customerBalances/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d",
  "id": "6162d87b-e5db-4a33-b7f2-76ce6ead4e85",
  "include_ledgers": true
}
'
{
  "data": [
    {
      "id": "62c0cb84-bf3f-48b9-9bcf-a8ddf8c1cf35",
      "type": "PREPAID",
      "rate_type": "LIST_RATE",
      "name": "My test commit",
      "description": "My test commit description",
      "priority": 100,
      "product": {
        "id": "2e30f074-d04c-412e-a134-851ebfa5ceb2",
        "name": "My product A"
      },
      "rollover_fraction": 0.1,
      "applicable_product_ids": [
        "13a2179b-f0cb-460b-85a1-cd42964ca533"
      ],
      "applicable_contract_ids": [
        "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"
      ],
      "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
      },
      "invoice_contract": {
        "id": "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"
      },
      "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"
        }
      ],
      "uniqueness_key": "946g9bepi1-uniqueness-key",
      "created_at": "2020-01-01T00:00:00.000Z"
    },
    {
      "id": "fa411f5b-fb85-4755-9d4d-530717be083c",
      "type": "CREDIT",
      "rate_type": "LIST_RATE",
      "name": "My test credit",
      "description": "My test credit description",
      "priority": 100,
      "product": {
        "id": "2e30f074-d04c-412e-a134-851ebfa5ceb2",
        "name": "My product A"
      },
      "applicable_product_ids": [
        "13a2179b-f0cb-460b-85a1-cd42964ca533"
      ],
      "applicable_contract_ids": [
        "d7abd0cd-4ae9-4db7-8676-e986a4ebd8dc"
      ],
      "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"
          }
        ]
      },
      "ledger": [
        {
          "invoice_id": "525b9759-7bbd-4a05-aab1-d7c43c976b57",
          "amount": 10000000,
          "timestamp": "2020-03-01T00:00:00.000Z",
          "type": "CREDIT_AUTOMATED_INVOICE_DEDUCTION",
          "segment_id": "2d45952c-5a6e-43a9-8aab-f61ee21be81a"
        }
      ],
      "uniqueness_key": "372p7cvwr3-uniqueness-key"
    }
  ],
  "next_page": null
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

List all balances (commits and credits) for a customer

​
customer_id
string<uuid>
required
​
id
string<uuid>
​
covering_date
string<date-time>

Return only balances that have access schedules that "cover" the provided date

​
starting_at
string<date-time>

Include only balances that have any access on or after the provided date

​
effective_before
string<date-time>

Include only balances that have any access before the provided date (exclusive)

​
include_contract_balances
boolean

Include balances on the contract level.

​
include_archived
boolean

Include archived credits and credits from archived contracts.

​
include_ledgers
boolean

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

​
include_balance
boolean

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

​
next_page
string

The next page token from a previous response.

​
limit
integer
default:25

The maximum number of commits to return. Defaults to 25.

Required range: 1 <= x <= 25

Response

200 - application/json

Success

​
data
object[]
required
​
next_page
string | null
required