PATCH
/
v0
/
subscriptions
/
{subscriptionId}
/
cancel
curl --request PATCH \
  --url https://api.fungies.io/v0/subscriptions/{subscriptionId}/cancel \
  --header 'Content-Type: application/json' \
  --header 'x-fngs-public-key: <api-key>' \
  --header 'x-fngs-secret-key: <api-key>' \
  --data '{
  "cancelOption": "immediately",
  "refundOption": "noRefund"
}'
{
  "status": "<string>",
  "data": {
    "success": true
  }
}

Authorizations

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

Path Parameters

subscriptionId
string
required

PATCH /v0/subscriptions/:subscriptionId/cancel Parameter

Body

application/json
PATCH /v0/subscriptions/:subscriptionId/cancel Request body
cancelOption
enum<string>
required
Available options:
immediately,
endInterval
refundOption
enum<string>
required
Available options:
noRefund,
lastPayment,
prorate

Response

200
application/json
PATCH /v0/subscriptions/:subscriptionId/cancel Positive response
status
string
required
Allowed value: "success"
data
object
required