Skip to main content
DELETE
/
api
/
v3
/
subscriptions
/
{donorId}
/
{subscriptionId}
Cancel Subscription
curl --request DELETE \
  --url https://server.stage.overflow.co/api/v3/subscriptions/{donorId}/{subscriptionId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>' \
  --data '
{
  "cancellationReason": "I no longer attend this organization."
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.overflow.co/llms.txt

Use this file to discover all available pages before exploring further.

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 cancel the subscription for.

Example:

"2ea1ae03ca521e437db76d76"

​
subscriptionId
string
required

The Id of the subscription to cancel.

Example:

"2ea1ae03ca521e437db76d76"

Body

application/json

Subscription cancellation details

​
cancellationReason
string

The reason for cancelling the subscription.

Required string length: 1 - 150
Example:

"I no longer attend this organization."

Response

Subscription cancelled successfully.