Cancel subscription

post

https://api.frisbii.com/v1/subscription/{handle}/cancel

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

An active subscription can be cancelled. When the subscription will expire is determined by possible notice and fixation period defined for the plan, or optional overriding notice period defined in the cancel request. By default the subscription will expire at the end of the current billing period. Cancelling a subscription in trial will always result in an expire at the end of the trial period.

Errors

The operation can generate the following errors beside the generic HTTP error codes described here.

Error code	HTTP code	Description
`12`	`404`	Subscription not found
`13`	`400`	Subscription expired, must be active
`95`	`400`	Subscription on-hold, must be active
`22`	`400`	Subscription already cancelled
`93`	`400`	Cannot expire in current period. A custom expires at has been provided that is in the current period.

Path Params

handle

string

required

Subscription handle

Body Params

notice_periods

int32

Optional override of the notice periods set for plan. See plan for the definition of notice periods.

notice_periods_after_current

boolean

Optional override of the notice periods after current setting for plan. See plan for the definition of notice periods.

expire_at

string

Optional fixed date and time on when the subscription should expire. Using this option results in prorated billing for the last partial period. Notice that when using this option the cancellation cannot be uncancelled in the last partial period. The fixed expire date takes precedence over notice periods and fixation period. The fixed expire date must be after the end of the current periods. On the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss.

trial_with_notice_and_fixation

boolean

If subscription is in trial and this flag is set to true, the potential notice and fixation periods will be respected. This can be used in a paid trial scenario where the trial period have custom duration and price collected with a setup fee. E.g. if notice period is set to 2, the subscription will run for the trial period and two full paid periods.

Responses

Errors

200Successful operation

400Invalid request, see error codes at https://api.frisbii.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii