OpenSolar API

Enterprise-grade API for solar Pros who run on multiple systems.

Pro> OpenSolar API

One API to run your whole solar stack

Connect OpenSolar to your CRM, accounting, ops, and incentive tools. No retyping. No data mismatches. Every project, design, and price stays in sync from lead to install. Use the tools your team already knows. Let one source of truth drive every handoff, invoice, and report.

Prefer to keep your workflow inside OpenSolar? OS 3.0 is a full solar operating system offered free of charge. Use the API when you choose to run workflows in third-party systems and move data in and out of OpenSolar.

A diagram illustrating OpenSolar API

Why larger Pros choose OpenSolar API

One API for your full OpenSolar setup

Projects, systems, designs, pricing, hardware, contacts, workflows, and more are all available through one enterprise-grade API.

Plug into your existing stack

Keep the CRM, finance, and ops systems your team already uses. Connect them to OpenSolar instead of ripping anything out.

Same data and logic your team sees in OpenSolar

The API uses the same data model as the app. What you design, price, and track in OpenSolar is exactly what your integrations see.

Built around the moments where money moves

Use OpenSolar data to power quotes, sold jobs, payments, and incentive or STC claims, so revenue does not get stuck in manual handoffs.

Works for big IT teams and 5-10 person shops

Whether your integrations are built in-house or by partners, they all run on the same OpenSolar API.

What Pros actually do with OpenSolar API

Each of these can stand alone or be stitched together. These are common ways larger Pros keep OpenSolar in sync with third-party systems.

Auto-create OpenSolar projects from new leads

Create projects and contacts from CRM opportunities

Trigger outreach from customer proposal actions

Sync project status between OpenSolar and other systems

Push sold jobs into ordering and ops tools

Push invoices and payments into accounting tools

Send system data and pricing into proposal tools or CPQ

Feed OpenSolar data into finance and incentive platforms

Export project and system data into reporting and analytics

Stream webhooks into internal systems for real-time updates

What the OpenSolar API gives you access to

The API gives your tools direct read and write access to the same data your team uses in the OpenSolar app.

Organizations and projects

Systems and designs

Contacts, roles, and workflows

Pricing, payments, and costing

Hardware and component catalog

Incentives, tariffs, and configuration

Teams and sharing

Events, IDs, and webhooks

Pricing

OpenSolar API and Connectors are paid add-ons for Pros who run workflows across multiple systems. Pricing is geo-specific. Check Control → Connect for your exact API Access pricing. Connector pricing is listed in the Help Center.

OpenSolar API (for API Access)

How it’s priced

API Access is billed as a per-project fee. The fee is applied when you create a project.

Trial and billing

  • Enable API Access in Control → Connect to start a 30-day free trial.
  • Set up Wallet in Control → Your Wallet.
  • After the trial, billing starts at the beginning of the closest month post-trial.
  • Charges are deducted from your OpenSolar Wallet balance when a project is created.

Wallet requirements

  • Wallet must be enabled and funded for paid API usage.
  • If Wallet is not enabled or does not have enough balance, new projects will not be created.

Connectors

Connectors are OpenSolar-built and supported connections that sync data between OpenSolar and specific third-party tools. A good example is our accounting connectors for Xero and QuickBooks.

They reduce manual exports and double entry by keeping key records in sync, especially where accuracy matters most, like invoices and payments.Connectors are built and supported by OpenSolar, so your team has a clear owner for setup and support.

How it’s priced

Connectors are billed as a flat monthly subscription (geo-specific). Some connectors, such as Xero Accounting and QuickBooks, may be available only in certain regions.

Wallet requirements

  • Connectors are billed through OpenSolar Wallet.
  • Keep Wallet active to avoid service interruption.

Enterprise Services

For Pros who want a bundled setup with hands-on help, deeper support, and optional add-ons, we offer Enterprise Services.

What it can include:

  • Onboarding: Specialist onboarding sessions with hands-on support for account configuration, including team setup, payment settings, integrations, and hardware
  • API technical support: Dedicated assistance from OpenSolar engineers for integrating OpenSolar with your CRM and lead management systems
  • Accounting connectors: Access to our native Xero and QuickBooks connectors to sync payment data and cut double entry
  • Enterprise support: Priority phone and ticket support with a dedicated in-region Pro Product Specialist
  • Training: Live training sessions covering operational use and new feature rollouts
  • Dedicated account executive: Strategic guidance and escalation support when needed
  • Custom proposal work: Custom proposal templates, custom showcase components, custom forms, and documents
  • Early access: User research community and priority feature access
  • Co-marketing: Case studies and success stories

Access dates

17 March 2026

From 17 March, API integrations are blocked unless your org enables API Access in Control → Connect. Enable it by March 16 to avoid interruption.

16 April 2026

From 16 April, API Access moves to paid billing after the 30-day trial. Charges are deducted from the Wallet when a project is created. Project creation is blocked if the Wallet balance is not sufficient.

