Install the SDK

Load the Plandalf browser SDK on any site, app, page builder, or framework route.

The browser SDK is served from your organization host.

<script>
  window.plandalf = window.plandalf || function () {
    (window.plandalf.q = window.plandalf.q || []).push(arguments);
  };
</script>
<script src="https://acme.plandalf.com/js/plandalf-sdk.js" async></script>

Where to place the SDK

Load the SDK wherever the customer can take a buying action. The same install pattern works across common web surfaces.

Wait for readiness

The SDK loads asynchronously. Use plandalf.ready() when code must run after the SDK instance exists.

plandalf.ready((sdk) => {
  sdk.identify(userJwt);
  sdk.present("pro-plan");
});

You can also listen for the browser event:

window.addEventListener("plandalf:loaded", () => {
  console.log("Plandalf SDK loaded");
});

Install by platform

Verify installation

Open DevTools on the page and run:

plandalf.ready((sdk) => {
  console.log(typeof sdk.present === "function");
});

The check should print true. After that, you can call SDK instance methods such as present, mount, identify, reset, gate, from, and promo.

Builder context

Move from SDK setup to the commerce surface.

SDK docs cover install, identity, gates, events, and React integration. The linked product surfaces show what the SDK is presenting or listening for.

The Numi API Keys settings page used to create organization API keys.
API keys and SDK configuration should be set before wiring checkout into an app.
The Numi Developer API documentation with sidebar navigation and SDK method reference.
SDK reference owns method details; builder resources explain the business path.
The Numi checkout requirements screen showing gate controls.
Gates decide when an offer or buying surface should be available.

Feature detail