GEgetlago
customers

Retrieve customer past usage

Changed on

This endpoint enables the retrieval of the usage-based billing data for a customer within past periods.

get/customers/{external_customer_id}/past_usage

Request

Path parameters

external_customer_idstring required
Example:5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba

The customer external unique identifier (provided by your own application).

Query parameters

pageinteger
Example:1

Page number. Defaults to 1. A value that is not a positive integer, such as 0, returns the first page.

per_pageinteger
Example:20

Number of records per page. Defaults to 100. The maximum is 200, unless another maximum is configured for your organization. A value above the maximum returns a 422 error with value_is_out_of_range on per_page. A value that is not a positive integer, such as 0, returns the default number of records.

external_subscription_idstring required
Example:sub_1234567890

The unique identifier of the subscription within your application.

billable_metric_codestring
Example:cpu

Billable metric code filter to apply to the charge usage

periods_countinteger
Example:5

Number of past billing periods to return in the result.

Response

Customer past usage

Changes

  • 5d26657495a3Revision changes
    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property //////// became nullable for the status

    • breaking

      the response property //////// became nullable for the status

    • warning

      added the new SYP enum value to the //// response property for the response status

    • warning

      added the new SYP enum value to the // response property for the response status

    • warning

      added the new TND enum value to the //// response property for the response status

    • warning

      added the new TND enum value to the // response property for the response status

    • warning

      added the new dynamic enum value to the ///// response property for the response status

    • warning

      added the new graduated_percentage enum value to the ///// response property for the response status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property //////// became required for the status

    • info

      the response property //////// became required for the status

    • info

      the response property //////// became required for the status

    • info

      the response property //////// became required for the status

    • info

      the response property //////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property ////// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

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