Skip to main content
PATCH
Cancel Subscription

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

Pattern: ^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$

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