Skip to main content
Hero Light

​
Key Features

Here’s what you’ll learn:
  • Seamless customer and subscription management.
  • Flexible API endpoints for creating, retrieving, updating, and deactivating entities.
  • Detailed response formats for precise integration.

​
How to get Authentication token

You will find the token under Configuration -> Domain Setup -> API Key Hero Light

​
Use Cases

​
1. Automate the Customer Onboarding Process

Efficiently onboard customers with our APIs designed to simplify the user management process. From adding new users to retrieving detailed customer profiles, these endpoints empower you to:
  • Seamlessly Create Accounts: Add new customers with essential details such as their first name, last name, email and payment preferences.
    Example: Create a new customer account when a user signs up for a subscription package.
{
  firstName: "John",
  lastName: "Doe",
  email: "[email protected]",
  isPaidOutside: false,
  packageId: "1234"
}
  • Search and Retrieve Customer Profiles: Quickly fetch customer data based on unique identifiers (e.g., email or ID). Use this to build a detailed customer dashboard or verify user details before providing services.
    Example: Search for a customer by their email address.
GET /customers?email=john.doe@test.com
  • Deactivate Inactive Users: Remove access for users no longer active in your system while preserving their data for compliance or reactivation purposes.
    Example: Deactivate a customer who cancels their subscription.
DELETE /customers/{customerId}

​
2. Create Subscription Packages Tailored to User Needs

Meet diverse customer demands by offering customizable subscription packages. The Package APIs provide the tools you need to:
  • Design Packages with Flexibility: Define packages with custom names, pricing and billing intervals (e.g., Daily, Weekly, Monthly).
    Example: Create a “Premium” subscription package with $20 monthly fee and a 7-day free trial.
{
  "name": "Premium",
  "price": 20,
  "interval": "Monthly",
  "freeTrialDays": 7
}
  • Modify Packages on the Fly: Update existing packages to introduce promotional pricing, adjust billing intervals, or deactivate legacy offerings.
    Example: Update the “Basic” package to include a yearly billing option at $100.
{
  "name": "Basic",
  "price": 100,
  "interval": "Yearly",
  "freeTrialDays": 2
}

​
3. Track and Manage Payments with Ease

Ensure transparency and efficiency in your payment workflows with the Invoice APIs. These endpoints support:
  • Accurate Invoice Creation: Generate invoices with details like subscription IDs, expiry dates, and payment URLs.
    Example: Create an invoice for a customer’s upcoming monthly subscription payment.
{
  _id: "invoice123", //invoice Id in your system
  subscriptionId: "sub456",
  expiryDate: "2024-12-31",
  invoiceUrl: "https://www.example.com",
  paidAt: "2024-11-30"
}
  • Automated Payment Tracking: Record payments as they are received to keep financial records up-to-date.
    Example: Mark an invoice as paid once payment is confirmed.
{
  success: true,
  message: "Invoice paid successfully"
}
By integrating these features into your system, you minimize manual errors, provide a hassle-free payment experience for customers, and maintain a strong financial workflow while offering comprehensive career development solutions.