Subscriptions
add subscription
Creates a new subscription (otherwise known as a regular donation) in Raisely. External applications may use this endpoint to import regular donations created offline into Raisely, as long as you have tokenised card details in Stripe.
To create a new subscription, you need to have a customer and card in Stripe, then set the source to OFFLINE. If you omit the nextPayment date, a payment will be taken immediately, otherwise it will be taken after the date specified.
This endpoint must be authenticated.
Note: Raisely charges processing fees for imported subscriptions. Contact us for more information.
For custom components:
RaiselyComponents.api.all('subscriptions').post(data = {}, params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
post/subscriptions
Query parameters
privateboolean
Returns the full record when authenticated
Headers
Authorizationstring
A valid HTTP Bearer token, required to access private records.
Request body
Example request
{
"data": {
"amount": 2500,
"anchorDays": [
1,
15
],
"anonymous": true,
"card": "card_aabbccddeeffaabbccddeeff",
"count": 1,
"currency": "AUD",
"customer": "cus_xxxxxxxxxxxxxx",
"email": "harveymilk@example.com",
"firstName": "Leila",
"fullName": "Leila Norma Eulalia Josefa Magistrado de Lima",
"interval": "WEEK",
"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",
"nextPayment": "2020-12-03T06:52:46.330Z",
"preferredDay": 12345,
"preferredName": "Norma",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"source": "OFFLINE",
"token": "seti_xxxxxxxxxxxxxxxxxx",
"treatAsNewSubscription": true
}
}Response
The created Subscription record
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"
},
"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"
}
}