Orders

List orders

GET/v1/orders

Lists the orders of the agency, most recent first, including the EUR conversion and the employee attribution computed by Fansquare. Results can be filtered by creator, fan, date range and order type.

Required scoperead:orders

Rate limit30 requests per minute

curl 'https://api.fansquare.so/v1/orders' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "data": [
    {
      "id": "b387813a-7210-4db8-affc-a11197ea9002",
      "external_id": "45e1ccbf-f63f-4198-aa97-f1998abff33d",
      "order_date": "2026-10-12T21:14:00.000Z",
      "order_type": "tip",
      "gross_amount": 4900,
      "net_amount": 3920,
      "currency": "EUR",
      "creator_id": "m81IhLxdhzDGYs54rNp2",
      "fan_id": "a6df8022-e509-4575-ad28-e29c2d1d42dc",
      "fan_username": "alex_92",
      "attribution": {
        "user_id": "ki9DZXxpgGz7KiDqHj88eCxHg56W",
        "method": "message_link",
        "attributed_at": "2026-10-12T21:14:00.000Z"
      }
    }
  ],
  "next_cursor": "KI7cfD0OLcWfeXZb1FTusJpz0nfKiYXPwHCZe-VXBaeQSX1w5BvO5UH-ua-dzNpXOTixzw"
}

Parameters

Headers

Fansquare-Versionstringrequired
API version to pin. Accepts the mineral name or the release date of a version.

Query

creator_idsstring
Restrict to these creators (Fansquare ids from GET /v1/creators). Comma-separated, 50 max.
fan_idsstring
Restrict to these fans (MYM fan ids). Comma-separated, 50 max.
startstring
Only orders placed at or after this date (ISO 8601, inclusive).
format date-time
endstring
Only orders placed before this date (ISO 8601, exclusive).
format date-time
order_typesstring
Restrict to these order types. Values: tip, subscription, subscription_renewal, booking, push, mod, fan_to_creator, creator_to_fan, private_media, affiliate. Comma-separated, 50 max.
cursorstring
Opaque cursor from the previous page (next_cursor).
limitinteger
Page size (1-200).
Default 50min 1max 200

Response

OK, application/json

dataarray of objectsrequired
idstringrequired
Fansquare order id. Path parameter for GET /v1/orders/{order_id}.
external_idstringrequired
MYM order id. Not usable as a path parameter.
order_datestringrequired
When the order was placed (ISO 8601).
format date-time
order_typestringrequired
Kind of sale. New MYM order types can appear: treat an unknown value as a generic sale.
Valuestipsubscriptionsubscription_renewalbookingpushmodfan_to_creatorcreator_to_fanprivate_mediaaffiliate
gross_amountinteger | nullrequired
Gross revenue, integer cents, in currency.
net_amountinteger | nullrequired
Net revenue, integer cents, in currency.
currencystringrequired
Currency of the amounts. Fansquare converts every order to EUR.
creator_idstringrequired
Fansquare creator id (see GET /v1/creators).
fan_idstring | nullrequired
MYM fan id of the buyer. Usable as fan_id on the /v1/accounts routes.
fan_usernamestring | nullrequired
MYM username of the buyer, when known.
attributionobject | nullrequired
Employee credited for this sale, as tracked by Fansquare. Read-only. null when unattributed.
user_idstringrequired
Fansquare employee id the sale is credited to. May reference a former employee absent from GET /v1/employees.
methodstringrequired
How the sale was credited: message_link (the order pays for a message the employee sent), last_sender_auto (the last employee who wrote to the fan before the order), manual (set by hand in Fansquare).
Valuesmessage_linklast_sender_automanual
attributed_atstringrequired
When the sale was credited (ISO 8601).
format date-time
next_cursorstring | nullrequired

curl 'https://api.fansquare.so/v1/orders' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste"

{
  "data": [
    {
      "id": "b387813a-7210-4db8-affc-a11197ea9002",
      "external_id": "45e1ccbf-f63f-4198-aa97-f1998abff33d",
      "order_date": "2026-10-12T21:14:00.000Z",
      "order_type": "tip",
      "gross_amount": 4900,
      "net_amount": 3920,
      "currency": "EUR",
      "creator_id": "m81IhLxdhzDGYs54rNp2",
      "fan_id": "a6df8022-e509-4575-ad28-e29c2d1d42dc",
      "fan_username": "alex_92",
      "attribution": {
        "user_id": "ki9DZXxpgGz7KiDqHj88eCxHg56W",
        "method": "message_link",
        "attributed_at": "2026-10-12T21:14:00.000Z"
      }
    }
  ],
  "next_cursor": "KI7cfD0OLcWfeXZb1FTusJpz0nfKiYXPwHCZe-VXBaeQSX1w5BvO5UH-ua-dzNpXOTixzw"
}