API Reference

This API is used to cancel a user’s subscription, and can be done as an immediate cancellation or a tagged for cancellation where the users are allowed access to content until next renewal date*.

How to use:

  1. Replace the user's subscription id in the URL of the request, replace 123451234, with the "id" number from the response of the Fetch Subscription Details API)
  2. Go to the Params tab,
  3. Check that immediately is set to
    1. true, if sub is needed to be cancelled now, or
    2. false, if you need the user to access content until next renewal date. (Tag for Cancel)
  4. Go to the Headers tab,
  5. Fill in Authorization: Bearer U1234abcde-1234-abcd-1234-abcd1234abcd (Replace with access_token obtained from response of User Access Token APIs(User Access Token (Using Auth. Code) API, User Access Token (Using UUID) API))

IMPORTANT NOTE:
The Request URL here contains a number 123451234 before the parameter "immediately", that number corresponds to the subscription ID of the user which can be found in the response of the Fetch Subscription Details API request called "id".

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!