Monthly giving at a club: donations with the Charitips API
A sports club gives 5 € a month for each member who turns it on. The member picks the charity once; Charitips gives on the 1st and bills the club; pause or stop at any time.
- Who paysYour company
- Starts withEvery period
- Tax receiptIn your company's name
Needs API access on a validated account. Plans
One variant of Monthly giving by your users · Health and sport
5 € a month for each member who turns it on
See every variantyour-club.example/account/giving
Step by step
Click through the site. Each step shows what your customer does, what your server sends and what Charitips answers.
1Monthly giving on
To comeYour customer does…
Clicks “Give 5 € a month”.
Your server sends…
Sets up a recurring donation of 5 € for Camille Martin on the campaign “Monthly giving”.
Assigns that recurring donation to the charity your customer picks.
Charitips answers…
Charitips creates it and returns its id; it waits for a charity.
It is active: this month's donation goes to the charity your customer picks now.
Charitips will then tell your server the recurring donation was created.
2Monthly donation made
To comeYour customer does…
Clicks “Simulate 1 November”.
Your server sends…
On the 1st of each month, Charitips makes the donation of every active recurring donation, at most one a month, and bills it to your company. Nothing to call; a paused or stopped one is skipped.
Charitips answers…
Charitips will then tell your server the donation was created.
3Giving paused
To comeYour customer does…
Clicks “Pause”.
Your server sends…
Pauses that recurring donation.
Charitips answers…
It is paused; the charity stays saved.
Charitips will then tell your server the recurring donation changed.
4Giving resumed
To comeYour customer does…
Clicks “Resume giving”.
Your server sends…
Resumes that recurring donation.
Charitips answers…
It is active again.
Charitips will then tell your server the recurring donation changed.
5Giving stopped
To comeYour customer does…
Clicks “Stop giving”.
Your server sends…
Stops that recurring donation for good.
Charitips answers…
It is stopped and cannot be restarted.
Charitips will then tell your server the recurring donation changed.
How to read this demo: the site shows what your customer does, and the panel what your server sends and what Charitips answers, step by step.
The site is made up and nothing is sent. The endpoints, fields and webhook events are the real ones, and so are the charities.
How it works
The screens of the demo in order, with the calls your server makes at each one. Its build spec
recurringdonation_createdonation_createrecurringdonation_updateOnce, before the first customer
- POST /v1/charities-selectionsCreate a charities selection: once: the charities you offer, from the catalog
- POST /v1/campaignsCreate a campaign: once: the recurring campaign, every month from its first date
- POST /v1/campaigns/{campaignId}/activateActivate a campaign: once: the campaign starts taking recurring donations
01
Give 5 € a month to a charity, on us
The member picks a charity, then turns monthly giving on in one click. Your server creates the member's recurring donation and claims it for that charity straight away: the first 5 € is given at once. Your company pays every donation and gets the fiscal receipt.
The customer picks a charity from your selection. Button: Give 5 € a month
Your server calls:
- POST /v1/recurring-donationsCreate a recurring donation: when the member turns it on, on the recurring campaign; the member's name and email, as Charitips emails them each month; amount in cents; keep the recurringDonationId with the member
- POST /v1/recurring-donations/{recurringDonationId}/claimClaim a recurring donation: right after, with the charity the member chose: the recurring donation turns ACTIVE and this month's donation is made at once (recurringdonation_update, donation_create)
Charitips then sends the
recurringdonation_createwebhook to your endpoint.02
1 November
On the 1st of each month, Charitips makes the donation of every active recurring donation, at most one a month, and bills it to your company. Nothing to call; a paused or stopped one is skipped.
- Monthly donation: 5,00 €
Button: Simulate 1 November
No call: this screen only shows the result.
Charitips then sends the
donation_createwebhook to your endpoint.03
Pause
The member pauses: nothing is given or billed on the 1st while it is paused.
Button: Pause
Your server calls:
- POST /v1/recurring-donations/{recurringDonationId}/pausePause a recurring donation: recurringDonationId kept with the member; the charity stays saved
Charitips then sends the
recurringdonation_updatewebhook to your endpoint.04
Resume
Giving starts again from the next 1st, to the same charity.
Button: Resume giving
Your server calls:
- POST /v1/recurring-donations/{recurringDonationId}/resumeResume a recurring donation: only a paused recurring donation can be resumed
Charitips then sends the
recurringdonation_updatewebhook to your endpoint.05
Stop monthly giving
The member stops. The donations already made stay with the charity; nothing more is given.
Button: Stop giving
Your server calls:
- POST /v1/recurring-donations/{recurringDonationId}/cancelCancel a recurring donation: final: a stopped recurring donation cannot be claimed again (409); turning giving on again creates a new one
Charitips then sends the
recurringdonation_updatewebhook to your endpoint.