Usage Notes

This method allows a logged-in user to update the next payment date, amount, or duration of a recurring gift.

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.

amount

Optional. Specifies the new amount of a recurring gift.

Type xsd:nonNegativeInteger.

next_payment_date

Required. Specifies the next payment date of a recurring gift. The date must be in the format MM-DD-YYYY

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.

amount

Optional. Specifies the new amount of a recurring gift.

Type xsd:nonNegativeInteger.

next_payment_date

Required. Specifies the next payment date of a recurring gift. The date must be in the format MM-DD-YYYY

Type xsd:nonNegativeInteger.

duration

Required only when making an update to duration. Specifies the new duration of the recurring gift to retrieve. If forever is desired, 0 should be passed in, otherwise a positive integer.

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"?>
<updateRecurringGiftResponse 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">
  <success>true</success>
  <amountUpdated>true</amountUpdated>
  <amount>
    <decimal>1000</decimal>
    <formatted>$10.00</formatted>
  </amount>
  <nextPaymentDateUpdated>true</nextPaymentDateUpdated>
  <nextPaymentDate>2020-01-28+05:30</nextPaymentDate>
  <durationUpdated>true</durationUpdated>
  <duration>5</duration>
</updateRecurringGiftResponse>

{"updateRecurringGiftResponse":{"amount":{"formatted":"$10.00","decimal":"1000"},"duration":"5","durationUpdated":"true","amountUpdated":"true","nextPaymentDateUpdated":"true","nextPaymentDate":"2016-02-01-06:00","success":"true"}}