Skip to main content
GET
Get customer group insights

Authorizations

X-App-Id
string
header
required

App ID for authentication

X-Api-Key
string
header
required

API Key for authentication

Path Parameters

id
string<uuid>
required

The customer group's UUID.

Response

Successful operation

Amounts are in the customer's or group's currency. A figure that can't be worked out yet is null, never 0.

total_paid
object
outstanding_balance
object
overdue_balance
object
average_days_to_pay
integer | null

Average days from issue to payment. Null with nothing paid yet.

Example:

37

median_days_to_pay
integer | null

Median days from issue to payment, for the same invoices. Null with nothing paid yet.

Example:

24

last_payment_at
string<date-time> | null

When the last payment came in, in ISO 8601.

Example:

"2026-10-28T15:04:00Z"

last_payment_amount
object | null
invoice_count
integer

Number of invoices, open or paid.

Example:

24

on_time_payment_rate
number | null

Share of paid invoices paid by their due date, as a fraction from 0 to 1.

Example:

0.75

chargeback_count
integer

Number of chargebacks.

Example:

0

chargeback_amount
object
net_terms
integer

Net terms in days. The customer's or group's own, or your default when they have none.

Example:

30

days_past_terms
integer | null

Days by which average_days_to_pay runs past net_terms, never below 0. Null without an average.

Example:

7

paid_invoice_count
integer

Number of invoices paid off.

Example:

9

days_to_pay_trend
object[]

The last six months, including this one. Empty with no invoices.

spend_trailing_12
integer

Sales over the last 12 months, in cents.

Example:

18150000

spend_prior_12
integer | null

Sales over the 12 months before that, in cents. Null unless the first invoice is at least 24 months old.

Example:

15380000

share_of_sales
number | null

Share of your sales over the last 12 months, as a fraction from 0 to 1. Null when you have none.

Example:

0.04

share_of_receivables
number | null

Share of what all your customers owe now, as a fraction from 0 to 1. Null when nothing is owed.

Example:

0.07

payments_by_method
object | null

How the last 12 months' payments were made. Null when nothing was paid.

failed_payment_count
integer

Number of failed payment attempts in the last 12 months. One declined charge across several invoices counts once.

Example:

1

last_invoiced_at
string<date> | null

The day of the last invoice, as YYYY-MM-DD.

Example:

"2026-08-19"

usual_gap_days
integer | null

Median days between invoices. Null with fewer than 3 invoices on at least two different days.

Example:

21