Paddle Billing
Search

Get a report

Returns a report using its ID.

Path Parameters

report_idstringrequired

Paddle ID of the report entity.

Response

dataobject

Represents a report entity.

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.

typestring

Type of report.

filtersarray[object]

List of filters applied to this report.

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.

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.