Introduction to Developer Tools

Get Started

Prerequisites

Actors

Systems

Acquisition

Email Address and Password

Email OTP-based Registration

Mobile OTP-based Registration

Social Media Sign-up

Authentication & Authorization

Login with Email and Password

Login with Email and OTP

Login with Mobile Number and OTP

Social Media Login

Subscription Management

Product Catalog 

Cart Generation with Taxes

Adding a Subscription

Changing a Service

Removing a Subscription

Pausing a Subscription

Resuming a Subscription

Reactivating a Subscription

Cancelling a Pause

Selfcare

Subscriber Account Information

Profile Management

Device Management

Parental Control

Payments

Blank

Quick Start Guide

Production

<p class="slate-p slate-indent-0" style="0px">Welcome to Evergent Developer Tools, the ultimate solution for developers seeking to integrate robust subscription and billing management capabilities into their applications. At Evergent, we understand the complexities of managing subscriber life cycles, payment systems, and operational workflows in the dynamic landscape. Our developer tools provide everything you need to create seamless integrations, enabling your business to deliver exceptional customer experiences while streamlining back-end processes.</p><p class="slate-p slate-indent-0" style="0px">Our platform is built to support scalability, security, and flexibility. Whether you&apos;re integrating for user onboarding, subscription management, payment gateway setups, or order processing, our APIs are designed to fit your existing workflows with minimal effort. Backed by comprehensive documentation and intuitive tools, Evergent Developer Tools empower you to build, test, and deploy solutions quickly and confidently.</p><p class="slate-p slate-indent-0" style="0px">This space is your starting point for innovation, from simple integrations to complex customization. Explore our resources, leverage our APIs, and take your business to the next level with Evergent.</p><p class="slate-p " ></p>

Welcome to Evergent Developer Tools, the ultimate solution for developers seeking to integrate robust subscription and billing management capabilities into their applications. At Evergent, we understand the complexities of managing subscriber life cycles, payment systems, and operational workflows in the dynamic landscape. Our developer tools provide everything you need to create seamless integrations, enabling your business to deliver exceptional customer experiences while streamlining back-end processes.

Our platform is built to support scalability, security, and flexibility. Whether you're integrating for user onboarding, subscription management, payment gateway setups, or order processing, our APIs are designed to fit your existing workflows with minimal effort. Backed by comprehensive documentation and intuitive tools, Evergent Developer Tools empower you to build, test, and deploy solutions quickly and confidently.

This space is your starting point for innovation, from simple integrations to complex customization. Explore our resources, leverage our APIs, and take your business to the next level with Evergent.

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">Integrating Evergent’s capabilities into your system has never been easier. Our tools are designed with developers in mind, offering flexibility and efficiency from setup to deployment. Here’s how to get started:</p><h2 class="slate-h2 " >Learn the Fundamentals</h2><p class="slate-p slate-indent-0" style="0px">Familiarize yourself with the key components of our platform:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">RESTful APIs:</strong> All our APIs follow REST principles, ensuring simplicity and compatibility.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Authentication:</strong> Use API keys and OAuth tokens to access our services securely.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Core Concepts:</strong> Understand entities like Customers, subscriptions, orders, and payments.</div></li></ul><h2 class="slate-h2 " >Select your Use Case</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Customer Management: Create and manage subscriber profiles effortlessly.</div></li><li class="slate-li " ><div style="position:relative">Payment Gateway Integration: Connect to Adyen or other gateways for seamless transactions.</div></li><li class="slate-li " ><div style="position:relative">Subscription Management: Order, Automate renewals, cancellations, and more.</div></li></ul><h2 class="slate-h2 " >Leverage Resources</h2><p class="slate-p slate-indent-0" style="0px">Our portal is packed with tools and guides to accelerate your integration. From API reference documentation to example use cases, everything you need is at your fingertips.</p><p class="slate-p slate-indent-0" style="0px">Ready to dive in? Our Quick Start section provides step-by-step instructions on setting up your first integration. Explore the Sign-up Flows and Ordering Flows sections, for example.</p></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">Sign-up is essential in creating a user account, and EMP offers multiple ways to achieve this. Whether you prefer the traditional email address and password method or want to leverage social media integration, we have got you covered. EMP allows users to register through their:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Email addresses:</strong> A one-time password sent to their email provides an additional layer of security. This feature is ideal for users who prefer to keep their data private and want extra protection against unauthorized access.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Mobile numbers:</strong> An extra layer of security is provided through a one-time password sent to their mobile number. This feature is perfect for users who are always on the go and need a quick way to sign up or reset their passwords.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Email address and password: </strong>Combination, providing high security and control over account access. Users can choose their unique password and enjoy the convenience of logging in with just one click.</div></li></ul><p class="slate-p slate-indent-0" style="0px">For users who prefer a seamless Sign-up experience, EMP also allows for integration with <strong class="slate-bold">Facebook</strong> and <strong class="slate-bold">Google</strong> APIs. This feature enables users to authenticate using their existing social media profiles, eliminating the need to remember multiple login credentials. With this feature, users can simply click on the relevant button to log in with their Facebook or Google account, making it easier than ever to get started.</p><p class="slate-p slate-indent-0" style="0px">Furthermore, EMP supports <strong class="slate-bold">Apple Login</strong> integration, allowing users to register using their Apple ID credentials without the need for passwords. This feature provides a secure and convenient way for users to access their accounts and is perfect for users who value ease of use and security.</p><p class="slate-p slate-indent-0" style="0px">To ensure that only authorized devices have access to user accounts, EMP also allows for Device Registration through an activation code. Users can link devices to their accounts, providing an additional layer of security and control over device access. </p></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">EMP offers a variety of secure and efficient login methods, allowing subscribers to easily and safely access their accounts. Whether you prefer traditional email-based authentication or modern, alternative methods, EMP provides flexible solutions for seamless access.</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Login with Email and Password</strong>
Subscribers can log in using their registered email address and password combination.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Email and OTP (One-Time Password)</strong>
EMP supports login via an OTP sent to the subscriber’s email address, adding an extra layer of security.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Mobile Number and OTP</strong>
Subscribers can log in by entering their mobile number, and an OTP will be sent to their phone via SMS for verification.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Facebook Login</strong>
EMP allows clients to offer subscribers the option to log in using their existing Facebook credentials, linking their social media profiles for ease of use.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Google Login</strong>
 With EMP, clients can integrate Google login, enabling subscribers to use their Google account credentials for quick access.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Apple Login</strong>
 EMP supports Apple’s authentication method, allowing subscribers to log in using their Apple ID for secure access.</div></li></ol></p><p class="slate-p " ></p>

