Get Subscriptions

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/subscriptions \
  --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
    }
  ],
  "totalCount": 100
}

GET

api

subscriptions

Get Subscriptions

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/subscriptions \
  --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
    }
  ],
  "totalCount": 100
}

Authorizations

x-client-id

string

header

required

Client ID 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,

pending,

recreated

Example:

["active"]

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.

Show child attributes

data.id

string

required

Subscription Id.

Example:

"6710f34fd5061afeec3eab57"

data.donorId

string

required

Id of the Donor Profile.

Example:

"6710f34fd5061afeec3eab57"

data.createdAt

string<date-time>

required

Subscription created at.

Example:

"2025-01-01T00:00:00.000Z"

data.updatedAt

string<date-time>

required

Subscription updated at.

Example:

"2025-01-01T00:00:00.000Z"

data.startDate

string<date-time>

required

Subscription start date.

Example:

"2025-01-01T00:00:00.000Z"

data.status

enum<string>

required

Subscription status.

Available options:

active,

failed,

inactive,

pending,

recreated

Example:

"active"

data.amount

number

required

Subscription amount.

Example:

50

data.anonymous

boolean

required

Whether the donor wants the subscription to be anonymous.

Example:

false

data.frequency

enum<string>

required

Subscription frequency.

Available options:

biweekly,

monthly,

weekly

Example:

"weekly"

data.nextPaymentDate

string<date-time> | null

required

Subscription next payment date.

Example:

"2025-01-01T00:00:00.000Z"

data.paymentMethod

object

required

Subscription payment method.

Show child attributes

data.paymentMethod.id

string

required

data.paymentMethod.type

enum<string>

required

Available options:

bank,

card,

wallet

data.paymentMethod.last4

string

required

data.paymentMethod.expiration

string

required

data.paymentMethod.holderName

string

Example:

{
  "id": "6710f34fd5061afeec3eab57",
  "holderName": "John Doe",
  "type": "card",
  "last4": "4242",
  "expiration": "12/2025"
}

data.campaign

object

required

Campaign details for the contribution

Show child attributes

data.campaign.id

string

required

data.campaign.name

string

required

Example:

{
  "id": "7710f34fd5061afeec3eab78",
  "name": "Mission 2025"
}

data.subcampaign

object

required

Subcampaign details for the contribution

Show child attributes

data.subcampaign.id

string

required

data.subcampaign.name

string

required

Example:

{
  "id": "7710f34fd5061afeec3eab79",
  "name": "Toy Drive"
}

data.donorCoveredFees

boolean

default:false

Whether the donor is covering fees.

Example:

false

totalCount

number

required

Total number of subscriptions matching the filters.

Example:

100

Create Subscription Get Subscription By Id

⌘I

Start Here

Contributions

Donors

Subscriptions

Payment Methods

Campaigns

Status

Get Subscriptions

Authorizations

Query Parameters

Response