Cancel Subscription

post

https://secure.fusebill.com/v1/subscriptionCancellation

This action cancels an active subscription (only subscriptions in Active or Provisioning status can be cancelled.) This call returns the cancelled subscription so you can inspect the status field to ensure it was cancelled as expected.

Body Params

subscriptionId

int32

required

This is the Subscription Id for the Subscription you want to cancel. Passing the incorrect Id can potentially cancel a different Subscription.

cancellationOption

string

enum

required

This field defines how the system behaves when cancelling the subscription. "None" will have no reversal take place. The system will fully earn the charges from the current period as though services provided have completed and been provided fully. "Unearned" will reverse the unearned deferred revenue of the current period's charges. This is typically a partial reversal based on daily or monthly earning rules set on the plan product at the time the subscription was created. "Full" will fully reverse all charges for the current period, regardless of how much has been earned.

Allowed:

Responses

200200

400400