latestOpenAPI 3.0.02026-08-1535120202.6 KB
f59881dadecd
Recurring plans
Get recurring plans
This request allows you to read your Fundraise Up recurring plan records. The supporter data will be displayed as it appears on the Recurring plan page in your Dashboard.
get/v1/recurring_plans
Query parameters
livemodeboolean
Example:true
Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026.
starting_afterstring
A cursor for pagination. Returns records older than the specified object ID.
ending_beforestring
A cursor for pagination. Returns records newer than the specified object ID.
limitinteger
This parameter specifies the number of records to display per page, ranging from 1 to 100
{
"created[gt]": "2025-01-01T12:30:00+02:00",
"created[gte]": "2025-01-01T12:30:00+02:00",
"created[lt]": "2025-01-01T12:30:00+02:00",
"created[lte]": "2025-01-01T12:30:00+02:00"
}Response
On success, the API returns the list of recurring plans. The response includes the recurring plan data array and a boolean indicating if more records are available.
Example response
{
"data": [
{
"account": {
"code": "Code-1",
"id": "AXXXXXXX",
"name": "Example Account"
},
"amount": "99.99",
"amount_before_fees_covered": "99.99",
"amount_before_fees_covered_in_default_currency": "59.99",
"amount_in_default_currency": "59.99",
"benefit": {
"code": "TSHIRT-001",
"fair_market_value": "25.99",
"fair_market_value_currency": "usd",
"id": "GXXXXXXX",
"name": "T-shirt",
"option": {
"code": "SIZE-M",
"name": "Size",
"value": "M"
},
"shipping": {
"address": {
"city": "Nashville",
"country": "us",
"line1": "123 Example St.",
"line2": "Apt. 1",
"postal_code": "111111",
"region": "Tennessee"
},
"recipient_first_name": "Alex",
"recipient_last_name": "Garcia"
}
},
"campaign": {
"code": "Code-1",
"id": "FUNXXXXXXXX",
"name": "My Campaign"
},
"cancellation_details": "Moving to a different organization",
"cancellation_reason": "financial_difficulty",
"comment": "comment example",
"consent": {
"customized": {
"email": "opted_in",
"phone_calls": "opted_out",
"postal_mail": "opted_in",
"sms": "opted_in",
"social_media": "opted_out"
},
"general": "opted_in"
},
"created_at": "2024-12-20T00:00:00.000Z",
"currency": "usd",
"custom_fields": [
{
"name": "Field1",
"value": "Value1"
}
],
"designation": {
"code": "Code-1",
"id": "EXXXXXXX",
"name": "My Designation"
},
"device": {
"browser": "Chrome",
"ip": {
"address": "111.111.111.111",
"city": "Nashville",
"country_name": "United States",
"region": "Tennessee"
},
"os": "MacOS",
"type": "desktop",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"
},
"element": {
"id": "XXXXXXXX",
"name": "My Element",
"type": "donationForm"
},
"ended_at": "2024-12-20T00:00:00.000Z",
"frequency": "monthly",
"fundraiser": {
"id": "NXXXXXXX",
"name": "Run for hope"
},
"gift_aid": {
"claimed": true,
"legal_text": "I am a UK taxpayer and want to claim Gift Aid."
},
"id": "RXXXXXXX",
"livemode": true,
"next_installment_at": "2024-12-20T00:00:00.000Z",
"on_behalf_of": "Example Inc.",
"payment": {
"bank_account": {
"last4": "1234"
},
"credit_card": {
"exp_month": "12",
"exp_year": "2023",
"last4": "1234",
"type": "Visa"
},
"email": "example@example.com",
"error_message": "Something went wrong",
"method": "paypal",
"processor": "stripe"
},
"questions": [
{
"code": "Code-1",
"id": "QXXXXXXX",
"checked": true,
"options": [
"OK",
"Good"
],
"text": "Example answer"
}
],
"source": "website",
"status": "active",
"supporter": {
"address": {
"city": "Nashville",
"country": "us",
"line1": "123 Example St.",
"line2": "Apt. 1",
"postal_code": "111111",
"region": "Tennessee"
},
"email": "example@example.com",
"employer": {
"name": "Fundraise Up Inc."
},
"employment_status": "employed",
"first_name": "Alex",
"id": "SXXXXXXXX",
"language": "en-CA",
"last_name": "Garcia",
"occupation": "Software Engineer",
"phone": "+1 (111) 111111",
"title": "mr"
},
"supporter_covered_fee": "9.99",
"supporter_covered_fee_in_default_currency": "99.9",
"tribute": {
"honoree": "Zhang Wei",
"id": "TXXXXXXX",
"sharing": {
"from": "Alex Garcia",
"message": "In loving memory of Jordan",
"recipient": {
"address": {
"city": "Nashville",
"country": "us",
"line1": "123 Example St.",
"line2": "Apt. 1",
"postal_code": "111111",
"region": "Tennessee"
},
"email": "example@example.com",
"first_name": "Sidney",
"last_name": "Jones",
"title": "mr"
},
"type": "email"
},
"type": "in_honor"
},
"url": "https://example.com/RXXXXXXX",
"utm": {
"campaign": "giving_tuesday",
"content": "textlink",
"medium": "email",
"source": "google",
"term": "how_to_support_penguins"
}
}
],
"has_more": true
}