PApaypal
Customers

Get past usage for a customer

Retrieves historical usage information for a specific customer across previous billing periods

get/customers/{external_customer_id}/past_usage

Request

Path parameters

external_customer_idstring required

The unique external identifier of the customer

Query parameters

pageinteger

Page number

per_pageinteger

Number of records per page

subscription_idstring required

Filter by subscription ID.

Response

Returns the past usage for the specified customer.

Example response

{
  "usage_periods": [
    {
      "from_datetime": "2022-07-01T00:00:00Z",
      "to_datetime": "2022-07-31T23:59:59Z",
      "issuing_date": "2023-10-01",
      "invoice_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "total_amount": {
        "value": 120.35,
        "currency_code": "USD"
      },
      "taxes_amount": {
        "value": 120.35,
        "currency_code": "USD"
      },
      "charges_usage": [
        {
          "units": "1.0",
          "events_count": 10,
          "amount": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "charge": {
            "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "charge_model": "GRADUATED",
            "taxes": [
              {
                "name": "TVA",
                "rate": "20.00",
                "description": "French standard VAT",
                "code": "standard_vat",
                "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
                "created_at": "2025-06-01T00:00:00Z"
              }
            ],
            "min_amount": {
              "value": 120.35,
              "currency_code": "USD"
            }
          },
          "metric": {
            "aggregation_type": "SUM"
          }
        }
      ]
    }
  ]
}

Changes

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