Interface CreatePlanParams

Parameters for creating a recurring billing plan (the reusable template a subscription is based on).

interface CreatePlanParams {
    amount: Money;
    interval: string;
    intervalCount: number;
    merchantPlanNo: string;
    name: string;
    totalCycles: number;
}

Properties

amount: Money

Amount charged each cycle (decimal-string amount + currency). Required.

interval: string

Billing interval unit, e.g. "day", "week", "month". Required.

intervalCount: number

Number of interval units per cycle (e.g. interval="month", intervalCount=3 → quarterly). Required.

merchantPlanNo: string

Your unique plan reference. Required.

name: string

Human-readable plan name. Required.

totalCycles: number

Total number of cycles to bill before the plan completes. Required.