<p class="slate-p slate-indent-0" style="0px">The Evergent Monetization platform module provides a robust and streamlined framework for overseeing the entire subscription lifecycle. It ensures that digital service providers can seamlessly manage their offerings while delivering an optimum customer experience for their subscribers. </p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Flexible Product &amp; Package Offerings</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Curated Catalogs: Present a full range of services, including Premium, Standard, and Basic plans</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case:</strong> A video streaming service offers Premium packages with a 14-day free trial to attract new users.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Bundled Subscriptions: Combine services/products into discounted bundles.</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case:</strong> A telco bundles internet, mobile, and OTT content into a single subscription package.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Promotions &amp; Coupons</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Targeted Discounts: Custom promotions for select user segments.</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case:</strong> New users get 20% off on their first annual subscription using a promo code.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Offer Types: BOGO, percentage discounts, fixed amount discounts.</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case:</strong> To drive sign-ups, a learning platform offers &quot;Buy One, Get One Free&quot; on selected courses.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px"><span style="background-color:transparent;color:rgb(0, 0, 0)"><strong class="slate-bold"> </strong></span><strong class="slate-bold">Comprehensive Payment Support</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Multi-Payment Gateway Support: Seamless integration with Credit Cards, PayPal, Apple Pay, Google Pay, App Stores (Google, Apple, Amazon, Roku).</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case:</strong> An OTT app enables in-app subscriptions for mobile users via the Apple App Store and Google Play.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Secure Transactions: PCI-DSS compliant with real-time payment validations.</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case:</strong> An e-publishing platform securely processes recurring monthly payments using stored card tokens.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Full Subscription Lifecycle Management</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Actions Supported: Upgrade, downgrade, pause, resume, cancel, and reactivate.</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case:</strong> A SaaS tool allows users to pause subscriptions while on vacation and resume without data loss.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Proration &amp; Tax Calculation: Accurate billing during mid-cycle changes.</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case:</strong> A cloud storage user upgrades from 100GB to 1TB mid-month and is charged a prorated fee with taxes.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Real-Time Subscription Control</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Effective Cancellation: Subscription ends with the next billing cycle, not immediately.</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case:</strong> A user cancels an e-magazine subscription but continues receiving issues until the end of the paid term.</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Reactivation: Users can restart subscriptions before the current cycle ends.</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case:</strong> A user changes their mind and reactivates a paused music streaming subscription within days.</p><p class="slate-p " ></p><p class="slate-p slate-indent-0" style="0px"><strong class="slate-bold">Unique Use Cases</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><span style="background-color:transparent;color:rgb(0, 0, 0)">Trial &amp; Promotion Abuse Prevention: Prevent multiple trial sign-ups using the same payment method, email, or device ID.</span></div></li></ul><p class="slate-p slate-indent-2" style="48px"><span style="background-color:transparent;color:rgb(0, 0, 0)"><strong class="slate-bold">Use Case: </strong></span><span style="background-color:transparent;color:rgb(0, 0, 0)">A video streaming platform restricts free trial access for users trying to create duplicate accounts.</span></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Personalized Upselling Offers: Offer targeted discounts on cancellation attempts.</div></li></ul><p class="slate-p slate-indent-2" style="48px"><strong class="slate-bold">Use Case: </strong>When a user tries to cancel, the system triggers an offer for 30% off for the next 3 months to retain them.</p><p class="slate-p " ></p>

The Evergent Monetization platform module provides a robust and streamlined framework for overseeing the entire subscription lifecycle. It ensures that digital service providers can seamlessly manage their offerings while delivering an optimum customer experience for their subscribers. 

 A video streaming service offers Premium packages with a 14-day free trial to attract new users.

 A telco bundles internet, mobile, and OTT content into a single subscription package.

 New users get 20% off on their first annual subscription using a promo code.

 To drive sign-ups, a learning platform offers "Buy One, Get One Free" on selected courses.

 An OTT app enables in-app subscriptions for mobile users via the Apple App Store and Google Play.

 An e-publishing platform securely processes recurring monthly payments using stored card tokens.

 A SaaS tool allows users to pause subscriptions while on vacation and resume without data loss.

 A cloud storage user upgrades from 100GB to 1TB mid-month and is charged a prorated fee with taxes.

 A user cancels an e-magazine subscription but continues receiving issues until the end of the paid term.

 A user changes their mind and reactivates a paused music streaming subscription within days.

A video streaming platform restricts free trial access for users trying to create duplicate accounts.

When a user tries to cancel, the system triggers an offer for 30% off for the next 3 months to retain them.

