PApaddlehq
Reports

Create a report

Changed on

Creates a new report.

Reports are created as pending initially while Paddle generates your report. They move to ready when they're ready to download.

You can download a report when it's ready using the get a CSV file for a report operation.

If successful, your response includes a copy of the new report entity.

post/reports

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Request body

OR
OR
OR
OR
OR
OR
OR

Example request

{
  "type": "adjustments",
  "filters": [
    {
      "operator": "lt",
      "value": "2024-10-12T07:20:50.52Z"
    }
  ]
}

Response

The request has succeeded and a new resource has been created as a result.

Example response

{
  "data": {
    "id": "txnitm_01gm302t81w94gyjpjpqypkzkf",
    "expires_at": "2024-10-12T07:20:50.52Z",
    "updated_at": "2024-10-13T07:20:50.52Z",
    "created_at": "2024-10-12T07:20:50.52Z",
    "type": "adjustments",
    "filters": [
      {
        "operator": "lt",
        "value": "2024-10-12T07:20:50.52Z"
      }
    ]
  },
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355"
  }
}

Changes

  • v14f35a8c6ea4dRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • info

      added to the request body oneOf list

  • v1e1ac347eb3c5Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • info

      added to the request body oneOf list

    • info

      added subschema #1 subschema #2 subschema #4 to the /// request property anyOf list

    • info

      added subschema #1 subschema #2 subschema #4 to the //// response property anyOf list for the response status