Get Subscription By Id

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/subscriptions/{donorId}/{subscriptionId} \
  --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
  }
}

GET

api

subscriptions

{donorId}

{subscriptionId}

Get Subscription By Id

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/subscriptions/{donorId}/{subscriptionId} \
  --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
  }
}

Authorizations

x-client-id

string

header

required

Client ID for API authentication

Path Parameters

donorId

string

required

The Id of the donor to get the subscription for.

Example:

"2ea1ae03ca521e437db76d76"

subscriptionId

string

required

The Id of the subscription to get.

Example:

"2ea1ae03ca521e437db76d76"

Response

Subscription

data

object

required

Subscription.

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

Get Subscriptions Cancel Subscription

⌘I

Start Here

Contributions

Donors

Subscriptions

Payment Methods

Campaigns

Status

Get Subscription By Id

Authorizations

Path Parameters

Response