Usage Notes

This method allows a logged-in user or an administrative process to cancel all future payments on a recurring gift or pledge. It does not refund payments already processed. To refund payments use refundTransaction.

You may use the following methods to allow a logged-in user to manage their recurring gifts themselves via the Client API or to manage recurring gifts as an administrator via the Server API:

• calculateNextPaymentDate
• cancelRecurringGift
• getRecurringConfiguration
• getRecurringGiftDetails
• getRecurringGifts
• getRecurringHistory
• skipNextPayment
• updateRecurringBankAccountInfo
• updateRecurringCreditCardInfo
• updateRecurringGift_method

Client API Parameters

Common Client Parameters

See topic Common Parameters.

recurring_gift_id

Required. Specifies the ID of the recurring gift to retrieve.

Type xsd:nonNegativeInteger.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

recurring_gift_id

Required. Specifies the ID of the recurring gift to retrieve.

Type xsd:nonNegativeInteger.

cons_id

Required. Specifies the ID of the constituent.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8"?>
<cancelRecurringGiftResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <canceled>true</canceled>
</cancelRecurringGiftResponse>


        

{"cancelRecurringGiftResponse":{"canceled":"true"}}