<p class="slate-p slate-indent-0" style="0px">The EMP  Product Catalog module is a robust and scalable solution designed to efficiently manage and retrieve detailed information on products, packages, and associated promotions. It empowers digital service providers to deliver a plethora of product offerings tailored to diverse customer segments, regions, and channels. </p><p class="slate-p slate-indent-0" style="0px">At its core, the system provides granular control over catalog data, enabling the creation of dynamic, organized, and customizable product structures. Advanced filtering, pricing, and promotional configurations support strategic business decisions while enhancing user experience and operational agility.</p><p class="slate-p " ><strong class="slate-bold">Comprehensive Product Management:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Fetch and manage detailed product, package, and promotion data.</div></li><li class="slate-li " ><div style="position:relative">Support for subscription, one-time, and other charge types.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Advanced Configuration &amp; Customization:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Define filters by geography, product type, service family, sales channel, etc.</div></li><li class="slate-li " ><div style="position:relative">Search by SKU, quick code, or unique identifiers.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Pricing &amp; Currency Support:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Display accurate retail pricing with currency codes and symbols.</div></li><li class="slate-li " ><div style="position:relative">Regional price customization for localized strategies.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Detailed Product Attributes:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Product name, description, category, and type for precise identification and grouping.</div></li><li class="slate-li " ><div style="position:relative">Charge type and billing logic (e.g., subscription-based or one-time).</div></li></ul><p class="slate-p " ><strong class="slate-bold">Promotions &amp; Bundles Integration:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Link products with applicable promotions and package deals.</div></li><li class="slate-li " ><div style="position:relative">Configure promotion metadata such as ID, name, start date, duration, and type.</div></li></ul><p class="slate-p " ><strong class="slate-bold">Streamlined Business Operations:</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Automate catalog-driven processes like pricing updates and promotional logic.</div></li><li class="slate-li " ><div style="position:relative">Enhance go-to-market speed with reduced manual effort.</div></li></ul><p class="slate-p " >We require access to well-defined APIs to integrate with your preferred storefront and enable seamless retrieval of product-related information. These APIs should support dynamic and secure communication between the Evergent platform and your storefront, ensuring real-time access to up-to-date catalog data.</p><p class="slate-p " ></p><h1 class="slate-h1 " >API guidelines to retrieve the Product Information</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Browsing Available Plans:</strong> The subscriber initiates the discovery process by browsing available subscription plans on the front-end home page.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Fetching Product and Promotion Data:</strong> The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a> API  retrieves all available products and packages and any active promotions from the platform. DMA ID denotes the country or business unit</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Exploring Options:</strong> The subscriber navigates through the displayed offerings, reviewing package details and promotional benefits.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Selection and Progression:</strong> Upon identifying a suitable option, the subscriber selects the desired product or package and proceeds to the next step in the purchase journey.</div></li></ol><div style="text-align:center"><img src="https://d24lr4zqs1tgqh.cloudfront.net/0386637f-9c12-490a-ae26-58597f64923e.jpg" style="
              width:636px;
	            height:463px;
	            aspect-ratio:636 / 463"
         /></div><h1 class="slate-h1 " >APIs</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a></div></li></ul><p class="slate-p " >
</p><p class="slate-p " ></p>

The EMP  Product Catalog module is a robust and scalable solution designed to efficiently manage and retrieve detailed information on products, packages, and associated promotions. It empowers digital service providers to deliver a plethora of product offerings tailored to diverse customer segments, regions, and channels. 

At its core, the system provides granular control over catalog data, enabling the creation of dynamic, organized, and customizable product structures. Advanced filtering, pricing, and promotional configurations support strategic business decisions while enhancing user experience and operational agility.

We require access to well-defined APIs to integrate with your preferred storefront and enable seamless retrieval of product-related information. These APIs should support dynamic and secure communication between the Evergent platform and your storefront, ensuring real-time access to up-to-date catalog data.

API guidelines to retrieve the Product Information

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The getProrate API enables accurate calculation of the total amount for a subscription order, including applicable taxes. When a subscriber initiates a quote request, such as during a plan purchase or upgrade, the API computes the amount based on selected services and billing parameters. It applies relevant tax rules based on the subscriber’s location and service details. The final amount, including tax, is processed through the subscriber’s saved auto-payment method.</p><p class="slate-p slate-indent-0" style="0px"></p><h1 class="slate-h1 " >API Guidelines for Cart Generation</h1></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber navigates to the cart selection page..</div></li><li class="slate-li " ><div style="position:relative">/<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a> API calculates the amount for the new subscription, considering the number of days remaining in the current billing cycle and applicable taxes.</div></li><li class="slate-li " ><div style="position:relative">The calculated tax is added to the prorated amount.</div></li><li class="slate-li " ><div style="position:relative">The final amount, including the prorated charge and tax, is processed through the subscriber&apos;s auto-payment method.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/fe7a4c20-ae6a-42af-a902-25ab6c500f1f.jpeg" style="
              width:595px;
	            height:459px;
	            aspect-ratio:595 / 459"
         /></div><h1 class="slate-h1 " >APIs</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a></div></li></ul><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The Subscription Management System is a comprehensive solution that enables customers to seamlessly purchase subscriptions with flexible payment options, including free trials, products, packages, coupons, and promotional offers. This system supports platform integration, allowing businesses to access market-specific product data tailored to their unique requirements.</p><p class="slate-p slate-indent-0" style="0px">The Subscription Management System has a built-in feature that estimates the price that would be charged and taxes upfront for customers based on promotions, coupons, and discounts applied to their subscription purchases. This functionality is designed to provide customers with transparent pricing information, ensuring they know exactly what they will be charged before completing the purchase. When a customer adds a promotion or coupon to their subscription purchase, the system automatically applies the discount to the total subscription cost. It recalculates the tax amount in real time by integrating with tax engines.</p><p class="slate-p slate-indent-0" style="0px">It improves customers&apos; shopping experience by providing transparent pricing information and building trust with businesses. For businesses, it increases revenue and streamlines subscription management processes. The system can handle multiple tax rates and exemptions, making setting up complex tax scenarios easy. With this feature, customers get accurate estimates of the total price plus taxes paid upfront, ensuring they know exactly what they will be charged for their subscription purchases and the next billing date.</p><p class="slate-p slate-indent-0" style="0px">With the Evergent system, businesses can offer various products, packages, promotions, and coupons that cater to customer needs and preferences. For instance:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Customers can browse and select from a curated catalog of &quot;Premium&quot; packages with free trial periods for configurable days, allowing them to explore and utilize new premium features without any upfront costs.</div></li><li class="slate-li " ><div style="position:relative">Businesses can offer exclusive discounts through coupons, such as a 20% discount on the yearly subscription fee for customers who sign up for a year-long commitment.</div></li><li class="slate-li " ><div style="position:relative">The system enables businesses to create promotional offers, such as &quot;Buy One Get One Free&quot; deals on specific products or services, that can be redeemed during the checkout process.</div></li><li class="slate-li " ><div style="position:relative">Businesses can create promotional subscription plans with promotions for customers who sign up for a monthly subscription fee and get 10% off for the next 6 months.</div></li></ul><p class="slate-p slate-indent-0" style="0px">The Evergent system also supports bundle/package subscriptions, allowing customers to purchase multiple products or services at a discounted rate. For example:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">A music streaming service can offer a &quot;Bundle Deal&quot; with access to their premium music library, exclusive artist content, and a free subscription trial for $19.99/month.</div></li><li class="slate-li " ><div style="position:relative">An online learning platform can create a &quot;Learning Bundle&quot; with access to its course catalog, personalized learning recommendations, and a free service trial for $29.99/month.</div></li><li class="slate-li " ><div style="position:relative">A cloud storage service can offer a &quot;Storage Bundle&quot; with 1TB of storage space, file-sharing capabilities, and a free trial of their features for $9.99/month.</div></li></ul><p class="slate-p slate-indent-0" style="0px">The Subscription Management System supports various payment methods, including Credit Cards, PayPal, Wallet (Apple Pay and Google Pay), App Store Billing (Apple, Google, Amazon, Roku). Each use case provides customers with an efficient and seamless experience, allowing them to quickly and securely set up their subscriptions without any hassle. By integrating with popular payment gateways, the system ensures secure and reliable transactions, providing customers with a hassle-free and secure way to set up their subscriptions.</p><p class="slate-p slate-indent-0" style="0px">Subscription Management allows flexible subscription management, including upgrading, downgrading, pausing, resuming, and removing/reactivating subscription plans as needed. With Subscription Management, developers can build customizable subscription management systems that integrate seamlessly into their applications. The EMP supports prorate with tax estimations on upgrades, auto or new payment method payments, and business-set rules for pause/resume functionality, ensuring accurate billing and revenue management.</p><p class="slate-p slate-indent-0" style="0px">It also enables users to manage their subscriptions in real-time, allowing them to suspend or cancel their subscriptions as needed temporarily. When a user removes their subscription, it will be effective from the next bill cycle. Still, customers can reactivate their subscription before the bill cycle date, ensuring they&apos;re not locked out of their service immediately.</p><p class="slate-p slate-indent-0" style="0px">Overall, the Subscription Management System is a critical component of any business that wants to succeed in today&apos;s competitive market by offering flexible subscription options, improving customer satisfaction, increasing revenue, and streamlining subscription management processes.</p></p>

