Skip to main content
POST
/
reports
Create a report
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'transactions',
    filters: [
      {name: 'collection_mode', value: ['manual']},
      {name: 'updated_at', value: '2024-04-15', operator: 'lt'},
      {name: 'updated_at', value: '2024-01-01', operator: 'gte'}
    ]
  })
};

fetch('https://api.paddle.com/reports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "rep_01hvgdhtthn1q35n79dgeqm3pv",
    "type": "transactions",
    "rows": null,
    "status": "pending",
    "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": null,
    "created_at": "2024-04-15T08:21:36.209Z",
    "updated_at": "2024-04-15T08:21:36.209Z"
  },
  "meta": {
    "request_id": "0774e52b-fcc3-4d7e-8047-b1b1a05a3f27"
  }
}

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.

Body

application/json

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

type
enum<string>
required

Type of report to create.

Available options:
adjustments,
adjustment_line_items
Example:

"adjustments"

filters
AdjustmentsReportFilters · object[]

Filter criteria for this report. If omitted, 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.

Maximum array length: 10

Response

Created

data
Adjustments reports · object
required

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

meta
Meta · object
required

Information about this response.