Monthly giving by your users

Build it

The calls behind the demo, in order. Each step shows the request your server sends.

1. 1

   Create a charities selection

   Once, create the selection of charities your users can give to with Create a charities selection. Get the charity ids from List charities.

   cURLNode.jsPythonPrompt

   POST /v1/charities-selections

   1curl -X POST https://api.sandbox.charitips.com/v1/charities-selections \2  -H "Authorization: Bearer $CHARITIPS_TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5    "name": "Monthly giving selection",6    "charityIds": [7      "ca68f22c-2fdf-48b1-b8f6-43c3073e83bb",8      "1cccaa7c-cc5e-4dc8-9978-fc2de5f5d7b3",9      "0d65b4e6-f663-4ec7-b69d-0da5e7e8b2ee"10    ]11  }'

   Built from the spec and the API code

   Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.

2. 2

   Create the recurring campaign

   Once, create the campaign with its charitiesSelectionId and a frequency, an ISO 8601 recurring interval such as R/2026-11-01/P1M for once a month from 1 November 2026. Then activate it and keep its campaignId. Every donation on this campaign is a recurring donation, and the campaign is FREE_AMOUNT: with amountType set to FIXED_AMOUNT, creating it answers 400 Recurring campaigns must be FREE_AMOUNT campaigns.

   cURLNode.jsPythonPrompt

   POST /v1/campaigns

   1curl -X POST https://api.sandbox.charitips.com/v1/campaigns \2  -H "Authorization: Bearer $CHARITIPS_TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5    "name": "Monthly giving",6    "charitiesSelectionId": "<charitiesSelectionId>",7    "frequency": "R/2026-11-01/P1M"8  }'

   Built from the spec and the API code

   Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.

3. 3

   Create a recurring donation

   When a user turns monthly giving on, call Create a recurring donation. amount is in cents: 1000 is 10 €. The donor's first name, last name and email are required, as Charitips emails them every month. Keep the recurringDonationId with the user.

   cURLNode.jsPythonPrompt

   POST /v1/recurring-donations

   1curl -X POST https://api.sandbox.charitips.com/v1/recurring-donations \2  -H "Authorization: Bearer $CHARITIPS_TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5    "campaignId": "<campaignId>",6    "amount": 1000,7    "donorFirstName": "John",8    "donorLastName": "Doe",9    "donorEmail": "john@doe.com"10  }'

   Built from the spec and the API code

   Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.

4. 4

   Claim it for the chosen charity

   Claim the recurring donation with the charity the user picked, using Claim a recurring donation. Once the campaign has started, the first donation is made at once, then a new one every month. To change charity, claim it again with the new charityId.

   cURLNode.jsPythonPrompt

   POST /v1/recurring-donations/<recurringDonationId>/claim

   1curl -X POST https://api.sandbox.charitips.com/v1/recurring-donations/<recurringDonationId>/claim \2  -H "Authorization: Bearer $CHARITIPS_TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5    "charityId": "<charityId>"6  }'

   Built from the spec and the API code

   Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.

5. 5

   Pause or resume giving

   Pause a recurring donation with Pause a recurring donation: nothing is given or billed while it is paused. Resume a recurring donation starts giving again from the next month, to the same charity.

   cURLNode.jsPythonPrompt

   POST /v1/recurring-donations/<recurringDonationId>/pause

   1curl -X POST https://api.sandbox.charitips.com/v1/recurring-donations/<recurringDonationId>/pause \2  -H "Authorization: Bearer $CHARITIPS_TOKEN"

   Built from the spec and the API code

   Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.

6. 6

   Stop giving

   Stop a recurring donation with Cancel a recurring donation. The donations already made stay with the charity. A canceled recurring donation cannot be claimed again (409): to start again, create a new one.

   cURLNode.jsPythonPrompt

   POST /v1/recurring-donations/<recurringDonationId>/cancel

   1curl -X POST https://api.sandbox.charitips.com/v1/recurring-donations/<recurringDonationId>/cancel \2  -H "Authorization: Bearer $CHARITIPS_TOKEN" \3  -H "Content-Type: application/json" \4  -d '{}'

   Built from the spec and the API code

   Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.

7. 7

   Billing and receipts

   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 account. Your company funds these donations, so the fiscal receipt goes to your company, once a year by default.