<p class="slate-p " ><p class="slate-p " ><p class="slate-p " >Evergent now supports the seamless integration of transaction tokens into our robust subscription management system, making it even easier for users to purchase subscriptions without the need for manual input or credit card information. This innovative feature allows customers to complete transactions quickly and securely by providing a pre-generated transaction token, which is then validated by Evergent&apos;s system.</p><p class="slate-p " >This feature brings convenience to users who can now purchase subscriptions quickly and easily using pre-generated transaction tokens. The transactions are verified through secure APIs, ensuring the integrity of customer data and providing an added layer of security. Moreover, subscriptions are automatically added to user accounts, reducing administrative burdens and making it easier for businesses to manage their subscription-based services.</p><p class="slate-p " >By incorporating transaction token support into our subscription management system, Evergent continues to push the boundaries of innovation and user-centric design, providing businesses with a comprehensive solution for managing subscriptions and optimizing customer experiences.</p></p></p>

Adding a Subscription with Transaction Token

<p class="slate-p " ><p class="slate-p " ><p class="slate-p " >The Subscription Management with Payment Integration feature offers a comprehensive solution for managing user subscriptions, including support for free trials, diverse products, customizable packages, and promotional tools like coupons and discounts. Users can seamlessly integrate leading payment methods such as Google Pay, Apple Pay, and PayPal to ensure a smooth and secure transaction experience. Designed to adhere to PCI DSS Level 1 compliance standards, this feature ensures robust protection of payment data, meeting the highest security requirements. Leveraging Evergent&apos;s subscription management capabilities, this system enables efficient handling of subscription lifecycles while maximizing customer convenience and revenue opportunities through personalized product and promotion offerings.</p></p></p><p class="slate-p " ></p>

Adding a subscription with Payment Methods

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px"><span style="background-color:transparent;color:rgb(0, 0, 0)">The Add Subscription using Google Pay use case allows users to easily add a subscription to their account by selecting the desired package or product and confirming their payment details. This use case provides an efficient and seamless experience, ensuring customers can quickly and securely set up their subscriptions without hassle.</span></p><h1 class="slate-h1 " >API Guidelines for adding a Subscription using Google Pay</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber logs in to the front end and navigates to the subscription page.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a> <span style="background-color:transparent;color:rgb(0, 0, 0)">API fetches the available packages and products with active promos and displays them on the front end.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:transparent;color:rgb(0, 0, 0)">The </span>subscriber<span style="background-color:transparent;color:rgb(0, 0, 0)"> selects the desired subscription plan and proceeds to checkout.</span></div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> <span style="background-color:transparent;color:rgb(0, 0, 0)">API fetches the available payment methods for the user.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:transparent;color:rgb(0, 0, 0)">The </span>subscriber<span style="background-color:transparent;color:rgb(0, 0, 0)"> selects Google Pay as the preferred payment method.</span></div></li><li class="slate-li " ><div style="position:relative">If the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API returns a null response which means there are no active payment methods at the subscriber account, the front-end will call the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> API updates the payment method, which updates the subscriber&apos;s provided card details on the checkout page to the account upon checkout action and validation by the payment gateway.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a> <span style="background-color:transparent;color:rgb(0, 0, 0)">API calculates the tax collected for the subscription using the given zip code.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:transparent;color:rgb(0, 0, 0)">The EMP redirects the user to the Google Pay authorization page.</span></div></li><li class="slate-li " ><div style="position:relative"><span style="background-color:transparent;color:rgb(0, 0, 0)">The </span>subscriber<span style="background-color:transparent;color:rgb(0, 0, 0)"> pays with Google Pay, and the Google Pay gateway returns the Google Pay token.</span></div></li><li class="slate-li " ><div style="position:relative">The <a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">/updatePaymentInfo</a> <span style="background-color:transparent;color:rgb(0, 0, 0)">API verifies payment by validating the Google Pay token retrieved from Google Pay.</span></div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a> <span style="background-color:transparent;color:rgb(0, 0, 0)">API confirms the payment and adds the subscription to the user&apos;s account</span>.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/755fe2db-643a-426d-bee3-c5bdc1a4f5c9.jpeg" style="
              width:736px;
	            height:1068px;
	            aspect-ratio:736 / 1068"
         /></div><h1 class="slate-h1 " >APIs</h1><p class="slate-p " ><p class="slate-p " ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a></div></li></ul></p></p></p>