What to do before 17 March 2026

If you already use the API, this keeps you live when access rules change.

Enable API Access

Control → Connect → enable API Access (do this by 16 March)

Set up Wallet

Control → Your Wallet → add payment details and top up balance
Tip: Once the trial starts, you have 30 days to fund your Wallet ahead of the 16 April billing date.

Review workflows that depend on the API

List the key flows that rely on the API today, such as CRM sync, finance integrations, accounting, and incentive or STC
submissions. Note: Provided you’ve completed the above steps, you will not need to rebuild or adjust your existing API implementations. They will operate normally.

Share docs with your tech team or partner

Send them the API docs and this page so they can plan ahead.

If you expect heavy API usage or want help thinking through the impact, your OpenSolar contact can walk through options.

What the Pros have to say

We’ve used Salesforce to manage our sales and operations for a long time. We really liked OpenSolar’s design and proposal tools, but there was no way to import leads, contacts, materials, and projects between the two platforms. So when they offered the OpenSolar API, we jumped on it. Now we get the best of both worlds. We still have our existing processes, but now with what we reckon is the best solar design tool out there.
Peter
Leeson Solar (Victoria, Australia)

For developers and integration partners

If you’re wiring up the OpenSolar API for a Pro, or planning new integrations:

  • Use the OpenSolar API docs to see auth, endpoints, rate limits, and webhooks
  • Start with organizations, projects, systems, pricing, hardware, workflows, and webhooks
  • Plan for rate limits and design your calls to avoid per-user and per-org caps
  • Work with your Pro customer to ensure API Access is enabled and Wallet is set up

FAQs

What changes for existing API users?

From March 17, 2026, API integrations are blocked unless your org enables API Access in Control → Connect. Enabling starts a 30-day free trial. From April 16, 2026, API Access moves to paid billing. Charges are deducted from your Wallet when you create a project. If Wallet is not enabled or has insufficient balance, new projects will not be created.

What changes for new API users?

Enable API Access in Control → Connect to start a 30-day free trial. Wallet shows your trial period. After the trial ends, billing starts at the beginning of the closest month post-trial and charges are deducted from Wallet on project creation.

How does the 30-day free trial work?

Enabling API Access starts a 30-day free trial. The trial period is shown in Control → Your Wallet. You have the trial period to set up Wallet and top up your balance before paid billing begins.

When and how are API Access charges applied?

API Access is billed as a per-project fee applied when you create a project. Charges are deducted from your OpenSolar Wallet balance.

What happens if the Wallet is not set up or does not have enough balance?

If Wallet is not enabled or has insufficient balance when a charge is due, new projects will not be created until Wallet is enabled and funded.

If I top up Wallet after being blocked, can I create a project right away?

Yes. Wallet top-ups usually process within a few seconds. Once the funds appear in your Wallet, you can create a project again right away and any applicable charge is applied at the time of project creation.

Does this change what the API can do?

No. This is an access and billing change. API capabilities and endpoints stay the same.

Do you offer access to deeper design and proposal datasets?

Yes. Some datasets and endpoints, including deeper design and proposal data, are available through Raw Data API Access. This is a separate API access level and is priced differently from standard API Access. If your team needs these datasets, you can start a Raw Data API Access trial to confirm coverage and avoid disruption. If you enable API Access and do not see everything your workflow needs, you may require Raw Data API Access. For details on what is included, see the documentation.

What happens if an org disables API Access or Raw Data API Access?

If your org disables API Access or Raw Data API Access, your integrations can still use the OpenSolar API for any projects where API Access was previously purchased. However, the OpenSolar API will not be available for new projects created after it’s disabled, or for any existing projects where the API Access (or Raw Data API Access) fee was not charged.

What happens if an org enables both API Access and Raw Data API Access?

If both are enabled, Raw Data API Access takes priority. On the next API call, OpenSolar will automatically switch off API Access and keep Raw Data API Access enabled.

Are any endpoints available without API Access or Raw Data API Access?

Yes. Account setup endpoints remain available. Endpoints that access projects, project-related data, or customer data are blocked unless your org has API Access or Raw Data API Access enabled.

How many API calls can we make per project, contact, or system?

There is no limit on API calls or webhook triggers. To prevent misuse, OpenSolar may apply throttling limits to protect platform reliability.

Are Connectors priced the same way as the API?

No. API Access is a per-project fee applied on project creation. Connectors are billed as a flat monthly subscription, with geo-specific pricing in the Help Center.

Do we have to use the OpenSolar API?

No. OS 3.0 is a full operating system you can run inside OpenSolar at no extra cost. Use the API when you choose to run workflows in third-party systems and move data out of OpenSolar.

Where can my dev team or integration partner find technical details?

Start with the OpenSolar API docs for auth, endpoints, webhooks, and rate limits.