Get the net balance of a customer

curl --request POST \
  --url https://api.metronome.com/v1/contracts/customerBalances/getNetBalance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d",
  "credit_type_id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
  "filters": [
    {
      "balance_types": [
        "CREDIT"
      ],
      "custom_fields": {
        "campaign": "free-trial"
      }
    },
    {
      "balance_types": [
        "PREPAID_COMMIT",
        "POSTPAID_COMMIT"
      ],
      "custom_fields": {
        "campaign": "signup-promotion"
      }
    }
  ]
}
'

import requests

url = "https://api.metronome.com/v1/contracts/customerBalances/getNetBalance"

payload = {
    "customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d",
    "credit_type_id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
    "filters": [
        {
            "balance_types": ["CREDIT"],
            "custom_fields": { "campaign": "free-trial" }
        },
        {
            "balance_types": ["PREPAID_COMMIT", "POSTPAID_COMMIT"],
            "custom_fields": { "campaign": "signup-promotion" }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
    credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
    filters: [
      {balance_types: ['CREDIT'], custom_fields: {campaign: 'free-trial'}},
      {
        balance_types: ['PREPAID_COMMIT', 'POSTPAID_COMMIT'],
        custom_fields: {campaign: 'signup-promotion'}
      }
    ]
  })
};

