Update giving schedule

put

https://{tenant}.onechurchsoftware.com/api/contributions/schedules/{id}

Update a recurring giving schedule. This is a full update: send the complete schedule. Provide the id of one of the giver's saved payment methods, the giving frequency, the start (and optional end) date, and the designation line items. First retrieve the current schedule from /api/contributions/schedules/{id}, apply your changes, then send back the full object.

Required permission: Full Write Contributions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the schedule to edit

Body Params

The new version of the schedule

frequency

object | null

required

How often the gift recurs (e.g. weekly, monthly).

lineItems

array of objects | null

required

The designation allocations the gift is split across, each with its amount. Apportioned fees are computed and returned on responses only.

lineItems*

profile

object | null

required

A reference to an existing record by its id.

fees

double

The processing fees the giver has elected to cover per occurrence.

cover

boolean | null

Whether the giver is covering the processing fees.

start

date-time | null

The date the schedule starts.

end

date-time | null

The date the schedule ends, if any.

merchant

object | null

The merchant account that processes the schedule (falls back to the tenant default).

givingPortal

object | null

The giving portal the schedule was created through, when one is associated.

business

object | null

The business the gift is given on behalf of, when a business name is set (only the name is filled in).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

404Not Found