Usage Notes

This method returns information about a recurring gift, including last payment and next payment dates, amount, duration and frequency, payment card and billing information.

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"?>
<getRecurringGiftDetailsResponse 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">
  <recurringGiftDetails>
    <id>1</id>
    <title>Fake Campaign - Fake Form</title>
    <tenderType>CREDIT_CARD</tenderType>
    <creditInfo>
      <maskedCreditCardNumber>************1234</maskedCreditCardNumber>
      <expirationMonth>10</expirationMonth>
      <expirationYear>2018</expirationYear>
    </creditInfo>
    <nextPaymentDate>2018-10-03-05:00</nextPaymentDate>
    <previousPaymentDate>2018-10-03-05:00</previousPaymentDate>
    <amount>
      <decimal>10.00</decimal>
      <formatted>$10.00</formatted>
    </amount>
    <frequency>monthly</frequency>
    <billingName>
      <first>John</first>
      <last>Doe</last>
    </billingName>
    <billingAddress>
      <street1>11500 Fake Street</street1>
      <city>New York City</city>
      <state>NY</state>
      <zip>12345</zip>
    </billingAddress>
  </recurringGiftDetails>
</getRecurringGiftDetailsResponse>

 
        

{"getRecurringGiftDetailsResponse":{"recurringGiftDetails":{"tenderType":"CREDIT_CARD","previousPaymentDate":"2018-10-03-05:00","nextPaymentDate":"2018-10-03-05:00","amount":{"formatted":"$10.00","decimal":"10.00"},"id":"1","billingName":{"last":"Doe","first":"John"},"billingAddress":{"zip":"12345","city":"New York City","street1":"11500 Fake Street","state":"NY"},"title":"Fake Campaign - Fake Form","creditInfo":{"expirationYear":"2018","expirationMonth":"10","maskedCreditCardNumber":"************1234"},"frequency":"monthly"}}}