Skip to main content
GET
List Pending Payouts
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Return a paginated list of line items that are pending payout for the authenticated vendor. Unlike the transactions endpoint, this uses offset-based pagination (limit/offset) instead of cursors.

Use Cases

  • Pending earnings table — Show vendors what they have earned but not yet been paid for
  • Payout preview — Let vendors see what will be included in the next payout
  • Filtered views — Show only refunded or adjusted line items separately

Headers

string
required
A valid vendor JWT. Requires payouts:read scope.

Query Parameters

string
Filter by vendor ID (24-character hex string). Defaults to the authenticated vendor.
string
ISO 8601 lower bound on line item date.
string
ISO 8601 upper bound on line item date.
Free-text search (max 200 characters). Searches order names, SKUs, and product titles.
string
Filter by type: paid · refunded · adjustment.
integer
Number of records per page. Min 1, max 500. Defaults to 50.
integer
Number of records to skip. Min 0. Defaults to 0.

Response

200

Error Responses

401
403

Example

More Examples

Filter refunded items