Skip to main content
The GET /v1/subscriptions/{id} endpoint returns a single subscription record. Use this endpoint to check a specific donor’s recurring gift details — including the next billing date, current amount, and whether the subscription is still active. This endpoint requires the subscriptions:read permission on your API key.

Path parameters

id
string
required
The unique identifier of the subscription to retrieve, for example sub_01HABC1234MNOPQR.

Response

On success the endpoint returns a single Subscription object.
id
string
required
Unique identifier for the subscription.
status
string
required
Subscription status. One of: ACTIVE, CANCELLED.
amount
number
required
Recurring charge amount in US dollars.
frequency
string
required
Billing frequency. One of: DAILY, WEEKLY, MONTHLY, ANNUALLY.
nextBillingDate
string
required
ISO 8601 date of the next scheduled charge.
lastBillingDate
string
required
ISO 8601 date of the most recent successful charge.
endBillingDate
string
required
ISO 8601 date when the subscription is scheduled to end.
coveredFee
boolean
required
Whether the donor elected to cover processing fees on each charge.

Example

curl https://0k90mc4jjj.execute-api.us-east-2.amazonaws.com/v1/subscriptions/sub_01HABC1234MNOPQR \
  -H "Authorization: Bearer cs_live_your_key"
Response
{
  "id": "sub_01HABC1234MNOPQR",
  "status": "ACTIVE",
  "amount": 25.00,
  "frequency": "MONTHLY",
  "nextBillingDate": "2025-05-14T00:00:00Z",
  "lastBillingDate": "2025-04-14T00:00:00Z",
  "endBillingDate": "2026-04-14T00:00:00Z",
  "coveredFee": false
}