GET /v1/subscriptions endpoint returns recurring subscription records for your merchant account. Each subscription represents a donor who has committed to a repeating gift at a fixed frequency and amount. You can filter by status to target active donors or review cancellations. This endpoint requires the subscriptions:read permission on your API key.
Request
Maximum number of subscriptions to return per page. Accepts values between 1 and 100.
Pagination cursor returned by a previous response. Pass this value to retrieve the next page of results. Omit on the first request.
Filter results by subscription status. Accepted values:
ACTIVE, CANCELLED. Omit to return all subscriptions regardless of status.Response
The Subscription object never includes the display-currency fields (
displayCurrency, displayAmount, fxRate, fxRateTableId, fxRateAsOf) or lastChargeFx. They are display only (every charge, refund and payout stays in USD) and arrive on the subscription.created, subscription.updated and subscription.cancelled webhooks. See Display-currency fields.Pagination cursor for the next page. Pass this as the
lastEvaluatedKey query parameter on your next request. Absent when hasMore is false.Example
Response