skipNextPayment

Skips the next payment for a recurring gift.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRRecurringAPI SRRecurringAPI POST Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRRecurringAPI?method=skipNextPayment &api_key=value &v=value &recurring_gift_id=value [ &auth=value ] [ &sso_auth_token=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRRecurringAPI?method=skipNextPayment & api_key =value & login_name =value & login_password =value & v =value & recurring_gift_id =value & cons_id =value

Usage Notes

This method causes the system to skip the next scheduled payment in a series of payments on 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:

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 response
<?xml version="1.0" encoding="UTF-8"?>
<skipNextPaymentResponse 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>
</skipNextPaymentResponse>
JSON response
{"skipNextPaymentResponse":{"success":"true"}}

        

Leave a Comment

Nickname
Comment
Enter this word: