Skip to main content
PATCH
/
v0
/
subscriptions
/
{subscriptionIdOrNumber}
/
cancel
Cancel Subscription
curl --request PATCH \
  --url https://api.fungies.io/v0/subscriptions/{subscriptionIdOrNumber}/cancel \
  --header 'Content-Type: application/json' \
  --header 'x-fngs-public-key: <api-key>' \
  --header 'x-fngs-secret-key: <api-key>' \
  --data '
{
  "cancelAtIntervalEnd": false,
  "cancelOption": "immediately"
}
'
{
  "status": "<string>",
  "data": {
    "success": true
  }
}

Authorizations

​
x-fngs-public-key
string
header
required
​
x-fngs-secret-key
string
header
required

Path Parameters

​
subscriptionIdOrNumber
string
required

Subscription ID or order number

Body

application/json

PATCH /v0/subscriptions/:subscriptionIdOrNumber/cancel Request body

​
cancelAtIntervalEnd
boolean
default:false

Whether to cancel the Subscription at the end of the current billing period: - false: Cancel immediately (default) - true: Cancel at the end of current billing period

​
cancelOption
enum<string>
default:immediately
Available options:
immediately,
endInterval

Response

PATCH /v0/subscriptions/:subscriptionIdOrNumber/cancel Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required