List sales

Retrieve all of the successful sales by the authenticated user. Includes sales from all products.

This endpoint uses cursor-based pagination via page_key parameter. The deprecated page parameter will time out for large result sets.

Endpoint

GET https://api.gumroad.com/v2/sales

Authentication

Requires the view_sales OAuth scope.

Query Parameters

string

Cursor for pagination. Use the next_page_key returned in the response to fetch the next page of results.

string

Filter sales created after this date. Format: YYYY-MM-DD.Example: 2024-01-01

string

Filter sales created before this date. Format: YYYY-MM-DD.Example: 2024-12-31

string

Filter sales by purchaser email address.

string

Filter sales by product ID (external ID).

string

Filter sales by order ID (numeric external ID of the purchase).

integer

deprecated

Deprecated. Use page_key instead. Page number for offset-based pagination. This parameter may time out for large result sets.

Response

Returns a paginated list of sale objects.

boolean

required

Indicates if the request was successful.

array

required

Array of sale objects.

Show Sale object properties

string

Unique identifier for the sale (obfuscated).

string

Purchaser’s email address.

string

Seller’s unique identifier (obfuscated).

timestamp

ISO 8601 timestamp of when the sale was created.

string

Product’s external identifier.

string

Name of the product sold.

integer

Sale price in cents.

integer

Gumroad’s fee in cents.

string

Human-readable formatted price with currency symbol.

string

Total transaction amount formatted with currency symbol.

string

Currency symbol for the transaction.

integer

Numeric order identifier.

string

Email used for the purchase.

string

Purchaser’s full name.

string

Purchaser’s external ID if they have a Gumroad account.

boolean

Whether the sale has been fully refunded.

boolean

Whether the sale has been partially refunded.

boolean

Whether the sale has been charged back.

string

Subscription ID if this is a recurring billing sale.

object

Variant selections for the purchase (if product has variants).

object

Custom field values collected at checkout.

object

Shipping information if applicable.

Show Shipping fields

boolean

Whether the order has been marked as shipped.

string

Tracking URL for the shipment.

boolean

Whether this is a recurring billing product.

boolean

Whether the product is a physical good.

string

Cursor for fetching the next page. Only present if there are more results.

string

Full URL for fetching the next page. Only present if there are more results.

Example Request

curl "https://api.gumroad.com/v2/sales?after=2024-01-01&before=2024-12-31" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

curl "https://api.gumroad.com/v2/sales?email=buyer@example.com&product_id=abc123" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

curl "https://api.gumroad.com/v2/sales?page_key=2024-01-15T10:30:45.123456-xyz789" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Example Response

{
  "success": true,
  "sales": [
    {
      "id": "abc123xyz",
      "email": "buyer@example.com",
      "seller_id": "seller456",
      "created_at": "2024-01-15T10:30:45.000Z",
      "product_id": "prod_abc123",
      "product_name": "My Awesome Product",
      "price": 2999,
      "gumroad_fee": 314,
      "formatted_display_price": "$29.99",
      "formatted_total_price": "$29.99",
      "currency_symbol": "$",
      "order_id": 123456789,
      "purchase_email": "buyer@example.com",
      "full_name": "John Doe",
      "purchaser_id": "user_789",
      "refunded": false,
      "partially_refunded": false,
      "chargedback": false,
      "subscription_id": null,
      "variants": {
        "Size": "Large",
        "Color": "Blue"
      },
      "custom_fields": {
        "Company": "Acme Corp"
      },
      "is_recurring_billing": false,
      "is_product_physical": false
    }
  ],
  "next_page_key": "2024-01-15T09:20:30.123456-next123",
  "next_page_url": "/v2/sales?page_key=2024-01-15T09:20:30.123456-next123"
}

Error Codes

error

Bad Request

Invalid date format in before or after parameters (must be YYYY-MM-DD)
Invalid product_id format
Invalid order_id format (must be numeric)
Invalid page_key format

error

Unauthorized - Invalid or missing access token

error

Forbidden - Token does not have view_sales scope

Notes

Results are ordered by creation date (descending) and ID (descending)
Each page returns up to 10 sales
The deprecated page parameter may time out for queries returning large result sets. Use page_key for reliable pagination.
Date filters use the sale’s created_at timestamp
All monetary values are in cents (USD or the product’s currency)

Getting Started

Products

Sales

Licenses

Subscribers

Other Resources

Endpoint

Authentication

Query Parameters

Response

Example Request

Example Response

Error Codes

Notes

​Endpoint

​Authentication

​Query Parameters

​Response

​Example Request

​Example Response

​Error Codes

​Notes

Endpoint

Authentication

Query Parameters

Response

Example Request

Example Response

Error Codes

Notes