Campaign

Overview

Campaigns are promotional offers that bundle a plan and, optionally, a coupon. They let you run targeted acquisition, renewal, cancellation, or creation flows and surface the right plan and discount to a customer at the right time. The Open API exposes a single, read-only endpoint to resolve a campaign and its attached offer from your front end before starting a checkout.

---

How It Works

• Look a campaign up by campaign_id (returns at most one) or by campaign_key (matched through campaign runs; may return several).
• The response embeds the campaign's full plan (with its parent product) and its coupon when one is attached.

---

API Endpoints

---

Important Behaviors

• A campaign is always scoped to a site, so every request must include site_id.
• A valid request that matches nothing returns an empty campaigns array with HTTP 200 — it is not treated as an error.