Customers

Get customer usage summary

Changed on

Use when showing a customer's usage (e.g. portal or overage alerts). Identify by customer_id or customer_lookup_key; supports filters.

get/customers/usage

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/customers/usage
  • Auth
    API key in header x-api-key

Query parameters

customer_idstring
customer_lookup_keystring
feature_idsstring[]
feature_lookup_keysstring[]
subscription_idsstring[]

Response

OK

customer_idstring

Example response

{
  "features": [
    {
      "feature": {
        "meter": {
          "created_at": "2024-03-20T15:04:05Z",
          "event_name": "api_request",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "API Usage Meter",
          "status": "published",
          "tenant_id": "tenant123",
          "updated_at": "2024-03-20T15:04:05Z"
        }
      }
    }
  ]
}

Changes

  • c2dd8587a719Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property // to the response with the status

  • 9848123298efRevision changes
    • info

      added the optional property // to the response with the status