Sign in

v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

List usage summaries

get/usage/summaries

Query parameters

companystring
category'company' | 'employee' | 'contractor' | 'company_funding_failure' | 'payee_failed_payment' | 'wire' | 'one_day_payroll_processing_period'
period_startstring date
period_endstring date

Response

200

{"stackTrail":"paths:/usage/summaries:get:responses:200:content:application/json:schema:properties:previous","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/usage/summaries:get:responses:200:content:application/json:schema:properties:next","oasType":"schema","type":"unknown"}

Example response

{
  "results": [
    {
      "company": "com_dXE2p4wCM251HmlJB0Mn",
      "category": "company",
      "count": 1,
      "period_start": "2024-05-01",
      "period_end": "2024-05-31"
    }
  ]
}