Paddle Billing
Search

List reports

Returns a paginated list of reports. Use the query parameters to page through results.

By default, Paddle returns reports that are pending or ready. Use the status query parameter to return reports that are failed, expired, or deleted.

Query Parameters

afterstring

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_bystring

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

Valid fields for ordering: id.

per_pageinteger

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.

statusarray[string]

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

Response

dataarray[object]

Represents a report entity.

typestring

Type of report to create.

idstring

Unique Paddle ID for this report, prefixed with rep_

statusstring

Status of this report. Set automatically by Paddle.

Reports are created as pending initially, then move to ready when they're available to download.

rowsinteger or null

Number of records in this report. null if the report is pending.

expires_atstring<date-time> or null

RFC 3339 datetime string of when this report expires. The report is no longer available to download after this date.

updated_atstring<date-time>

RFC 3339 datetime string of when this report was last updated.

created_atstring<date-time>

RFC 3339 datetime string of when this report was created.

filtersarray[object]

Filter criteria for this report. If omitted when creating, reports are filtered to include data updated in the last 30 days. This means updated_at is greater than or equal to (gte) the date 30 days ago from the time the report was generated.

namestring

Field name to filter by.

operatorstring or null

Operator to use when filtering. Valid when filtering by updated_at, null otherwise.

valuearray or string

Value to filter by. Check the allowed values descriptions for the name field to see valid values for a field.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

paginationobject

Keys used for working with paginated results.