Help Center

Overview of SaaS Configurator APIs

The SaaS Configurator Public API provides programmatic access to manage subscription plans and enable SaaS features for sub-accounts within your agency. These endpoints are designed for developers and advanced users who need to automate onboarding, integrate subscription data, or build custom administrative tools.

Key Benefits

Using these APIs offers several strategic advantages for scaling your operations:

Automated Provisioning: Assign plans and enable SaaS mode for multiple sub-accounts automatically, bypassing manual setup.
Data Integration: Pull real-time subscription and plan details into external dashboards, CRMs, or analytics platforms.
Operational Efficiency: Streamline large-scale migrations or bulk onboarding processes with a single API call.
Custom Development: Build internal tools or client-facing applications that interact directly with your SaaS configuration.

Prerequisites

Before you can use these endpoints, ensure the following conditions are met:

SaaS Mode must be enabled for your agency account.
You must have valid OAuth 2.0 API credentials with the necessary saas/* scopes.
You must obtain an access token for authentication with each API request.
Be aware of and adhere to the global API rate limit.

Available Endpoints

1. Get All Agency Plans

This endpoint retrieves a list of all SaaS plans you have configured. It is useful for dynamically populating plan selection interfaces in custom applications or for building comparison tools.

Method & Path: GET /saas/agency/plans
Response: Returns a JSON array containing objects with details like plan ID, name, price, and included features.

2. Get Location Subscription Details

Use this endpoint to fetch the current subscription information for a specific sub-account (location).

Method & Path: GET /saas/location/{locationId}/subscription
Response: Returns a JSON object with data such as the assigned plan ID, active status, next billing date, and payment provider.

3. Bulk Enable SaaS

This endpoint allows you to programmatically enable SaaS mode for multiple sub-accounts in a single operation, which is ideal for mass onboarding.

Method & Path: POST /saas/bulk-enable
Payload: Send a JSON array containing the IDs of the sub-accounts you wish to enable, along with their assigned plan information.

4. Get SaaS Sub-Accounts

Retrieve a list of all sub-accounts under your agency that currently have SaaS mode enabled.

Method & Path: GET /saas/agency/sub-accounts
Response: Returns a JSON array listing sub-accounts with details like their ID, name, and active plan.

5. Get SaaS Plan Details

Query comprehensive details about a specific SaaS plan, including its pricing structure and feature set.

Method & Path: GET /saas/agency/plan/{planId}
Response: Returns a JSON object with in-depth information such as pricing tiers, usage limits, included features, and terms.

Common Use Cases

Automating the client onboarding process by instantly assigning a plan upon sign-up.
Building a custom dashboard to monitor SaaS adoption rates and subscription health across all sub-accounts.
Syncing billing and plan data with an external CRM or financial system.
Managing a large-scale migration of existing sub-accounts to a new SaaS offering.

Frequently Asked Questions

Q: What permissions are required to use these APIs?

A: You need API credentials (OAuth 2.0) with the appropriate saas/* scopes. Verify your access in your agency's API settings.

Q: Can I create or modify SaaS plans through the API?

A: No. The current API endpoints are read-only for plan data and enablement functions. Creating, editing, or deleting plans must be done within the SaaS Configurator interface in your CRM.

Q: Are these APIs available to all agencies?

A: They are available to agencies that have both SaaS Mode enabled and the necessary API access permissions granted to their account.

Q: Is there a limit on how many API calls I can make?

A: Yes. All API requests are subject to a standard rate limit. Please consult the general API documentation for the latest rate limit guidelines.

Next Steps

To begin, review the complete API documentation for detailed request and response examples, error codes, and authentication specifics. It is recommended to test the endpoints using your agency's credentials in a development or staging environment first.

Manage SaaS Subscriptions and Plans via API