Skip to content

Stop one of my monthly gifts​

POST
/me/monthly-gifts/{id}/cancel

Stops one of the caller's own church or non-profit monthly gifts, the
same way the cancel link in the gift's receipt does. Past gifts stay as
they are. A gift that has already ended answers 200 as well.

The caller's own signed-in session only.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The monthly gift's id (MonthlyGiftSummary.id).

Type
string
Required
Format
"uuid"

Responses​

Stopped.

application/json
JSON
{
"data": {
"canceled": true
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress