Registration

Search Account

Create User

Create OTP

Confirm OTP

Login

Get OAuth Access Token

Log Out

Subscription Management

Get Packages And Products With Promos

Get Active Subscriptions

Is Customer Eligible for Free Trial

Add Subscription

Remove Subscription

Reactivate Service

Redeem Coupon

Get Prorate

Get Voucher Details

Self Care

Profile Management

Financials and Billing History

Default

Core-Standard-APIs

Production

Demo

Stage

Sandbox

<p class="slate-p " >The Registration section allows users to create new accounts and register for services within the platform. By utilizing this section, users can easily set up their profiles and gain access to various features and functionalities available on the platform.</p><p class="slate-p " ></p>

The Registration section allows users to create new accounts and register for services within the platform. By utilizing this section, users can easily set up their profiles and gain access to various features and functionalities available on the platform.

<p class="slate-p " >The Login section in the Core-Standard-Api allows users to authenticate and access their accounts securely. By utilizing this section, users can verify their identity and gain access to specific functionalities within the API. This section serves as the primary gateway for users to securely log in and interact with the API.</p><p class="slate-p " ></p>

The Login section in the Core-Standard-Api allows users to authenticate and access their accounts securely. By utilizing this section, users can verify their identity and gain access to specific functionalities within the API. This section serves as the primary gateway for users to securely log in and interact with the API.

<p class="slate-p " >The Subscription Management section of the Core-Standard-Api allows users to manage their subscription plans within the system effectively. Users can view, update, and cancel subscriptions through this section, allowing them to tailor their subscription services to their needs.</p><p class="slate-p " ></p>

The Subscription Management section of the Core-Standard-Api allows users to manage their subscription plans within the system effectively. Users can view, update, and cancel subscriptions through this section, allowing them to tailor their subscription services to their needs.

<p class="slate-p " >The Self Care section of the Core-Standard-Api allows users to retrieve personalized information and settings related to their account. Users can access details such as account preferences, notifications, and security settings to manage their account effectively. This section provides a convenient way for users to customize their experience and ensure their account is secure and up-to-date.</p><p class="slate-p " ></p>

The Self Care section of the Core-Standard-Api allows users to retrieve personalized information and settings related to their account. Users can access details such as account preferences, notifications, and security settings to manage their account effectively. This section provides a convenient way for users to customize their experience and ensure their account is secure and up-to-date.

The Profile Management section of the Core-Standard-API allows users to retrieve and update their profile information within the system. Users can access their personal details, such as name, email, and preferences, to ensure accurate and up-to-date data. This section empowers users to manage their profile information efficiently and securely.

<p class="slate-p " >The Subscription Management section of the Core-Standard-Api allows users to efficiently handle and monitor subscriptions within their platform. Users can seamlessly manage subscription details, such as status, billing information, and renewal options, ensuring a smooth and hassle-free subscription experience for their customers.</p><p class="slate-p " ></p>

The Subscription Management section of the Core-Standard-Api allows users to efficiently handle and monitor subscriptions within their platform. Users can seamlessly manage subscription details, such as status, billing information, and renewal options, ensuring a smooth and hassle-free subscription experience for their customers.

<p class="slate-p " >The &quot;Pause&quot; section of the Core-Standard-Api allows users to temporarily halt specific processes or functionalities within the system. This feature gives users the ability to manage and control the flow of operations, providing a convenient way to pause and resume essential tasks as needed. With the Pause API section, users can ensure smooth and efficient management of their projects by controlling the timing of certain actions.</p><p class="slate-p " ></p>

The "Pause" section of the Core-Standard-Api allows users to temporarily halt specific processes or functionalities within the system. This feature gives users the ability to manage and control the flow of operations, providing a convenient way to pause and resume essential tasks as needed. With the Pause API section, users can ensure smooth and efficient management of their projects by controlling the timing of certain actions.

Pause

<p class="slate-p slate-indent-0" style="0px">The pauseSubscription API allows customers to suspend their active subscriptions for several days temporarily. This feature is particularly useful for scenarios where customers may not require the service for a certain period but want to retain their subscription without cancellation.</p><h2 class="slate-h2 " >Key Features</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Temporarily suspend subscriptions for a defined duration. </div></li><li class="slate-li " ><div style="position:relative">Retain subscription benefits and configurations for future reactivation. </div></li><li class="slate-li " ><div style="position:relative">Enhance customer satisfaction by providing flexible subscription management options. </div></li></ul><p class="slate-p " ></p>

The pauseSubscription API allows customers to suspend their active subscriptions for several days temporarily. This feature is particularly useful for scenarios where customers may not require the service for a certain period but want to retain their subscription without cancellation.

Authentication Failed: The authentication attempt was unsuccessful due to incorrect credentials or missing authentication parameters.

111111111

Either OrderedProductId or Sku is required: The request must include either an OrderedProductId or a SKU to identify the product. Without at least one of these parameters, the system cannot process the request.

eV6794

Invalid Request: The request format or parameters are incorrect or missing required data.

eV2645

Pause Subscription

Message sent in the request body to initiate the subscription pause.

PauseSubscriptionRequestMessage

Message returned in the response confirming the successful pause of the subscription.

