Cancel a subscription now or at a future date

curl --request DELETE \
  --url https://virtserver.swaggerhub.com/BangoProducts/Subscriptions-API/1.4.0/subscription/{subscriptionId} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'DELETE', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://virtserver.swaggerhub.com/BangoProducts/Subscriptions-API/1.4.0/subscription/{subscriptionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://virtserver.swaggerhub.com/BangoProducts/Subscriptions-API/1.4.0/subscription/{subscriptionId}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "responseCode": "OK",
  "responseMessage": "Success"
}

{
  "responseCode": "BAD_REQUEST",
  "responseMessage": "Invalid request"
}

{
  "responseCode": "UNAUTHORIZED",
  "responseMessage": "Invalid access credential"
}

{
  "responseCode": "NOT_FOUND",
  "responseMessage": "Subscription not found"
}

{
  "responseCode": "TOO_MANY_REQUESTS",
  "responseMessage": "Request limit reached. Please try again later"
}

{
  "responseCode": "INTERNAL_ERROR",
  "responseMessage": "The server encountered an unexpected condition which prevented it from fulfilling the request"
}

{
  "responseCode": "SERVICE_UNAVAILABLE",
  "responseMessage": "The server is undergoing maintenance and is not available. Please, try again later"
}

Cancel a subscription now or at a future date

Use this endpoint to cancel a subscription now or at a future date, given the unique identifier allocated by Bango for the subscription. This endpoint returns the updated subscription record.

If set to a future date, API consumers might want to show users that date. In the updated record, use the cancelledDate field.

If you set a future date, either using requestedDate or by setting entitlementPolicy to END_OF_TERM, the subscription remains in state ACTIVE and the cancelledDate field is set. For these subscriptions, you can undo the cancellation (“uncancel”) using POST /subscription/{subscriptionId}/uncancel. Subscriptions in state CANCELLED may not be uncancelled.

Note that there is no automatic refund of advance payments if a subscription is cancelled before the next billing date.

DELETE

https://virtserver.swaggerhub.com/BangoProducts/Subscriptions-API/1.4.0

subscription

{subscriptionId}

Cancel a subscription now or at a future date

curl --request DELETE \
  --url https://virtserver.swaggerhub.com/BangoProducts/Subscriptions-API/1.4.0/subscription/{subscriptionId} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'DELETE', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://virtserver.swaggerhub.com/BangoProducts/Subscriptions-API/1.4.0/subscription/{subscriptionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://virtserver.swaggerhub.com/BangoProducts/Subscriptions-API/1.4.0/subscription/{subscriptionId}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "responseCode": "OK",
  "responseMessage": "Success"
}

{
  "responseCode": "BAD_REQUEST",
  "responseMessage": "Invalid request"
}

{
  "responseCode": "UNAUTHORIZED",
  "responseMessage": "Invalid access credential"
}

{
  "responseCode": "NOT_FOUND",
  "responseMessage": "Subscription not found"
}

{
  "responseCode": "TOO_MANY_REQUESTS",
  "responseMessage": "Request limit reached. Please try again later"
}

{
  "responseCode": "INTERNAL_ERROR",
  "responseMessage": "The server encountered an unexpected condition which prevented it from fulfilling the request"
}

{
  "responseCode": "SERVICE_UNAVAILABLE",
  "responseMessage": "The server is undergoing maintenance and is not available. Please, try again later"
}

Authorizations

Authorization

string

header

required

Base64 encoding of username:password as supplied by Bango Support

Headers

X-RequestIdentifier

string

An arbitrary, optional, globally unique identifier for the request. If present, this ID is used for idempotency.

Path Parameters

subscriptionId

string<uuid>

required

The unique identifier generated by Bango for a subscription. The unique identifier generated by Bango for a subscription. This is a globally unique, opaque string

Example:

"123e4567-e89b-12d3-a456-426614174000"

Query Parameters

requestedDate

string<date>

The YYYY-MM-DD UTC date on which the subscription should end.

Ignored if entitlementPolicy is set.

If this date is in the past, equivalent to entitlementPolicy IMMEDIATE.

entitlementPolicy

enum<string>

default:IMMEDIATE

IMMEDIATE - is hard cancel, also revoke (user does not have more access to the service) . END_OF_TERM - is soft cancel (user still has access for the entire paid period)

Available options:

IMMEDIATE,

END_OF_TERM

Response

Subscription cancelled

responseCode

enum<string>

required

Always 'OK'

Available options:

OK

responseMessage

string

required

Example:

"Success"

API Reference

Concepts

Cancel a subscription now or at a future date

Authorizations

Headers

Path Parameters

Query Parameters

Response