---
updatedAt: 2025-10-12T20:30:44.000Z
agentTools:
  projectIndex: https://docs.checkhq.com/llms.txt
---

# List usage records

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "check-api",
    "version": "2025-01-01"
  },
  "servers": [
    {
      "url": "https://sandbox.checkhq.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer",
        "x-default": "YOUR_API_KEY"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/usage/records": {
      "get": {
        "summary": "List usage records",
        "description": "",
        "operationId": "list-usage-records",
        "parameters": [
          {
            "name": "company",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "category",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "company",
                "employee",
                "contractor",
                "company_funding_failure",
                "payee_failed_payment",
                "wire",
                "one_day_payroll_processing_period"
              ]
            }
          },
          {
            "name": "resource_type",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "company",
                "employee",
                "contractor",
                "payment_attempt"
              ]
            }
          },
          {
            "name": "period_start",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "period_end",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "previous": null,
                      "next": null,
                      "results": [
                        {
                          "category": "wire",
                          "company": "com_dXE2p4wCM251HmlJB0Mn",
                          "resource_type": "payment_attempt",
                          "resource": "pyt_vIFHhvyGN47ej1upyIT8",
                          "resource_information": {},
                          "effective_at": "2024-06-01T00:00:00.000Z"
                        }
                      ]
                    }
                  },
                  "Payee Failed Payment": {
                    "summary": "Payee Failed Payment",
                    "value": {
                      "previous": null,
                      "next": null,
                      "results": [
                        {
                          "category": "payee_failed_payment",
                          "company": "com_dXE2p4wCM251HmlJB0Mn",
                          "resource_type": "payment_attempt",
                          "resource": "pya_vIFHhvyGN47ej1upyIT8",
                          "resource_information": {
                            "payee": "emp_abc123xyz",
                            "payee_type": "employee"
                          },
                          "effective_at": "2024-05-01T00:00:00.000Z"
                        }
                      ]
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "previous": {},
                    "next": {},
                    "results": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "category": {
                            "type": "string",
                            "example": "wire"
                          },
                          "company": {
                            "type": "string",
                            "example": "com_dXE2p4wCM251HmlJB0Mn"
                          },
                          "resource_type": {
                            "type": "string",
                            "example": "payment_attempt"
                          },
                          "resource": {
                            "type": "string",
                            "example": "pyt_vIFHhvyGN47ej1upyIT8"
                          },
                          "resource_information": {
                            "type": "object",
                            "properties": {},
                            "description": "Additional information about the resource. For payee_failed_payment records, contains payee and payee_type fields identifying the employee or contractor. Empty object for other categories."
                          },
                          "effective_at": {
                            "type": "string",
                            "example": "2024-06-01T00:00:00.000Z"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```