Plan

Overview

Plans define what a customer can buy — price, billing interval, and the product they unlock. Use these endpoints to retrieve a specific plan, or to resolve the free plans a caller is eligible for by IP address or email domain.

---

How It Works

1. Retrieve a plan — POST or GET /plan with a plan_id returns the full plan and its parent product.
2. Find eligible free plans — resolve the active, free plans a caller qualifies for, either by their IP address (/plan/ip/authorization) or by their email domain (/plan/domain/authorization).

---

API Endpoints

---

Important Behaviors

• Retrieving a plan requires both site_id and plan_id; the plan is returned only when its product belongs to that site.
• The authorization endpoints return only active, free plans (amount 0) whose IP/domain allow-list matches the caller, along with eligible and filtered counts.
• These endpoints are served from the global edge for fast, low-latency responses.