---
title: "List sales"
method: GET
path: "/v1/sales"
tags: ["Sales"]
---

# List sales

`GET /v1/sales`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/sales`
- Auth: HTTP bearer

**Scope:** `read`

## Query parameters

- `program_id` string, required: Required on every list
- `limit` string: 1 to 100, default 25
- `starting_after` string: Object id; returns the page after it (older)
- `ending_before` string: Object id; returns the page before it (newer)
- `expand[]` union: Relations to embed: partner, customer
  - string
  - string[]
- `include[]` union: Nothing to include on this resource
  - string
  - string[]
- `partner_id` string
- `customer_id` string
- `occurred_after` string
- `occurred_before` string
- `refunded` 'true' | 'false'

## Response `200`

Sales

- SaleList
  - `data` Sale[], required
    - `id` string, required: Prefixed id (`sale_…`)
    - `object` 'sale', required
    - `program_id` string, required: Prefixed id (`prg_…`)
    - `customer_id` string, required: Prefixed id (`cus_…`)
    - `partner_id` string, required: Prefixed id (`part_…`)
    - `external_charge_id` string, required
    - `external_payment_intent_id` string, nullable, required
    - `processor` 'stripe' | 'paddle' | 'chargebee' | 'manual' | 'api', required
    - `amount_minor` integer, required: Integer minor units (cents, pence). Never a float, never a string.
    - `tax_minor` integer, nullable, required: Integer minor units (cents, pence). Never a float, never a string.
    - `currency` string, required: ISO-4217
    - `billing_type` 'one_time' | 'subscription', required
    - `interval` 'day' | 'week' | 'month' | 'year' | 'null', nullable, required
    - `product_id` string, nullable, required
    - `product_name` string, nullable, required
    - `is_first_sale` boolean, required
    - `occurred_at` string, date-time, required: ISO-8601, UTC
    - `refunded_at` string, date-time, nullable, required: ISO-8601, UTC
    - `metadata` object, nullable, required: Your own key/value data, stored as given
    - `created_at` string, date-time, required: ISO-8601, UTC
    - `updated_at` string, date-time, required: ISO-8601, UTC
  - `has_more` boolean, required: Pass the last object's id as `starting_after` to fetch the next page
  - `total_count` integer, required: Count of every object matching the filters, ignoring the cursor

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)