PauseSubscriptionResponseMessage

The request was unacceptable, often due to missing a required parameter.

<p class="slate-p slate-indent-0" style="0px">The getSubscriptionPauseThresholds API retrieves the limits and remaining quota for pausing a subscription. The information includes the number of times a user can pause their subscription and the total remaining pause duration (in days). It helps manage subscription pauses effectively and ensures compliance with policy restrictions.</p><h2 class="slate-h2 " >Key Features</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Pause Limit Tracking</strong> – Allows users to check the number of times they can still pause their subscription. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Duration Tracking</strong> – Details how many days a subscription can still be paused. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Subscription Management</strong> – Helps users make informed decisions before pausing a service. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Authentication Required</strong> – Requires channelPartnerID and apiKey for secure access. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Supports Different Initiators</strong> – Can track pause limits based on who initiated the request. </div></li></ul><p class="slate-p " ></p>

The getSubscriptionPauseThresholds API retrieves the limits and remaining quota for pausing a subscription. The information includes the number of times a user can pause their subscription and the total remaining pause duration (in days). It helps manage subscription pauses effectively and ensures compliance with policy restrictions.

Invalid customer ID: The provided customer ID is incorrect or does not exist in the system.

eV1342

Get Subscription Pause Thresholds

A specific message related to the request of the getSubscriptionPauseThresholds endpoint.

GetSubscriptionPauseThresholdsRequestMessage

Specifies the media type of the resource being sent or requested.

Content-Type

An extended message specific to the response of the getSubscriptionPauseThresholds endpoint.

GetSubscriptionPauseThresholdsResponseMessage

<p class="slate-p slate-indent-0" style="0px">The resumeSubscription API enables customers to reactivate a previously paused subscription. This API provides seamless control over subscription management, allowing users to restore access to services without initiating a new subscription.</p><h2 class="slate-h2 " >Key Features</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Reactivates paused subscriptions instantly. </div></li><li class="slate-li " ><div style="position:relative">Ensures continuity of subscription benefits. </div></li><li class="slate-li " ><div style="position:relative">Provides flexibility for customers to resume services as needed. </div></li></ul><p class="slate-p " ></p>

The resumeSubscription API enables customers to reactivate a previously paused subscription. This API provides seamless control over subscription management, allowing users to restore access to services without initiating a new subscription.

Either OrderedProductId or Sku is required: The request must contain either an OrderedProductId or a SKU to proceed.

Resume Subscription

This parameter represents the body of the request message for resuming a subscription.

ResumeSubscriptionRequestMessage

This parameter represents the body of the response message after resuming the subscription.

ResumeSubscriptionResponseMessage

<p class="slate-p slate-indent-0" style="0px">The cancelPause API allows businesses to cancel an ongoing pause on a subscription before the predefined pause period ends. This API provides flexibility to customers who may resume their services earlier. It can be used when customers change their mind about pausing the service or if a business needs to lift the pause on a subscription manually.</p><h2 class="slate-h2 " >Key Features</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Cancel a subscription pause before the specified pause end date. </div></li><li class="slate-li " ><div style="position:relative">Enables customers to resume their service immediately or by a defined date. </div></li><li class="slate-li " ><div style="position:relative">Offers flexibility to businesses for subscription management.</div></li></ul><p class="slate-p " ></p>

The cancelPause API allows businesses to cancel an ongoing pause on a subscription before the predefined pause period ends. This API provides flexibility to customers who may resume their services earlier. It can be used when customers change their mind about pausing the service or if a business needs to lift the pause on a subscription manually.

Cancel Pause

CancelPauseRequestMessage

Specifies the format of the data included in the request.

Contains the authentication token required for accessing the API endpoint.

Authorization

Holds the response message indicating the outcome of the cancellation request.

CancelPauseResponseMessage

<p class="slate-p " >The Upgrade/Downgrade section allows users to adjust their account level to access additional features or reduce their subscription plan. With this functionality, users can easily manage their account status and tailor their subscriptions to better suit their needs without requiring extensive manual adjustments.</p><p class="slate-p " ></p>

The Upgrade/Downgrade section allows users to adjust their account level to access additional features or reduce their subscription plan. With this functionality, users can easily manage their account status and tailor their subscriptions to better suit their needs without requiring extensive manual adjustments.

Upgrade/Downgrade

<p class="slate-p " >The Cancel/Reactivation section allows users to manage the status of a specific resource within the system. This functionality allows users to easily deactivate or reactivate a resource as needed, providing greater control and flexibility in their operations.</p><p class="slate-p " ></p>

The Cancel/Reactivation section allows users to manage the status of a specific resource within the system. This functionality allows users to easily deactivate or reactivate a resource as needed, providing greater control and flexibility in their operations.

Cancel/Reactivation

<p class="slate-p " >The Financials and Billing History section provides users with detailed information regarding their financial transactions and billing history within the system. Users can review and track their billing statements, payment history, and financial data to gain insights into their financial activity and make informed decisions.</p><p class="slate-p " ></p>

The Financials and Billing History section provides users with detailed information regarding their financial transactions and billing history within the system. Users can review and track their billing statements, payment history, and financial data to gain insights into their financial activity and make informed decisions.

Sections