Skip to main content
GET
/
reports
List reports
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/reports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": [
    {
      "id": "rep_01hvgdpayq6kjzyk4hz5m02cpn",
      "type": "adjustments",
      "rows": 8,
      "status": "ready",
      "filters": [
        {
          "name": "updated_at",
          "value": "2024-04-15",
          "operator": "lt"
        },
        {
          "name": "updated_at",
          "value": "2024-01-01",
          "operator": "gte"
        }
      ],
      "expires_at": "2024-04-29T08:24:13.042686Z",
      "created_at": "2024-04-15T08:24:03.799Z",
      "updated_at": "2024-04-15T08:24:13.042692Z"
    },
    {
      "id": "rep_01hvgdn6hg6wkh5nnr0e4nn1c0",
      "type": "transaction_line_items",
      "rows": 771,
      "status": "ready",
      "filters": [
        {
          "name": "updated_at",
          "value": "2024-04-15",
          "operator": "lt"
        },
        {
          "name": "updated_at",
          "value": "2024-04-09",
          "operator": "gte"
        }
      ],
      "expires_at": "2024-04-29T08:23:40.529936Z",
      "created_at": "2024-04-15T08:23:26.512Z",
      "updated_at": "2024-04-15T08:23:40.529941Z"
    },
    {
      "id": "rep_01hvgdhtthn1q35n79dgeqm3pv",
      "type": "transactions",
      "rows": 27,
      "status": "ready",
      "filters": [
        {
          "name": "collection_mode",
          "value": [
            "manual"
          ],
          "operator": null
        },
        {
          "name": "updated_at",
          "value": "2024-04-15",
          "operator": "lt"
        },
        {
          "name": "updated_at",
          "value": "2024-01-01",
          "operator": "gte"
        }
      ],
      "expires_at": "2024-04-29T08:21:44.970769Z",
      "created_at": "2024-04-15T08:21:36.209Z",
      "updated_at": "2024-04-15T08:21:44.970774Z"
    },
    {
      "id": "rep_01hqbc372ban0at6z6ysh7hcht",
      "type": "discounts",
      "rows": 3,
      "status": "expired",
      "filters": [
        {
          "name": "updated_at",
          "value": "2024-01-23T16:17:09Z",
          "operator": "gte"
        }
      ],
      "expires_at": "2024-03-08T16:17:13.592102Z",
      "created_at": "2024-02-23T16:17:09.195Z",
      "updated_at": "2024-02-23T16:17:13.592106Z"
    },
    {
      "id": "rep_01hqbc2ra43dhda5dfysc9z3m8",
      "type": "products_prices",
      "rows": 3,
      "status": "expired",
      "filters": [
        {
          "name": "product_updated_at",
          "value": [
            "2024-01-23T16:16:54Z"
          ],
          "operator": "gte"
        },
        {
          "name": "price_updated_at",
          "value": [
            "2024-01-23T16:16:54Z"
          ],
          "operator": "gte"
        }
      ],
      "expires_at": "2024-03-08T16:16:57.93002Z",
      "created_at": "2024-02-23T16:16:54.084Z",
      "updated_at": "2024-02-23T16:16:57.930024Z"
    }
  ],
  "meta": {
    "request_id": "b1a05cb6-c072-4a5f-914b-1a275392196c",
    "pagination": {
      "per_page": 50,
      "next": "https://api.paddle.com/reports?after=rep_01hqbc2ra43dhda5dfysc9z3m8",
      "has_more": false,
      "estimated_total": 5
    }
  }
}

Authorizations

​
Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Query Parameters

​
after
string

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

​
order_by
string
default:id[DESC]

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

​
per_page
integer
default:50

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

Required range: x <= 200
​
status
enum<string>[]

Return entities that match the specified status. Use a comma-separated list to specify multiple status values.

Available options:
pending,
ready,
failed,
expired

Response

OK

​
data
(Adjustments reports · object | Transactions reports · object | Products and prices report · object | Discounts report · object | Balance report · object)[]

Entity when working with reports for adjustments or adjustment line items.

​
meta
MetaPaginated · object

Information about this response.