SaligPay Node SDK

Subscriptions

Copy page

Initiating a Subscription

Code
 
const subscription = await saligpay.subscriptions.initiate({
    plan_id: "plan_premium_monthly",
    customer_email: "customer@example.com",
    customer_name: "Juan Dela Cruz",
    customer_phone: "+639123456789",
    billing_address: {
        line1: "123 Main St",
        city: "Manila",
        state: "Metro Manila",
        postal_code: "1000",
        country: "PH",
    },
    metadata: { source: "website" },
});

console.log("Subscription ID:", subscription.subscription.id);
console.log("Status:", subscription.subscription.status);

Processing Subscription Payment

Code
 
// Using payment method ID
const result = await saligpay.subscriptions.processPayment({
    sessionToken: "550e8400-e29b-41d4-a716-446655440002",
    payment_method_id: "pm_gcash_abc123",
});

// Or with card details
const result = await saligpay.subscriptions.processPayment({
    sessionToken: "550e8400-e29b-41d4-a716-446655440002",
    cardDetails: {
        card_number: "4111111111111111",
        exp_month: "12",
        exp_year: "2026",
        cvc: "123",
    },
});

Getting Subscription Session

Code
 
const session = await saligpay.subscriptions.getSession("session-token");

console.log("Session Token:", session.sessionToken);
console.log("Plan:", session.plan);
console.log("Customer:", session.customer);
console.log("Status:", session.status);

Getting a Subscription

Code
 
const subscription = await saligpay.subscriptions.get("sub_xyz789");

console.log("Subscription:", subscription.subscription);

Listing Subscriptions

Code
 
const subscriptions = await saligpay.subscriptions.list({
    limit: 20,
    customer_id: "cus_abc123",
    plan_id: "plan_xyz",
    sort_by: "created_at",
    order: "desc",
});

console.log("Subscriptions:", subscriptions);

Updating Subscription Plan

Code
 
const subscription = await saligpay.subscriptions.updatePlan(
    "sub_xyz789",
    { plan_id: "plan_enterprise_monthly" }
);

console.log("Updated Subscription:", subscription.subscription);

Updating Payment Method

Code
 
const subscription = await saligpay.subscriptions.updatePaymentMethod(
    "sub_xyz789",
    { payment_method_id: "pm_grab_pay_xyz" }
);

console.log("Updated Payment Method:", subscription.subscription);

Canceling a Subscription

Code
 
const subscription = await saligpay.subscriptions.cancel(
    "sub_xyz789",
    "requested_by_customer"
);

console.log("Canceled Subscription:", subscription.subscription);

Initiate Options

Code
 
interface InitiateSubscriptionOptions {
    /** Plan ID to subscribe to (required) */
    plan_id: string;

    /** Customer email address (required) */
    customer_email: string;

    /** Customer full name (required) */
    customer_name: string;

    /** Customer phone number (optional) */
    customer_phone?: string;

    /** Billing address (optional) */
    billing_address?: {
        line1: string;
        city: string;
        state: string;
        postal_code: string;
        country: string;
    };

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

Process Payment Options

Code
 
interface ProcessSubscriptionPaymentOptions {
    /** Session token from initiate (required) */
    sessionToken: string;

    /** Payment method ID (optional if using cardDetails) */
    payment_method_id?: string;

    /** Card details for card payments (optional if using payment_method_id) */
    cardDetails?: {
        card_number: string;
        exp_month: string;
        exp_year: string;
        cvc: string;
    };
}

List Options

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

    /** Filter by customer ID (optional) */
    customer_id?: string;

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

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

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

Response Types

SubscriptionResponseDto

Code
 
interface SubscriptionResponseDto {
    success: boolean;
    subscription: SubscriptionDto;
}

SubscriptionDto

Code
 
interface SubscriptionDto {
    id: string;
    customer_id: string;
    plan_id: string;
    status: "active" | "inactive" | "canceled" | "trialing" | "past_due" | "unpaid" | "incomplete";
    current_period_start: number;
    current_period_end: number;
    created_at: number;
    updated_at: number;
    metadata?: Record<string, any>;
}

GetSessionResponseDto

Code
 
interface GetSessionResponseDto {
    sessionToken: string;
    plan: {
        id: string;
        name: string;
        amount: number;
        currency: string;
        interval: string;
        intervalCount: number;
        description?: string;
    };
    customer: {
        email: string;
        name: string;
        phone?: string;
    };
    subscriptionId?: string;
    status: "pending" | "processing" | "completed" | "failed";
}

Subscription Statuses

Status	Description
active	Subscription is active and billing
inactive	Subscription is paused or inactive
canceled	Subscription has been canceled
trialing	In trial period
past_due	Payment failed, retrying
unpaid	Payment failed, no longer retrying
incomplete	Initial setup incomplete

Session Statuses

Status	Description
pending	Session awaiting payment
processing	Payment being processed
completed	Subscription successfully created
failed	Payment or setup failed