Skip to main content
GET
/
api
/
v3
/
subscriptions
Get Subscriptions
curl --request GET \
  --url https://server.stage.overflow.co/api/v3/subscriptions \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>'
{
  "data": [
    {
      "id": "6710f34fd5061afeec3eab57",
      "donorId": "6710f34fd5061afeec3eab57",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z",
      "startDate": "2025-01-01T00:00:00.000Z",
      "status": "active",
      "amount": 50,
      "anonymous": false,
      "frequency": "weekly",
      "nextPaymentDate": "2025-01-01T00:00:00.000Z",
      "paymentMethod": {
        "id": "6710f34fd5061afeec3eab57",
        "holderName": "John Doe",
        "type": "card",
        "last4": "4242",
        "expiration": "12/2025"
      },
      "campaign": {
        "id": "7710f34fd5061afeec3eab78",
        "name": "Mission 2025"
      },
      "subcampaign": {
        "id": "7710f34fd5061afeec3eab79",
        "name": "Toy Drive"
      },
      "donorCoveredFees": false,
      "metadata": {
        "orderId": "abc-123"
      },
      "locationId": "6710f34fd5061afeec3eab57"
    }
  ],
  "totalCount": 100
}

Documentation Index

Fetch the complete documentation index at: https://docs.overflow.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-client-id
string
header
required

Client ID for API authentication

​
x-api-key
string
header
required

API Key for API authentication

Query Parameters

​
limit
number
default:25

The number of subscriptions to return.

Required range: 1 <= x <= 100
​
maximumUpdatedDate
string<date-time>

The maximum updated date of the subscriptions to return.

Example:

"2025-02-01"

​
minimumUpdatedDate
string<date-time>

The minimum updated date of the subscriptions to return.

Example:

"2025-01-01"

​
page
number
default:1

The page number of the subscriptions to return.

Required range: x >= 1
​
status
enum<string>[]

The status of the subscriptions to return.

Available options:
active,
failed,
inactive,
paused,
pending,
recreated
Example:
["active"]
​
locationIds
string[]

Filter subscriptions by location Ids.

Example:
["6710f34fd5061afeec3eab57"]
​
sortBy
enum<string>
default:createdAt

The field to sort the subscriptions by.

Available options:
amount,
createdAt,
frequency,
nextContributionAt
Example:

"createdAt"

​
sortDirection
enum<string>
default:DESC

The direction to sort the subscriptions by.

Available options:
ASC,
DESC
Example:

"DESC"

Response

200 - application/json
​
data
object[]
required

List of subscriptions.

​
totalCount
number
required

Total number of subscriptions matching the filters.

Example:

100