Usage Notes

This method returns a list of the actions allowed for a recurring gift and other information about the configuration of the Gift Service Center.

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"?>
<getRecurringConfigurationResponse 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">
  <allowModifyBillingInformation>true</allowModifyBillingInformation>
  <allowDiscontinuePayments>true</allowDiscontinuePayments>
  <allowSkipNextPayment>true</allowSkipNextPayment>
  <allowModifyGiftAmount>true</allowModifyGiftAmount>
  <allowModifyNextPaymentDate>true</allowModifyNextPaymentDate>
  <showTopNavBar>true</showTopNavBar>
  <htmlContent>&lt;p>content&lt;/p></htmlContent>
  <allowCCOption>true</allowCCOption>
  <allowACHOption>true</allowACHOption>
  <allowACHCanadaOption>false</allowACHCanadaOption>
  <enableCardCvvVerification>true</enableCardCvvVerification>
  <cvvHelpLink>http://www.example.com</cvvHelpLink>
</getRecurringConfigurationResponse>

        

{"getRecurringConfigurationResponse":{"allowCCOption":"true","allowModifyGiftAmount":"true","allowACHCanadaOption":"false","allowACHOption":"true","cvvHelpLink":"http://www.example.com","allowDiscontinuePayments":"true","allowModifyNextPaymentDate":"true","enableCardCvvVerification":"true","htmlContent":"
content","showTopNavBar":"true","allowSkipNextPayment":"true","allowModifyBillingInformation":"true"}}