Plans
Plans define how much a customer should be billed and how often. Create plans before creating subscriptions.
Recommended Flow
- Decide the billing interval and amount.
- Create a plan with
name,description,interval,amount, andlocalCurrency. - Store the returned
code. - Use the plan code when creating subscriptions.
Amount Strategy
Use amountCurrency: "local" when the plan amount is already in the customer's billing currency. Use amountCurrency: "settlement" when you price in your settlement currency and want Kyshi to calculate local amounts when needed.
Supported Intervals
daily, weekly, monthly, quarterly, biannually, annually.
Integration Notes
- Store the plan code returned by Kyshi; subscriptions are created against a plan.
- Use clear internal naming so your support and finance teams can identify what each plan represents.
- If your pricing changes, create or update plans intentionally so active subscription behavior remains predictable.
For exact request and response schemas, see Reference > Plans.
Updated 2 days ago
