SaaS Configurator Public API Endpoints in Sparkforge

The SaaS Configurator Public API gives Sparkforge agencies and marketplace developers programmatic access to plans, subscriptions, and bulk SaaS enablement. Replace clicks with code for onboarding, billing, and reporting at scale.

Who This Is For

• Marketplace developers building on Sparkforge.
• Agencies automating SaaS onboarding, billing, and reporting.
• Teams building custom dashboards, internal admin tools, or partner integrations.

Why It Matters

• Deep integrations: Connect Sparkforge to external CRMs, billing tools, or partner platforms with no manual exports.
• Automated provisioning: Trigger plan assignments, renewals, and upgrades from scripts or iPaaS workflows.
• Bulk enablement: Onboard hundreds of sub-accounts in a single call.
• Live analytics: Pull plan and subscription data into custom dashboards in real time.
• Less manual work: Cut human error during large migrations.

Before You Call These Endpoints

1. Confirm SaaS Mode is enabled for your agency.
2. Create OAuth 2.0 credentials with the saas/* scope.
3. Obtain an access token.
4. Respect the global rate limit of 10 requests per second.

Available Endpoints

1. Get All Agency Plans

Fetch every SaaS plan configured for your agency. Useful for rendering plan-selection menus or comparison tools dynamically.

• Endpoint: GET /saas/agency/plans
• Response: JSON array of plan IDs, names, prices, and features.

2. Get Location Subscription Details

Pull subscription status, plan, payment provider, and billing data for a single sub-account.

• Endpoint: GET /saas/location/{locationId}/subscription
• Response: JSON with plan ID, active status, next billing date, etc.

3. Bulk Enable SaaS

Enable SaaS Mode for many sub-accounts in one call. Built for migrations and large agency rollouts.

• Endpoint: POST /saas/bulk-enable
• Payload: JSON array of sub-account IDs and plan assignments.

4. Get SaaS Sub-Accounts

List every sub-account currently in SaaS Mode for your agency. Useful for adoption dashboards.

• Endpoint: GET /saas/agency/sub-accounts
• Response: JSON array of sub-account IDs, names, and active plan info.

5. Get SaaS Plan Details

Retrieve full configuration and pricing for a single plan.

• Endpoint: GET /saas/agency/plan/{planId}
• Response: JSON with pricing, usage limits, features, and terms.

Common Use Cases

• Marketplace partners auto-provision SaaS features when a customer signs up.
• Agencies remove human touchpoints from SaaS plan assignment.
• Internal dashboards track plan adoption and billing health.
• Large migrations move many sub-accounts to SaaS in a controlled rollout.
• SaaS billing data syncs into BI tools or external CRMs.