Adding a Subscription using Google Pay

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px"><span style="background-color:transparent;color:rgb(0, 0, 0)">The Add Subscription using Apple Pay use case allows users to easily add a subscription to their account by selecting the desired package or product and confirming their payment details. This use case provides an efficient and seamless experience, ensuring customers can quickly and securely set up their subscriptions without hassle</span>.</p><h1 class="slate-h1 " >API Guidelines for adding a Subscription through Apple Pay</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a> API fetches the available packages and products with active promos and displays them on the front end.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the desired subscription plan and proceeds to checkout.</div></li><li class="slate-li " ><div style="position:relative">The <a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">/getPaymentMethods</a> API fetches the available payment methods for the user.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects Apple Pay as the preferred payment method.</div></li><li class="slate-li " ><div style="position:relative">If the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API returns a null response which means there are no active payment methods at the subscriber account, the front-end will call the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> API updates the payment method, which updates the subscriber&apos;s provided card details on the checkout page to the account upon checkout action and validation by the payment gateway.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a> API calculates the tax for the subscription as on the Zip code.</div></li><li class="slate-li " ><div style="position:relative">The EMP redirects the user to the Apple Pay authorization page.</div></li><li class="slate-li " ><div style="position:relative">The subscriber pays with Apple Pay, and the Apple Pay gateway returns the Apple Pay token.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> API verifies payment by validating the Apple Pay token retrieved from Apple Pay.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a> API confirms the payment and adds the subscription to the subscriber&apos;s account.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/513889f6-dcac-4443-bda0-96148eac5451.jpeg" style="
              width:667px;
	            height:976px;
	            aspect-ratio:667 / 976"
         /></div><h1 class="slate-h1 " >APIs</h1><p class="slate-p " ><p class="slate-p " ><p class="slate-p " ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a></div></li></ul></p></p></p></p>

Adding a Subscription through Apple Pay

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The Add Subscription using PayPal APIs allows users to easily add a subscription to their account by selecting the desired package or product and confirming their payment details.</p><h1 class="slate-h1 " >API Guidelines for adding a Subscription using PayPal</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a> API fetches the available packages and products with active promotions and displays them on the front end.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the desired subscription and proceeds to checkout.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API fetches the available payment methods of the user’s account.</div></li><li class="slate-li " ><div style="position:relative">If the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API returns a null response which means there are no active payment methods at the subscriber account, the front-end will call the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> API updates the payment method, which updates the subscriber&apos;s provided card details on the checkout page to the account upon checkout action and validation by the payment gateway.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a> API calculates the tax to be collected for the subscription billing address.</div></li><li class="slate-li " ><div style="position:relative">The subscriber makes the payment with PayPal, and the payment gateway approves the payment.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a> API confirms the payment and adds the subscription to the subscriber’s account. </div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/ac2b9c6e-d841-4ab9-8bec-0f1ec328b5b0.jpeg" style="
              width:546px;
	            height:811px;
	            aspect-ratio:546 / 811"
         /></div><h1 class="slate-h1 " >APIs</h1><p class="slate-p " ><p class="slate-p " ><p class="slate-p " ><p class="slate-p " ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a></div></li></ul></p></p></p></p></p>

Adding a Subscription using PayPal

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The Add Subscription using Product Coupon API enables subscribers to purchase a product subscription by redeeming a coupon code. This API integrates Evergent Monetization Platform (EMP) APIs into the front-end application to efficiently manage subscriptions and payments, providing a seamless experience for coupon-based subscription purchases.</p><p class="slate-p slate-indent-0" style="0px"></p><h1 class="slate-h1 " >API Guidelines for Purchase Subscription through a Coupon</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber navigates to the subscription page. </div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a> API fetches the list of available packages and products with active promotions and displays them on the front-end.</div></li><li class="slate-li " ><div style="position:relative">The user selects the desired product subscription.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API fetches the available payment methods of the user’s account, and the user selects the desired payment method.</div></li><li class="slate-li " ><div style="position:relative">If the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API returns a null response which means there are no active payment methods at the subscriber account, the front-end will call the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> API updates the payment method, which updates the subscriber&apos;s provided card details on the checkout page to the account upon checkout action and validation by the payment gateway.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getvoucherdetails" target="_blank">getVoucherDetails</a> API fetches the eligible coupons for the product purchase.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a> API calculates the tax collected for the subscription as per the given address.</div></li><li class="slate-li " ><div style="position:relative">The user makes the payment for the chosen package subscription. </div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a> API confirms the payment by the user and adds the subscription to the user’s account.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/27e064ef-127f-4102-9ffb-2fd7f336cb66.jpeg" style="
              width:600px;
	            height:1112px;
	            aspect-ratio:600 / 1112"
         /></div><h1 class="slate-h1 " >APIs</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getvoucherdetails" target="_blank">getVoucherDetails</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a></div></li></ul></p>

Purchase Subscription through Coupon

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The Add Subscription using Product Promotion APIs enables subscribers to purchase a subscription using a product promotion offer.  </p><h1 class="slate-h1 " >API Guidelines for adding a Subscription through Product Promotion</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The user logs in to the front end and navigates to the subscription page.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a> API fetches the list of available packages and products with active promotions.</div></li><li class="slate-li " ><div style="position:relative">The user selects a subscription product with an active promotion.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API fetches the available payment methods for the user’s account and displays them on the front end.</div></li><li class="slate-li " ><div style="position:relative">If the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API returns a null response which means there are no active payment methods at the subscriber account, the front-end will call the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> API updates the payment method, which updates the subscriber&apos;s provided card details on the checkout page to the account upon checkout action and validation by the payment gateway.</div></li><li class="slate-li " ><div style="position:relative"> The user selects the payment method and pays for the product subscription. </div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a><span style="background-color:transparent;color:rgb(0, 0, 0)"> </span>API calculates the tax to be collected for the subscription based on the subscriber&apos;s address.</div></li><li class="slate-li " ><div style="position:relative">The user makes the payment for the chosen package subscription. </div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a> API confirms the payment and adds the subscription to the user’s account.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/73c2374c-e8ad-400d-88c0-dba14a3adac3.jpeg" style="
              width:504px;
	            height:788px;
	            aspect-ratio:504 / 788"
         /></div><h1 class="slate-h1 " >APIs</h1><p class="slate-p " ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a></div></li></ul></p></p>

