Update a Recurring Gift
Authorizations
JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
Path Parameters
The ID of the recurring gift.
Body
The recurring gift request model.
Represents a request to create or update a recurring gift.
Gets or sets the frequency of the recurring gift.
0, 1, 2, 4, 12, 26, 52, 100 Gets or sets the next charge date.
Gets or sets the gateway ID.
Gets or sets the profile number.
Gets or sets the amount of the recurring gift.
Gets or sets the currency code.
Gets or sets the donor ID.
Gets or sets the status of the recurring gift.
1, 2, 3, 4, 5, 6 Gets or sets the projects associated with the recurring gift.
Gets or sets a value indicating whether the donor will cover the costs.
Gets or sets the costs associated with the recurring gift.
Gets or sets a value indicating whether the donor is anonymous.
Gets or sets the motivation code.
Gets or sets the source code.
Gets or sets the segment ID.
Gets or sets the segment code.
Gets or sets the premium ID.
Gets or sets the CRM key.
Gets or sets the notes.
Gets or sets the page ID.
Gets or sets the virtual terminal ID.
Gets or sets the payment method ID.
Gets or sets the billing address.
- Option 1
- Option 2
Gets or sets the payment tender type.
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 Gets or sets the card expiration month.
Gets or sets the card expiration year.
Gets or sets the card brand.
Gets or sets the card number.
Gets or sets the total amount.
Gets or sets the start date of the recurring gift.
Gets or sets the gateway customer key.
Gets or sets the ACH number.
Gets or sets the ACH type.
Gets or sets the Virtuous donor ID.
Gets or sets the billing address ID.
Gets or sets the shipping address ID.
Gets or sets the time zone.
Gets or sets the campaign ID.
Gets or sets the campaign name.
Response
OK
Represents a model for recurring gifts.
Gets or sets the unique identifier for the recurring gift.
Gets or sets the organization identifier.
Gets or sets the created date (localized and formatted).
Gets or sets the modified date (localized and formatted).
Gets or sets the profile number for the recurring gift.
Gets or sets the recurring gift amount.
Gets or sets the currency code for the recurring gift.
Gets or sets the base currency code for the recurring gift, if applicable.
Gets the formatted recurring gift amount.
Gets or sets the donor associated with the recurring gift.
Gets or sets the frequency of the recurring gift.
0, 1, 2, 4, 12, 26, 52, 100 Gets the formatted frequency display value.
Gets or sets the total amount for the recurring gift.
Gets or sets the formatted total amount.
Gets or sets the number of successful cycles.
Gets or sets the start date of the recurring gift.
Gets the formatted start date (localized).
Gets or sets the next charge date.
Gets the formatted next charge date.
Gets the next charge date formatted for editing.
Gets or sets the status of the recurring gift.
1, 2, 3, 4, 5, 6 Gets or sets the display text for the status.
Gets or sets the gateway identifier.
Gets or sets the gateway name.
Gets or sets the payment information summary.
Gets or sets the expiration month and year for the card.
Gets or sets the card brand.
Gets or sets the payment method country code.
Gets or sets the project allocations for the recurring gift.
Gets or sets a value indicating whether the donor is anonymous.
Gets or sets a value indicating whether the gift is in test mode.
Gets or sets a value indicating whether the donor covers processing costs.
Gets or sets the motivation code.
Gets or sets the source code.
Gets or sets the segment identifier.
Gets or sets the segment name.
Gets or sets the segment code.
Gets or sets the notes for the recurring gift.
Gets or sets the comments for the recurring gift.
Gets or sets the premium model associated with the gift.
Gets or sets the recurring premium model.
Gets or sets the payment provider type.
0, 1, 2, 3, 4, 5, 6, 7 Gets or sets the CRM key.
Gets or sets the CRM key URLs.
Gets or sets the page response model.
Gets or sets the merchant type.
0, 1, 2, 3, 4, 5 Gets or sets the merchant account identifier.
Gets or sets the tokenization key for payment processing.
Gets or sets the payment tender type.
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 Gets or sets the gateway customer key.
Gets or sets a value indicating whether a payment has failed.
Gets or sets a value indicating whether this is a legacy recurring gift.
Gets or sets the currency exchange information for the recurring gift, if applicable.
Gets or sets the Tribute for the recurring gift.
Gets or sets the payment method identifier.
Gets or sets the processing fee costs covered by the donor.