API reference

Files and exports

Files hold a logo or a product image that you upload, and the PDFs and exports the platform generates. Uploads are multipart/form-data, 5 MB at most; allowed types: PNG, JPEG, WebP for images (SVG is refused: it can carry script). invoice_attachment is not offered in this release and is refused with parameter_invalid, reason not_offered. Every upload is re-encoded or checked before it is served, and files are served from pay.orrerie.com with Content-Disposition: attachment except images used on checkout pages.

Exports are CSV or PDF files of orders, payments, refunds, payouts, conversions, invoices, customers, subscriptions or the ledger. An export freezes its data at snapshot_at, is built in the background (queued, then running, then ready or failed), is announced by export.ready, and is kept 7 days (expired). At most 10 exports an hour and 500,000 rows each. CSV columns are listed in the end of the API reference.

The `file` object

JSON

{
  "id": "file_xn5cz8fk5zmyx3kp37rvddgs",
  "object": "file",
  "livemode": true,
  "created": "2026-09-02T09:30:00.000Z",
  "purpose": "logo",
  "filename": "acme-logo.png",
  "mime_type": "image/png",
  "size": 48213,
  "sha256": "a1c7b03ea5a227bc090751384067035d8ecc3365b30c03d8a792eff6db1accf5",
  "expires_at": null
}

Table: The file object
Field	Meaning
`purpose`	One of `logo`, `product_image`, `invoice_attachment`, `invoice_pdf`, `receipt_pdf`, `export`.

The `export` object

JSON

{
  "id": "exp_kpvgpbjqmv3kexwyrnp12j8e",
  "object": "export",
  "livemode": true,
  "created": "2026-10-12T08:00:00.000Z",
  "type": "orders",
  "format": "csv",
  "status": "ready",
  "filters": {
    "created": {
      "gte": "2026-09-01T00:00:00.000Z",
      "lt": "2026-10-01T00:00:00.000Z"
    },
    "status": [
      "paid",
      "overpaid"
    ]
  },
  "timezone": "America/Los_Angeles",
  "display_currency": "USD",
  "row_count": 212,
  "file": "file_cb1074yxtrbjzx9g7djqa8yr",
  "snapshot_at": "2026-10-12T08:00:00.000Z",
  "completed_at": "2026-10-12T08:00:07.300Z",
  "expires_at": "2026-10-19T08:00:07.300Z",
  "failure_code": null,
  "requested_by": {
    "type": "api_key",
    "id": "key_6e3gg2c6ea176xxdek2nar6v"
  }
}

Table: The export object
Field	Meaning
`type`	One of `orders`, `payments`, `refunds`, `payouts`, `conversions`, `invoices`, `customers`, `subscriptions`, `ledger`.
`format`	One of `csv`, `pdf`.
`status`	One of `queued`, `running`, `ready`, `failed`, `expired`.

Every field

Fields of the `file` object

Fields of the file object
Field	Type	Meaning
`id`	string	Unique identifier: the object prefix, an underscore, 24 lower-case Crockford base32 characters.
`object`	string	The type of this object.
`livemode`	boolean	`true` for live mode (real money); `false` for test mode (simulated payments).
`created`	string (date-time)	When the object was created. RFC 3339, UTC, milliseconds.
`purpose`	string	What the file is for. `invoice_attachment` is not offered in this release and is refused with `parameter_invalid`, reason `not_offered`. One of `logo`, `product_image`, `invoice_attachment`, `invoice_pdf`, `receipt_pdf`, `export`.
`filename`	string	The file's name.
`mime_type`	string	The file's media type, for example `image/png`.
`size`	integer	The file's size in bytes.
`sha256`	string	The SHA-256 of the file's bytes, in hex.
`expires_at`	string or null	When the file is deleted; `null` for a file kept until it is deleted.

Fields of the `export` object

Fields of the export object
Field	Type	Meaning
`id`	string	Unique identifier: the object prefix, an underscore, 24 lower-case Crockford base32 characters.
`object`	string	The type of this object.
`livemode`	boolean	`true` for live mode (real money); `false` for test mode (simulated payments).
`created`	string (date-time)	When the object was created. RFC 3339, UTC, milliseconds.
`type`	string	One of `orders`, `payments`, `refunds`, `payouts`, `conversions`, `invoices`, `customers`, `subscriptions`, `ledger`.
`format`	string	One of `csv`, `pdf`.
`status`	string	One of `queued`, `running`, `ready`, `failed`, `expired`.
`filters`	object	The filters the export was asked with; only those given are present.
`filters.created`	object	The range of creation times exported (`gte`, `gt`, `lte`, `lt`).
`filters.status`	array of strings	The states exported.
`timezone`	string	The time zone the export's dates are written in.
`display_currency`	string	The currency values are shown in.
`row_count`	integer or null	How many rows the file holds; `null` until it is ready.
`file`	string or null	The `file_` id of the export; `null` until it is ready.
`snapshot_at`	string (date-time)	The moment the export's data is read at.
`completed_at`	string (date-time) or null	When the file was made; `null` until then.
`expires_at`	string (date-time) or null	When the file is deleted, 7 days after it is ready; `null` until then.
`failure_code`	string or null	Why the export failed; `null` unless `status` is `failed`.
`requested_by`	object	Who asked for it: an API key or a dashboard member.
`requested_by.type`	string	`api_key` or `member`.
`requested_by.id`	string	The id of the key (`key_…`) or the member (`mem_…`) that asked.

Endpoints

Events

Webhook events whose data.object is an object of this page.

Files and exports

The file object

The export object