latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Upgrade links

Create an upgrade link for a one-time donation

Generates a one-time Upgrade Link for a specific one-time donation. The link directs the supporter to a page where they can start a recurring plan based on their original donation. Links are permanent and signature-authenticated — no login required.

To call this endpoint, your API key must have the Upgrade Links — Write permission.

Parent accounts cannot use their API keys to create upgrade links for subaccounts. To create upgrade links for a subaccount, generate an API key within that specific subaccount and use it.

post/v1/upgrade_links/donations/{id}

Path parameters

idstring required
Example:DXXXXXXX

One-time donation ID in the format D[A-Z]{7}. The donation must be eligible for upgrade.

Response

Upgrade link generated successfully.

urlstring required

A permanent, pre-authenticated link that the supporter can use to upgrade this one-time donation to a recurring plan. Share this link via email, SMS, or any other channel.