PApaypal
Customers

Retrieve customer gross revenue analytics

get/customers/{external_customer_id}/analytics/gross-revenue

Request

Path parameters

external_customer_idstring required

The unique external identifier of the customer used to filter their gross revenue.

Query parameters

monthsinteger

Limits the analytics data to the specified number of most recent months. Defaults to 12 if not provided.

currencystring

Currency code in ISO 4217 format.

Example:USD

Filters the analytics data by the specified currency code (e.g., 'USD').

Response

Customer gross revenue analytics retrieved successfully.

Example response

{
  "gross_revenues": [
    {
      "month": "2023-11",
      "amount": {
        "value": 120.35,
        "currency_code": "USD"
      },
      "invoices_count": 10
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.