SaligPay Node SDK

Subscription Plans

Copy page

Creating a Plan

Code
 
const plan = await saligpay.subscriptions.createPlan({
    name: "Premium Monthly",
    amount: 2000, // ₱20.00 in centavos
    currency: "PHP",
    interval: "monthly",
    interval_count: 1,
    description: "Premium plan billed monthly",
    cycle_count: 12,
    metadata: { tier: "premium" },
});

console.log("Plan ID:", plan.id);
console.log("Plan Name:", plan.name);
console.log("Amount:", plan.amount);

Listing Plans

Code
 
const plans = await saligpay.subscriptions.listPlans({
    limit: 20,
    name: "Premium",
    sort_by: "created_at",
    order: "desc",
});

console.log("Plans:", plans.plans);
console.log("Has More:", plans.hasMore);

Getting a Plan

Code
 
const plan = await saligpay.subscriptions.getPlan("plan_abc123");

console.log("Plan:", plan);
console.log("Interval:", plan.interval);
console.log("Live Mode:", plan.livemode);

Create Plan Options

Code
 
interface CreatePlanOptions {
    /** Plan name (required) */
    name: string;

    /** Amount in centavos (required) */
    amount: number;

    /** Currency code (required) */
    currency: string;

    /** Billing interval (required) */
    interval: "weekly" | "monthly" | "yearly";

    /** Number of intervals between billings (required) */
    interval_count: number;

    /** Plan description (optional) */
    description?: string;

    /** Number of billing cycles (optional) */
    cycle_count?: number;

    /** Additional metadata (optional) */
    metadata?: Record<string, unknown>;
}

List Plans Options

Code
 
interface ListPlansOptions {
    /** Maximum number of results (optional, default: 20) */
    limit?: number;

    /** Filter by plan name (optional) */
    name?: string;

    /** Sort field (optional) */
    sort_by?: string;

    /** Sort order (optional) */
    order?: "asc" | "desc";
}

Response Types

PlanDto

Code
 
interface PlanDto {
    id: string;
    name: string;
    amount: number;
    currency: string;
    interval: string;
    interval_count: number;
    description?: string;
    livemode: boolean;
    metadata?: Record<string, any>;
    created_at: number;
    updated_at: number;
}

PlansListResponseDto

Code
 
interface PlansListResponseDto {
    plans: PlanDto[];
    hasMore: boolean;
}

PlanInterval

Code
 
enum PlanInterval {
    WEEKLY = "weekly",
    MONTHLY = "monthly",
    YEARLY = "yearly",
}

Interval Options

Interval	Description	Example
weekly	Bill every week	interval_count: 1 = weekly, interval_count: 2 = bi-weekly
monthly	Bill every month	interval_count: 1 = monthly, interval_count: 3 = quarterly
yearly	Bill every year	interval_count: 1 = annually

Plan Examples

Weekly Plan

Code
 
const weeklyPlan = await saligpay.subscriptions.createPlan({
    name: "Weekly Premium",
    amount: 500,
    currency: "PHP",
    interval: "weekly",
    interval_count: 1,
    description: "Premium plan billed weekly",
});

Quarterly Plan

Code
 
const quarterlyPlan = await saligpay.subscriptions.createPlan({
    name: "Quarterly Business",
    amount: 5000,
    currency: "PHP",
    interval: "monthly",
    interval_count: 3,
    description: "Business plan billed quarterly",
});

Annual Plan with Cycle Limit

Code
 
const annualPlan = await saligpay.subscriptions.createPlan({
    name: "Annual Enterprise",
    amount: 50000,
    currency: "PHP",
    interval: "yearly",
    interval_count: 1,
    description: "Enterprise plan billed annually",
    cycle_count: 3, // Bills for 3 years then stops
});