Skip to main content
Retrieves a cursor-paginated list of all sales in your store. Sales represent completed, pending, abandoned, failed, or settled transactions. The response includes customer, product, discount, and rating information.

Query Parameters

per_page
integer
default:"15"
Number of sales to return per page (max 100)
cursor
string
Cursor for pagination. Use the next_cursor from the previous response.
status
string
Filter by sale status: awaiting_payment, completed, failed, abandoned, or settled
customer_id
string
Filter by customer public ID (e.g., cus_abc123xyz)
Search by sale reference or customer email
start_date
string
Filter sales from this date onwards (format: Y-m-d, e.g., 2025-01-01)
end_date
string
Filter sales until this date (format: Y-m-d, e.g., 2025-01-31)

Response

data
array
Array of sale objects
pagination
object
Pagination metadata