Skip to main content
GET
/
customers
/
{id}
/
invoices
/
summary
Get customer invoice summary
curl --request GET \
  --url https://us.api.flexprice.io/v1/customers/{id}/invoices/summary \
  --header 'x-api-key: <api-key>'
{
  "customer_id": "<string>",
  "default_currency": "<string>",
  "summaries": [
    {
      "currency": "<string>",
      "customer_id": "<string>",
      "overdue_invoice_count": 123,
      "total_invoice_count": 123,
      "total_overdue_amount": "<string>",
      "total_revenue_amount": "<string>",
      "total_unpaid_amount": "<string>",
      "unpaid_fixed_charges": "<string>",
      "unpaid_invoice_count": 123,
      "unpaid_usage_charges": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.flexprice.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

​
id
string
required

Customer ID

Response

OK

​
customer_id
string

customer_id is the unique identifier of the customer

​
default_currency
string

default_currency is the primary currency for this customer

​
summaries
object[]

summaries contains the invoice summaries for each currency