all subscriptions
Returns a list of subscriptions you've previously created. The subscriptions will be returned in descending order of when they were created, unless you specify otherwise.
For custom components:
RaiselyComponents.api.one('campaigns', '{campaign}').get('subscriptions', params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
Path parameters
The uuid, path or domain of the campaign to associate with the request
Query parameters
Returns the full record when authenticated
Search query to find records matching
The number of records to limit per page
The pagination offset (in number of records)
The record attribute to filter on (use in conjunction with order)
The direction to sort (only applied if sort is also provided) * asc - Ascending * desc - Descending
Filter Subscription based on their mode value
Filter Subscription based on their status value
Filter subscriptions based on their source value of "OFFLINE" or "ONLINE"
Filter Subscription based on their userUuid value
Filter by designation uuid
Filter by organisation uuid
Filter by profile path or uuid
Filter by user uuid
Include the latest donation for each subscription in the lastDonation field. Ignored unless requesting /users/{uuid}/subscriptions.
Headers
A valid HTTP Bearer token, required to access private records.
Response
The resulting collection of Subscription records
Example response
{
"data": [
{
"amount": 2500,
"anchorDays": [
1,
15
],
"anonymous": true,
"campaignUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"card": "card_aabbccddeeffaabbccddeeff",
"count": 1,
"createdAt": "2020-12-03T06:52:46.330Z",
"currency": "AUD",
"customer": "cus_xxxxxxxxxxxxxx",
"declineCode": "insufficient_funds",
"designationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"email": "harveymilk@example.com",
"error": "Something went wrong",
"failedAt": "2020-12-03T06:52:46.330Z",
"fee": 125,
"feeOptIn": true,
"firstName": "Leila",
"fullName": "Leila Norma Eulalia Josefa Magistrado de Lima",
"interval": "WEEK",
"isExpress": true,
"items": [
{
"amount": 850,
"attendance": "CHECKED_IN",
"campaignAmount": 950,
"status": "ISSUED",
"type": "DONATION"
}
],
"lastName": "de Lima",
"message": "Glad to help out with the fundraising!",
"method": "STRIPE_INTENT",
"methodType": "CARD",
"mode": "LIVE",
"nextPayment": "2020-12-03T06:52:46.330Z",
"pausedAt": "2020-12-03T06:52:46.330Z",
"preferredDay": 12345,
"preferredName": "Norma",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"profile": {
"activityTotal": 2625,
"activityTotalPercent": 2625,
"campaignDisplayTotal": 2625,
"createdAt": "2020-12-03T06:52:46.330Z",
"currency": "AUD",
"description": "I believe in a better world",
"donationCount": 12345,
"donationRecordCount": 12345,
"exerciseGoal": 12345,
"exerciseGoalTime": 12345,
"exerciseTotal": 2625,
"exerciseTotalTime": 2625,
"fundraiserTheme": "birthday",
"goal": 100050,
"individualProfileCount": 12345,
"isCampaignProfile": true,
"name": "Bob D.",
"nonSelfDonationTotal": 2625,
"organisationProfileCount": 12345,
"paid": true,
"path": "bobd",
"photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"selfDonationTotal": 2625,
"shared": true,
"status": "ACTIVE",
"subscriptionCount": 12345,
"teamProfileCount": 12345,
"type": "INDIVIDUAL",
"uniqueDonors": 12345,
"updatedAt": "2020-12-03T06:52:46.330Z",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"user": {
"accessToken": "aaabbbccc",
"address1": "31 Sunset Boulevard",
"address2": "Unit 31b",
"adminSettings": {
"v4BetaOptin": true,
"starredCampaigns": [
"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj"
]
},
"country": "AU",
"createdAt": "2020-12-03T06:52:46.330Z",
"email": "harveymilk@example.com",
"facebookId": "fb_someurl",
"firstName": "Leila",
"fullName": "Leila Norma de Lima",
"internal": {},
"isAdmin": true,
"isSamlLogin": true,
"lastName": "de Lima",
"permission": "PARTICIPANT",
"phoneNumber": "+1 123-456-7890",
"photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
"postcode": "AAA BBBB",
"preferredName": "Norma",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"state": "Victoria",
"status": "ACTIVE",
"suburb": "Melbourne",
"unsubscribedAt": "2020-12-03T06:52:46.330Z",
"updatedAt": "2020-12-03T06:52:46.330Z",
"username": "harveymilk@example.com",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
},
"userUuid": "aaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
},
"profileUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"schedule": "10 days",
"setupIntentId": "seti_xxxxxxxxxxxxxxxxxx",
"source": "OFFLINE",
"status": "OK",
"token": "seti_xxxxxxxxxxxxxxxxxx",
"total": 2625,
"treatAsNewSubscription": true,
"updatedAt": "2020-12-03T06:52:46.330Z",
"user": {
"accessToken": "aaabbbccc",
"address1": "31 Sunset Boulevard",
"address2": "Unit 31b",
"adminSettings": {
"v4BetaOptin": true,
"starredCampaigns": [
"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj"
]
},
"country": "AU",
"createdAt": "2020-12-03T06:52:46.330Z",
"email": "harveymilk@example.com",
"facebookId": "fb_someurl",
"firstName": "Leila",
"fullName": "Leila Norma de Lima",
"internal": {},
"isAdmin": true,
"isSamlLogin": true,
"lastName": "de Lima",
"permission": "PARTICIPANT",
"phoneNumber": "+1 123-456-7890",
"photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
"postcode": "AAA BBBB",
"preferredName": "Norma",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"state": "Victoria",
"status": "ACTIVE",
"suburb": "Melbourne",
"unsubscribedAt": "2020-12-03T06:52:46.330Z",
"updatedAt": "2020-12-03T06:52:46.330Z",
"username": "harveymilk@example.com",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
},
"userUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"pagination": {
"total": 10,
"pages": 2,
"offset": 5,
"limit": 5
}
}