plans

Fetch usage summaries for a plan and customer

get/plans/{planId}/usage

Request

  • Base URL: https://api.agentpaid.io/api/v1
  • URL: https://api.agentpaid.io/api/v1/plans/{planId}/usage
  • Auth: HTTP bearer

Path parameters

planIdstring uuid required

The ID of the plan

Query parameters

externalIdstring required

The external ID of the customer

limitinteger

Maximum number of usage summaries to return (1-1000)

offsetinteger

Number of usage summaries to skip for pagination

startTimestring date-time

Filter usage summaries starting from this time (ISO 8601 format). Returns summaries that overlap with the time range.

endTimestring date-time

Filter usage summaries up to this time (ISO 8601 format). Returns summaries that overlap with the time range.

Response

Success response

Changes

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