---
title: "Retrieve customer analytics for overdue balance"
method: GET
path: "/customers/{external_customer_id}/analytics/overdue-balance"
tags: ["Customers"]
---

# Retrieve customer analytics for overdue balance

`GET /customers/{external_customer_id}/analytics/overdue-balance`

## Request

- Base URL: `https://api-m.sandbox.paypal.com`
- URL: `https://api-m.sandbox.paypal.com/customers/{external_customer_id}/analytics/overdue-balance`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/api/oauth-proxy` scopes: `read`, `write`
- TypeScript: <https://skmtc.dev/paypal/apis/usage-based-billing-api/docs/customers/:external_customer_id/analytics/overdue-balance/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `external_customer_id` string, required

## Query parameters

- `months` integer
- `currency` string: Currency code in ISO 4217 format.

## Response `200`

Customer overdue balance analytics retrieved successfully

- OverdueBalances: Represents a collection of monthly overdue balance records for a specific customer.
  - `overdue_balances` OverdueBalance[]: An array of monthly overdue balance entries for the specified customer.
    - `month` string: The year and month, represented as a string in ISO 8601 'YYYY-MM' format (e.g., '2025-08'). For details, refer to RFC 3339 section 5.6 (Internet Date/Time Format).
    - `amount` object: The total overdue balance amount for the specified customer during the reference month.
      - `value` number, required: The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).
      - `currency_code` string, required: Currency code in ISO 4217 format.
    - `invoice_ids` string[]: An array of invoice IDs associated with the overdue balance for the reference month.

## Other responses

- `400`: Bad Request - Invalid input data
- `403`: Authorization failed due to insufficient permissions.
- `404`: Resource Not Found.
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/paypal/apis/usage-based-billing-api.md) - [All operations](https://skmtc.dev/paypal/apis/usage-based-billing-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paypal/apis/usage-based-billing-api/revisions/22fb46514ac4?raw)