absolutepay (Node SDK) - v0.7.1
    Preparing search index...

    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;
        trialDays?: number;
    }
    Index

    Properties

    amount interval intervalCount merchantPlanNo name totalCycles trialDays?

    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.

    trialDays?: number

    Optional free-trial length in days (0–365). When > 0 the customer authorizes but isn't charged until the trial ends; the subscription reports TRIALING until then. Omitted/0 charges immediately after authorization.

    Settings

    Member Visibility

    On This Page

    Properties