Introduction

The Modulate Partner API gives ISO partners programmatic access to every dimension of their merchant portfolio — pricing, processor profiles, transactions, statements, residuals, compliance, and AI-powered insights — through a single, consistent REST API.

What you can build

API basics

Rate limits

Each API key may make 120 requests per rolling 60-second window unless we have raised its limit, shared across all endpoints. Limits are tracked per key, not per endpoint, so every key in your organization has its own budget. Exceeding the limit returns a 429 Too Many Requests response with a Retry-After header indicating when you can resume.

An AI call counts against both the standard and the AI budget, and is refused with 429 if either is exhausted.

Every response carries your position in the budget that call was metered against. On data endpoints and /me that is the standard budget, so X-RateLimit-Limit reads 120 (or your key’s raised limit); on /rate-limit itself the headers describe its own 60-request polling budget, while the response body reports your standard budget.

Checking before you spend

GET /api/partner/rate-limit reports the same window for every active key in your organization, with the key you authenticated with listed first. Use it to pre-flight a batch job, or to see the separate AI budget that applies to POST .../explain — the headers above only reveal that budget once you have already called an AI endpoint.

curl https://getmodulate.dev/api/partner/rate-limit \
  -H "X-Partner-API-Key: YOUR_API_KEY"

Checking your status is metered against its own budget, so polling it does not consume the standard quota it reports.

Support

• Email: it@flute.com. Include the meta.request_id from the failing response.
• Service levels: breaking-change notice, support response times, and what we measure
• Partner Portal: withensemble.ai