Quickstart

This guide takes you from an existing API to a purchasable, proxied service. You'll need a ZeroClick dashboard account and the base URL of the API you want to sell.

1. Create an organization and service#

In the dashboard, create your organization, then create a Service with a name, a description, a Pay subdomain slug, and your upstream URL (the base URL of your API). Agents use https://{service-slug}.pay.zeroclick.io, and ZeroClick proxies those requests to your upstream URL. Agents read the description when deciding whether your service can do the job, so be specific about what your API does.

Set the upstream auth header if your API does not use Authorization: Bearer {apiKey}. The value template can include {{apiKey}}, for example Token {{apiKey}}.

2. Choose how buyers pay#

Create a Product on the service and pick its pricing model. ZeroClick supports four setup paths:

• Pay as you go: buyers fund an initial USD balance, then usage spends it down until they extend it.
• Subscription: buyers pay a monthly or yearly fee for an explicit access period. Renewals are separate purchases in the MVP.
• Subscription + included usage: buyers pay a monthly or yearly fee that grants included credits, then can extend overage balance.
• Prepaid credits: buyers buy a balance first, then usage spends it down.

See Product shapes for how to choose a path and Products & pricing for every field in detail.

3. Implement the API key exchange#

Host one endpoint on your API that ZeroClick calls after a buyer purchases a plan. It exchanges a stable ZeroClick buyer ID for an API key in your system:

import express from "express";
 
const app = express();
 
app.use(express.json());
 
app.post("/zeroclick/api-key", (req, res) => {
	const { userId, plan, product, entitlements } = req.body;
	const apiKey = issueApiKeyForUser(userId, { plan, product, entitlements });
	res.json({ apiKey });
});

The full contract, including the payload shape and configurable exchange URL, is in API key exchange.

4. Report usage for metered products#

For pay as you go, subscription + included usage, and prepaid credits, call the usage check API before side effects when an action may be blocked:

Then add a usage header to responses on proxied endpoints so ZeroClick can meter consumption:

HTTP/1.1 200 OK
Content-Type: application/json
X-ZeroClick-Usage: api-requests=1

Prefer batched, asynchronous reporting for long-running work:

Both usage endpoints authenticate with service API keys scoped to usage:read and usage:write. Create these from the Service API keys section on the service detail page; tokens are shown once. If your product is subscription only, skip usage reporting and enforce access from the API key and entitlements delivered during exchange. Both metered reporting options are covered in Metering & usage.

5. Test it end-to-end#

Your service gets a proxy at https://{service-slug}.pay.zeroclick.io. Check that your products are discoverable:

curl https://{service-slug}.pay.zeroclick.io/plans

Buy a test product, make a proxied call to one of your endpoints, and verify the expected result: usage appears for metered products, while subscription products grant access until the purchased period expires. Normal proxied calls use zero-cost MPP/x402 wallet identity to identify the buyer; they do not move funds. Only plan purchase and /extend top-up routes move money. When everything looks right, run through the going live checklist.