Adding a Subscription through Product Promotion

Adding a Subscription through Package Promotion

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The Add Product Subscription with Free Trial API enables customers to subscribe to products with free trial periods, allowing them to explore the product before committing to a paid subscription. </p><p class="slate-p " ></p><h1 class="slate-h1 " >API Guidelines for adding a Product Subscription with Free Trial</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber selects the desired subscription product.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/iscustomereligibleforfreetrial" target="_blank">isCustomerEligibleForFreeTrial</a> API verifies if the subscriber is eligible for a free trial with the selected subscription plan.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API fetches the available payment methods for the subscription purchase.</div></li><li class="slate-li " ><div style="position:relative">If the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API returns a null response which means there are no active payment methods at the subscriber account, the front-end will call the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> API updates the payment method, which updates the subscriber&apos;s provided card details on the checkout page to the account upon checkout action and validation by the payment gateway.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a> API calculates the applicable tax for the subscription based on the provided Zip code.</div></li><li class="slate-li " ><div style="position:relative">The subscriber makes the payment for the chosen subscription package. </div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a> API confirms the payment authorization and adds the subscription to the subscriber’s account.</div></li><li class="slate-li " ><div style="position:relative">The front-end displays the start date of the free trial period.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/e48629b0-f526-45d9-a0cd-7adf80dd7558.jpeg" style="
              width:694px;
	            height:1152px;
	            aspect-ratio:694 / 1152"
         /></div><h1 class="slate-h1 " >APIs</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/iscustomereligibleforfreetrial" target="_blank">isCustomerEligibleForFreeTrial</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a></div></li></ul><p class="slate-p " ><p class="slate-p " ><p class="slate-p " ></p></p></p></p><p class="slate-p " ></p>

Adding a Product Subscription with Free Trial

<p class="slate-p " ><p class="slate-p " ><span style="background-color:transparent;color:rgb(0, 0, 0)">The Add Subscription with Free Trial use case allows customers to purchase a package with a free trial period on the front-end, providing them with a seamless experience to explore and utilize the package before committing to a paid subscription.</span></p><h1 class="slate-h1 " >
API Guidelines for the Free Trial Package </h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber logs in to the front-end and navigates to the subscription page.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a> API will fetch the list of available packages with active promotions.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the desired package.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/iscustomereligibleforfreetrial" target="_blank">isCustomerEligibleForFreeTrial</a> API verifies whether the user is eligible for a free trial period with the chosen package.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API retrieves the available payment methods to purchase the package with a promotion.</div></li><li class="slate-li " ><div style="position:relative">If the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API returns a null response which means there are no active payment methods at the subscriber account, the front-end will call the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> API updates the payment method, which updates the subscriber&apos;s provided card details on the checkout page to the account upon checkout action and validation by the payment gateway.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the payment method and pays for the package with a promotion. </div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a> API calculates the tax to be collected for the subscription billing address.</div></li><li class="slate-li " ><div style="position:relative">The subscriber makes the payment for the chosen package subscription. </div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a> API confirms the payment and adds the subscription to the user’s account.</div></li></ol><p class="slate-p " ><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/833b9956-34d4-4f0f-a0fe-b8a6d0f8c5cb.jpeg" style="
              width:596px;
	            height:992px;
	            aspect-ratio:596 / 992"
         /></div></p><h1 class="slate-h1 " >APIs</h1><p class="slate-p " ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/iscustomereligibleforfreetrial" target="_blank">isCustomerEligibleForFreeTrial</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a></div></li></ul></p></p>

Add Package Subscription through Free Trial

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The Add Subscription using Package coupon use case enables users to activate a subscription by applying a coupon, streamlining the subscription onboarding experience, and integrating package terms into their account.</p><p class="slate-p " ><h1 class="slate-h1 " >API Guidelines for adding a Subscription through Package Coupon</h1></p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a> API fetches the list of available products and packages with active promotions.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the desired package and proceeds to checkout.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API fetches the available payment methods of the user’s account, and the user selects the desired payment method.</div></li><li class="slate-li " ><div style="position:relative">If the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> API returns a null response which means there are no active payment methods at the subscriber account, the front-end will call the /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> API updates the payment method, which updates the subscriber&apos;s provided card details on the checkout page to the account upon checkout action and validation by the payment gateway.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getvoucherdetails" target="_blank">getVoucherDetails</a> API fetches the details of the coupons eligible for the chosen package.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a> API calculates the tax to be collected for the subscription billing address.</div></li><li class="slate-li " ><div style="position:relative">The user makes the payment for the chosen package subscription. </div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a> API confirms the payment and adds the subscription to the user’s account.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/1cc7e760-ddd9-43fd-9652-46320c589dc2.jpeg" style="
              width:582px;
	            height:709px;
	            aspect-ratio:582 / 709"
         /></div><h1 class="slate-h1 " >APIs</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getvoucherdetails" target="_blank">getVoucherDetails</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/getpaymentmethods" target="_blank">getPaymentMethods</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/financials-and-billing-history/updatepaymentinfo_credit-card" target="_blank">updatePaymentInfo</a> </div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/addsubscription-cc" target="_blank">addSubscription</a></div></li></ul><p class="slate-p " ><p class="slate-p " ></p></p></p><p class="slate-p " ></p>

Adding a Subscription through Package Coupon

