Cancel a Recurring Gift
Cancels a recurring gift so no further payments are taken, and returns the recurring gift with its updated status.
Authorizations
JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
Path Parameters
The ID of the recurring gift.
Response
OK
Represents a model for recurring gifts.
The unique identifier for the recurring gift.
The unique identifier of the organization.
The created date (localized and formatted).
The modified date (localized and formatted).
The profile number for the recurring gift.
The amount charged each cycle.
The currency code for the recurring gift.
The base currency code for the recurring gift, if applicable.
The formatted recurring gift amount.
The donor associated with the recurring gift.
The frequency of the recurring gift.
0, 1, 2, 4, 12, 26, 52, 100 The formatted frequency display value.
The total amount for the recurring gift.
The total amount, formatted for display in its currency.
The number of successful cycles.
The start date of the recurring gift.
The formatted start date (localized).
The date of the next scheduled charge.
The formatted next charge date.
The next charge date formatted for editing.
The status of the recurring gift.
1, 2, 3, 4, 5, 6 The display text for the status.
The unique identifier of the payment gateway the recurring gift is charged through.
The name of the payment gateway the recurring gift is charged through.
A summary of the payment method being charged.
The expiration month and year for the card.
The brand of the card being charged, such as Visa or Mastercard.
The payment method country code.
The project allocations for the recurring gift.
Whether the gift was given anonymously.
Whether the gift is in test mode.
Whether the donor covers processing costs.
The motivation code the recurring gift came in under.
The source code the recurring gift came in under.
The unique identifier of the segment.
The name of the segment.
The code of the segment the gift came in under.
The notes for the recurring gift.
The comments for the recurring gift.
The premium model associated with the gift.
The premium sent to the donor for the recurring gift.
The payment provider the recurring gift is charged through.
0, 1, 2, 3, 4, 5, 6, 7 The key that links the recurring gift to the matching record in your CRM.
Links to the matching records in your CRM, by CRM.
The page the recurring gift was started from.
The merchant account type used at the gateway.
0, 1, 2, 3, 4, 5 The merchant account used at the gateway.
The tokenization key for payment processing.
How the donor pays, such as by card or bank account.
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 The gateway's identifier for the donor as a customer.
Whether a payment has failed.
Whether this is a legacy recurring gift.
The currency exchange information for the recurring gift, if applicable.
The tribute for the recurring gift.
The unique identifier of the stored payment method being charged.
The processing fee costs covered by the donor.