fetch('https://api.metronome.com/v1/contracts/customerBalances/getNetBalance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.metronome.com/v1/contracts/customerBalances/getNetBalance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => '13117714-3f05-48e5-a6e9-a66093f13b4d',
    'credit_type_id' => '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
    'filters' => [
        [
                'balance_types' => [
                                'CREDIT'
                ],
                'custom_fields' => [
                                'campaign' => 'free-trial'
                ]
        ],
        [
                'balance_types' => [
                                'PREPAID_COMMIT',
                                'POSTPAID_COMMIT'
                ],
                'custom_fields' => [
                                'campaign' => 'signup-promotion'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.metronome.com/v1/contracts/customerBalances/getNetBalance"

	payload := strings.NewReader("{\n  \"customer_id\": \"13117714-3f05-48e5-a6e9-a66093f13b4d\",\n  \"credit_type_id\": \"2714e483-4ff1-48e4-9e25-ac732e8f24f2\",\n  \"filters\": [\n    {\n      \"balance_types\": [\n        \"CREDIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"free-trial\"\n      }\n    },\n    {\n      \"balance_types\": [\n        \"PREPAID_COMMIT\",\n        \"POSTPAID_COMMIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"signup-promotion\"\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.metronome.com/v1/contracts/customerBalances/getNetBalance")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"13117714-3f05-48e5-a6e9-a66093f13b4d\",\n  \"credit_type_id\": \"2714e483-4ff1-48e4-9e25-ac732e8f24f2\",\n  \"filters\": [\n    {\n      \"balance_types\": [\n        \"CREDIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"free-trial\"\n      }\n    },\n    {\n      \"balance_types\": [\n        \"PREPAID_COMMIT\",\n        \"POSTPAID_COMMIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"signup-promotion\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.metronome.com/v1/contracts/customerBalances/getNetBalance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"13117714-3f05-48e5-a6e9-a66093f13b4d\",\n  \"credit_type_id\": \"2714e483-4ff1-48e4-9e25-ac732e8f24f2\",\n  \"filters\": [\n    {\n      \"balance_types\": [\n        \"CREDIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"free-trial\"\n      }\n    },\n    {\n      \"balance_types\": [\n        \"PREPAID_COMMIT\",\n        \"POSTPAID_COMMIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"signup-promotion\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "balance": 123.45,
    "credit_type_id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2"
  }
}

{
  "message": "<string>"
}

Credits and commits

Get the net balance of a customer

Retrieve the combined current balance across any grouping of credits and commits for a customer in a single API call.

Display real-time available balance to customers in billing dashboards
Build finance dashboards showing credit utilization across customer segments
Validate expected vs. actual balance during billing reconciliation

Key response fields:

balance: The combined net balance available to use at this moment across all matching commits and credits
credit_type_id: The credit type (fiat or custom pricing unit) the balance is denominated in

Filtering options:

Balance filters allow you to scope the calculation to specific subsets of commits and credits. When using multiple filter objects, they are OR’d together — if a commit or credit matches any filter, it’s included in the net balance. Within a single filter object, all specified conditions are AND’d together.

Balance types: Include any combination of PREPAID_COMMIT, POSTPAID_COMMIT, and CREDIT (e.g., ["PREPAID_COMMIT", "CREDIT"] to exclude postpaid commits). If not specified, all balance types are included.
Specific IDs: Target exact commit or credit IDs for precise balance queries
Custom fields: Filter by custom field key-value pairs; when multiple pairs are provided, commits must match all of them

Example: To get the balance of all free-trial credits OR all signup-promotion commits, you’d pass two filter objects — one filtering for CREDIT with custom field campaign: free-trial, and another filtering for PREPAID_COMMIT with custom field campaign: signup-promotion.

Usage guidelines:

Balance ledger details: Use the listBalances endpoint instead to understand detailed ledger drawdowns for each individual balance
Draft invoice handling: Use invoice_inclusion_mode to control whether pending draft invoice deductions are included (FINALIZED_AND_DRAFT, the default) or excluded (FINALIZED) from the balance calculation
Account hierarchies: When querying a child customer, shared commits from parent contracts are not included — query the parent customer directly to see shared commit balances
Negative balances: Manual ledger entries can cause negative segment balances; these are treated as zero when calculating the net balance
Credit types: If credit_type_id is not specified, the balance defaults to USD (cents)

POST

contracts

customerBalances

getNetBalance

Get the net balance of a customer

curl --request POST \
  --url https://api.metronome.com/v1/contracts/customerBalances/getNetBalance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d",
  "credit_type_id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
  "filters": [
    {
      "balance_types": [
        "CREDIT"
      ],
      "custom_fields": {
        "campaign": "free-trial"
      }
    },
    {
      "balance_types": [
        "PREPAID_COMMIT",
        "POSTPAID_COMMIT"
      ],
      "custom_fields": {
        "campaign": "signup-promotion"
      }
    }
  ]
}
'

import requests

url = "https://api.metronome.com/v1/contracts/customerBalances/getNetBalance"

payload = {
    "customer_id": "13117714-3f05-48e5-a6e9-a66093f13b4d",
    "credit_type_id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2",
    "filters": [
        {
            "balance_types": ["CREDIT"],
            "custom_fields": { "campaign": "free-trial" }
        },
        {
            "balance_types": ["PREPAID_COMMIT", "POSTPAID_COMMIT"],
            "custom_fields": { "campaign": "signup-promotion" }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_id: '13117714-3f05-48e5-a6e9-a66093f13b4d',
    credit_type_id: '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
    filters: [
      {balance_types: ['CREDIT'], custom_fields: {campaign: 'free-trial'}},
      {
        balance_types: ['PREPAID_COMMIT', 'POSTPAID_COMMIT'],
        custom_fields: {campaign: 'signup-promotion'}
      }
    ]
  })
};

fetch('https://api.metronome.com/v1/contracts/customerBalances/getNetBalance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.metronome.com/v1/contracts/customerBalances/getNetBalance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_id' => '13117714-3f05-48e5-a6e9-a66093f13b4d',
    'credit_type_id' => '2714e483-4ff1-48e4-9e25-ac732e8f24f2',
    'filters' => [
        [
                'balance_types' => [
                                'CREDIT'
                ],
                'custom_fields' => [
                                'campaign' => 'free-trial'
                ]
        ],
        [
                'balance_types' => [
                                'PREPAID_COMMIT',
                                'POSTPAID_COMMIT'
                ],
                'custom_fields' => [
                                'campaign' => 'signup-promotion'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.metronome.com/v1/contracts/customerBalances/getNetBalance"

	payload := strings.NewReader("{\n  \"customer_id\": \"13117714-3f05-48e5-a6e9-a66093f13b4d\",\n  \"credit_type_id\": \"2714e483-4ff1-48e4-9e25-ac732e8f24f2\",\n  \"filters\": [\n    {\n      \"balance_types\": [\n        \"CREDIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"free-trial\"\n      }\n    },\n    {\n      \"balance_types\": [\n        \"PREPAID_COMMIT\",\n        \"POSTPAID_COMMIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"signup-promotion\"\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.metronome.com/v1/contracts/customerBalances/getNetBalance")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_id\": \"13117714-3f05-48e5-a6e9-a66093f13b4d\",\n  \"credit_type_id\": \"2714e483-4ff1-48e4-9e25-ac732e8f24f2\",\n  \"filters\": [\n    {\n      \"balance_types\": [\n        \"CREDIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"free-trial\"\n      }\n    },\n    {\n      \"balance_types\": [\n        \"PREPAID_COMMIT\",\n        \"POSTPAID_COMMIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"signup-promotion\"\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.metronome.com/v1/contracts/customerBalances/getNetBalance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_id\": \"13117714-3f05-48e5-a6e9-a66093f13b4d\",\n  \"credit_type_id\": \"2714e483-4ff1-48e4-9e25-ac732e8f24f2\",\n  \"filters\": [\n    {\n      \"balance_types\": [\n        \"CREDIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"free-trial\"\n      }\n    },\n    {\n      \"balance_types\": [\n        \"PREPAID_COMMIT\",\n        \"POSTPAID_COMMIT\"\n      ],\n      \"custom_fields\": {\n        \"campaign\": \"signup-promotion\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "balance": 123.45,
    "credit_type_id": "2714e483-4ff1-48e4-9e25-ac732e8f24f2"
  }
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Get the combined net balance for any grouping of credits and commits.

customer_id

string<uuid>

required

The ID of the customer.

credit_type_id

string<uuid>

The ID of the credit type (can be fiat or a custom pricing unit) to get the balance for. Defaults to USD (cents) if not specified.

filters

object[]

Balance filters are OR'd together, so if a given commit or credit matches any of the filters, it will be included in the net balance.

Show child attributes

invoice_inclusion_mode

enum<string>

default:FINALIZED_AND_DRAFT

Controls which invoices are considered when calculating the remaining balance. FINALIZED considers only deductions from finalized invoices. FINALIZED_AND_DRAFT also includes deductions from pending draft invoices.

Available options:

FINALIZED,

FINALIZED_AND_DRAFT

Response

Success

data

object

required

Show child attributes

List balances

List seat balances

⌘I

GET STARTED

ESSENTIALS

ENDPOINTS

Get the net balance of a customer

Key response fields:

Filtering options:

Usage guidelines:

Authorizations

Body

Response