<p class="slate-p " ><p class="slate-p " ><h2 class="slate-h2 " >Overview</h2><p class="slate-p slate-indent-0" style="0px">The Subscription Management System supports various store payment methods, including App Store Billing (Apple, Google, Amazon, Roku). Each use case provides customers with an efficient and seamless experience, allowing them to quickly and securely set up their subscriptions without any hassle. By integrating with popular payment gateways, the system ensures secure and reliable transactions, providing customers with a hassle-free and secure way to set up their subscriptions.</p><p class="slate-p " >The integration of store payment methods not only enhances the user experience but also provides an additional layer of security. Each platform has its own robust security protocols in place to protect customer transactions, ensuring that payments are processed securely and reliably. This seamless integration eliminates the need for customers to create multiple accounts or remember additional login details, making it a convenient and hassle-free experience.</p><p class="slate-p " >The Subscription Management System&apos;s store integration offers numerous benefits for businesses looking to enhance their revenue management processes. By leveraging established payment methods, businesses can trust the integrity of their subscription setup process, ultimately driving growth and success. The reduced support queries and improved financial tracking and reporting also contribute to a more efficient and effective business model.</p></p></p><p class="slate-p " ></p>

Adding a Subscription with Stores

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The Evergent Monetization Platform&apos;s Change Service feature empowers users to seamlessly upgrade or downgrade their subscription plans, ensuring they only pay for what they need. This flexible feature allows users to adapt their subscription to meet changing needs, while providing a comprehensive overview of the changes involved. With the Change Service feature, users can upgrade to higher-tier plans with prorated charges and tax estimates, giving them complete control over their costs.</p><p class="slate-p slate-indent-0" style="0px">The platform also enables users to downgrade to lower-tier plans with effective changes from the next bill cycle, reducing costs and simplifying account management. This feature provides a seamless service experience, minimizing disruptions and ensuring users can control their subscription changes completely. By offering this flexibility, the Evergent Monetization Platform enables users to confidently adapt their subscription plans, reducing costs and streamlining account management.</p><p class="slate-p slate-indent-0" style="0px">The Change Service feature also provides key benefits, including flexibility and adaptability in subscription plan changes, transparency and visibility into charges and taxes involved, seamless service transition with effective changes from the next bill cycle, easy account management, and cost savings through downgrades and prorated charges and tax estimates for upgrades. By incorporating this feature, the Evergent Monetization Platform delivers a user-friendly experience that meets users&apos; evolving needs while providing a robust and efficient monetization solution.</p><p class="slate-p slate-indent-0" style="0px"></p><h1 class="slate-h1 " >Guidelines for Changing a Service</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber logs in to the front-end and navigates to the subscription page.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a> API fetches the active subscriptions of the subscriber.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the active subscription that they want to upgrade/downgrade.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a> API fetches the list of upgradable/downgrade packages and products with active promotions and displays them on the front end.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the desired subscription.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a> calculates the prorated charges or taxes associated with changing a subscriber&apos;s subscription as per the given Zip code.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/subscription-management-1/upgrade-downgrade/changeservice" target="_blank">changeService</a> API confirms the payment and adds the subscription to the subscriber’s account.</div></li></ol><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/74bda88d-bd87-4350-bae1-201b510c966c.jpeg" style="
              width:872px;
	            height:1272px;
	            aspect-ratio:872 / 1272"
         /></div><h1 class="slate-h1 " >APIs</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getpkgsandprodswithpromos" target="_blank">getPkgsAndProdsWithPromos</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getprorate" target="_blank">getProrate</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/subscription-management-1/upgrade-downgrade/changeservice" target="_blank">changeService</a></div></li></ul></p>

