Skip to main content
PATCH
Update Subscription

Authorizations

x-client-id
string
header
required

Client ID for API authentication

x-api-key
string
header
required

API Key for API authentication

Path Parameters

donorId
string
required

The Id of the donor to update the subscription for.

Example:

"2ea1ae03ca521e437db76d76"

subscriptionId
string
required

The Id of the subscription to update.

Example:

"2ea1ae03ca521e437db76d76"

Body

application/json

Subscription update details

paymentMethodId
string

Id of the payment method.

Example:

"6710f34fd5061afeec3eab57"

amount
number

Subscription amount in dollars.

Required range: x > 0
Example:

50

startDate
string<date-time>

ISO 8601 date string when the subscription should start.

Example:

"2025-01-15T05:00:00.000Z"

timezone
string

Timezone for the subscription start date. Defaults to UTC if not provided.

Example:

"America/Chicago"

anonymous
boolean

Whether the donor wants the contribution to be anonymous.

Example:

false

campaignId
string

Id of the campaign to allocate funds to

Example:

"7710f34fd5061afeec3eab78"

subcampaignId
string

Id of the subcampaign for more specific allocation.

Example:

"7710f34fd5061afeec3eab79"

donorNotes
string

Notes from the donor.

Example:

"Happy to support this cause!"

frequency
enum<string>
Available options:
biweekly,
monthly,
weekly

Response

Subscription updated successfully.

Last modified on July 14, 2026