REST

getRecurringGifts

Returns the recurring gifts associated with a single constituent.
Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRRecurringAPISRRecurringAPIGET, POSTYes.

Client API Syntax

https://secure2.convio.net/organization/site/CRRecurringAPI?method=getRecurringGifts
[ &auth=value ] [ &sso_auth_token=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRRecurringAPI?method=getRecurringGifts
&cons_id=value

Usage Notes

This method returns the list of recurring gifts for a specified constituent.

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:

Client API Parameters

Common Client Parameters
See topic Common Parameters.

Server API Parameters

Common Server Parameters
See topic Common Parameters.
cons_id
Required. Specifies the ID of the constituent.
Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<getRecurringGiftsResponse 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">
   <recurringGift>
      <tenderType>CREDIT_CARD</tenderType>
      <title>fake title</title>
      <id>1</id>
      <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>
      <tenderInstance>MASTER</tenderInstance>
   </recurringGift>
</getRecurringGiftsResponse>
JSON response
JSON 
{
  "getRecurringGiftsResponse": {
    "recurringGift": {
      "tenderType": "CREDIT_CARD",
      "previousPaymentDate": "2024-10-03+05:30",
      "nextPaymentDate": "2024-10-03+05:30",
      "amount": {
        "formatted": "$10.00",
        "decimal": "10.00"
      },
      "tenderInstance": "MASTER",
      "id": "1",
      "title": "fake title",
      "creditInfo": {
        "expirationYear": "2024",
        "expirationMonth": "10",
        "maskedCreditCardNumber": "************1234"
      },
      "frequency": "monthly"
    }
  }
}