<p class="slate-p " ><p class="slate-p slate-indent-1" style="24px"><span style="background-color:transparent;color:rgb(0, 0, 0)">This use case allows users to cancel their active subscription to our service, enabling them to manage their subscriptions and adjust their billing as needed. When a user removes their subscription, it will be effective from the end of the current billing cycle set by the business.</span></p><h1 class="slate-h1 " >API Guidelines for Removing a Subscription</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber logs in to the front end and navigates to the subscription page.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a> API fetches a list of the subscriber&apos;s active subscriptions.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the subscription they choose to remove.</div></li><li class="slate-li " ><div style="position:relative">The <a href="https://app.theneo.io/emp/core-standard-api/subscription-management/removesubscription" target="_blank">removeSubscription</a> API cancels the selected subscription, moves the status to final bill, and makes it effective at the end of the current billing cycle (as set by the business).</div></li><li class="slate-li " ><div style="position:relative"> EMP updates the subscription information to reflect the cancelled subscription.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/c8e8543a-cbb4-4865-b1a3-1b3b586658f7.jpeg" style="
              width:592px;
	            height:653px;
	            aspect-ratio:592 / 653"
         /></div><h1 class="slate-h1 " >APIs</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/removesubscription" target="_blank">removeSubscription</a></div></li></ul></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">These APIs allow users to temporarily suspend their active subscription, providing users with control over their subscriptions and enabling them to manage their billing as needed. The pause feature is subject to business-set rules, which dictate the number of times a user can pause their subscription, the maximum number of days that can be availed for each pause, and the overall duration of pauses allowed per subscription.</p><h1 class="slate-h1 " >API Guidelines for Pausing a Subscription</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber logs in to the front end and navigates to the subscription page.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a> API fetches a list of the subscriber&apos;s active subscriptions.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the subscription of their choice to pause the subscription plan, adhering to the business-set rules for pauses (number of times, number of days, and maximum duration).</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/subscription-management-1/pause/pausesubscription_immediate" target="_blank">pauseService</a> pauses the selected subscription and updates the subscription information.</div></li><li class="slate-li " ><div style="position:relative">The EMP tracks the number of pauses and ensures that the user does not exceed the allowed number or maximum duration of pauses.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/c91d13bf-2e09-4fba-8a4e-3d00d7aabcc2.jpeg" style="
              width:570px;
	            height:604px;
	            aspect-ratio:570 / 604"
         /></div><h1 class="slate-h1 " >APIs</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/subscription-management-1/pause/pausesubscription_immediate" target="_blank">pauseSubscription</a></div></li></ul></p><p class="slate-p " ></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The Resume Subscription use case allows users to reactivate a paused subscription, making it active again. This feature enables customers to temporarily suspend their service and resume it when needed, without having to cancel and resubscribe. The resume functionality can be performed before the end of the bill cycle date, allowing users to regain access to their paused subscription.</p><h1 class="slate-h1 " >API Guidelines for Resuming a Subscription</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber logs in to the front-end and navigates to the subscription page.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a> API fetches a list of the subscriber&apos;s active and pause subscriptions.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the desired subscription in ‘pause’ status.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/subscription-management-1/pause/resumesubscription" target="_blank">resumeSubscription</a> API resumes the paused subscription and updates the subscription information.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/9057c18f-61b2-458e-89c3-fcb0d79b0659.jpeg" style="
              width:514px;
	            height:529px;
	            aspect-ratio:514 / 529"
         /></div><h1 class="slate-h1 " >APIs</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/subscription-management-1/pause/resumesubscription" target="_blank">resumeSubscription</a></div></li></ul></p>

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The Reactivate Subscription feature revives access to previously canceled, paused, or expired subscriptions, restoring services and resuming billing according to original terms. This seamless process ensures minimal disruption to users, allowing them to maintain uninterrupted access to their chosen platforms. By reactivating a subscription, administrators can prevent gaps in service, reduce cancellations, and promote customer satisfaction. This feature can be performed before the end of the bill cycle date, allowing users to regain access to their canceled subscriptions.</p><h1 class="slate-h1 " >API Guidelines for Reactivating a Subscription</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber logs in to the front-end and navigates to the subscription page.</div></li><li class="slate-li " ><div style="position:relative">The EMP system calls the /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a> API to fetch all the subscriptions, including active, paused, and canceled ones.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the canceled subscription and clicks &quot;Reactivate&quot; on the front-end.</div></li><li class="slate-li " ><div style="position:relative">The EMP calls /<a href="https://app.theneo.io/emp/core-standard-api/self-care/subscription-management-1/cancel-reactivation/reactivateservice-1" target="_blank">reactivateService</a> API checks whether the subscription status is &quot;Final Bill&quot; and reactivates the subscription before the bill cycle date ends.</div></li><li class="slate-li " ><div style="position:relative">The subscriber&apos;s front end displays the successful message &quot;Service is reactivated,&quot; which means the subscription was reactivated.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/1e80c1d4-5c3f-4801-a039-9fb78ca11888.jpeg" style="
              width:744px;
	            height:626px;
	            aspect-ratio:744 / 626"
         /></div><h1 class="slate-h1 " >APIs</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/subscription-management-1/cancel-reactivation/reactivateservice-1" target="_blank">reactivateService</a></div></li></ul></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p slate-indent-0" style="0px">The &quot;Cancel Pause&quot; feature allows the users to cancel the scheduled pause subscription. This feature gives users flexibility and control over their subscription, allowing them to enjoy the service whenever they are ready, without being stuck with an unwanted pause.</p><h1 class="slate-h1 " >API Guidelines for Cancelling a Pause</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">The subscriber logs in to the front-end and navigates to the subscription page.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscriptions</a> API fetches a list of all active subscriptions, including scheduled pause subscriptions.</div></li><li class="slate-li " ><div style="position:relative">The subscriber selects the desired scheduled pause subscription and clicks “Cancel Pause” on the front-end.</div></li><li class="slate-li " ><div style="position:relative">The /<a href="https://app.theneo.io/emp/core-standard-api/self-care/subscription-management-1/pause/cancelpause" target="_blank">cancelPause</a> cancels the scheduled pause subscription and changes the subscription status from “Pending Pause” to “Active”.</div></li><li class="slate-li " ><div style="position:relative">The subscription status is updated.</div></li></ol><div style="text-align:center"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/f207cecb-e9d2-46ad-bc7d-9f05085b929e.jpeg" style="
              width:669px;
	            height:556px;
	            aspect-ratio:669 / 556"
         /></div><h1 class="slate-h1 " >APIs</h1><p class="slate-p " ><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/subscription-management/getactivesubscriptions" target="_blank">getActiveSubscription</a></div></li><li class="slate-li " ><div style="position:relative">POST /<a href="https://app.theneo.io/emp/core-standard-api/self-care/subscription-management-1/pause/cancelpause" target="_blank">cancelPause</a></div></li></ul></p></p>

<p class="slate-p " >The Self-Care Management feature is a powerful tool that empowers users to take control of their account settings, preferences, and information within our platform. With this functionality, users can easily manage and update their personal details, including subscriptions, contacts, devices, parental controls, payments, and more.</p><p class="slate-p " >Users can access an overview of their active subscriptions, making it easy to upgrade or downgrade as needed. Additionally, they can update their contact information, add new contacts, delete existing ones, and even reset forgotten contact passwords. The feature also enables device management capabilities, allowing users to view a list of devices associated with their account, get an overview of active devices, register new devices, or remove devices as needed.</p><p class="slate-p " >To provide an additional layer of control and security, the Self-Care Management feature includes parental control capabilities. Users can add, update, reset, or delete parental controls on their account, giving them peace of mind knowing that they can restrict access to sensitive content or features as needed. Furthermore, users can manage their payment information and methods by viewing a list of payments made on their account, getting details about vouchers and promotions, and even updating their payment methods as necessary.</p><p class="slate-p " >By providing these comprehensive self-care management capabilities, we empower users with the tools they need to take control of their account settings, preferences, and information. With Self-Care Management, users can personalize their experience and ensure a seamless interaction with our platform, giving them greater flexibility and control over their account details.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The Self-Care Management feature is a powerful tool that empowers users to take control of their account settings, preferences, and information within our platform. With this functionality, users can easily manage and update their personal details, including subscriptions, contacts, devices, parental controls, payments, and more.

Users can access an overview of their active subscriptions, making it easy to upgrade or downgrade as needed. Additionally, they can update their contact information, add new contacts, delete existing ones, and even reset forgotten contact passwords. The feature also enables device management capabilities, allowing users to view a list of devices associated with their account, get an overview of active devices, register new devices, or remove devices as needed.

To provide an additional layer of control and security, the Self-Care Management feature includes parental control capabilities. Users can add, update, reset, or delete parental controls on their account, giving them peace of mind knowing that they can restrict access to sensitive content or features as needed. Furthermore, users can manage their payment information and methods by viewing a list of payments made on their account, getting details about vouchers and promotions, and even updating their payment methods as necessary.

By providing these comprehensive self-care management capabilities, we empower users with the tools they need to take control of their account settings, preferences, and information. With Self-Care Management, users can personalize their experience and ensure a seamless interaction with our platform, giving them greater flexibility and control over their account details.

Sections