PayFanout API reference
    Preparing search index...

    Interface GoCardlessSubscriptionLike

    Wire shape of a GoCardless subscription (snake_case). interval is the NUMBER of interval_units between charges (unified intervalCount); upcoming_payments carries up to 10 scheduled charges with their dates.

    interface GoCardlessSubscriptionLike {
        amount?: number;
        count?: number;
        created_at?: string;
        currency?: string;
        day_of_month?: number;
        earliest_charge_date_after_resume?: string;
        end_date?: string;
        id: string;
        interval?: number;
        interval_unit?: string;
        links?: { mandate?: string };
        metadata?: Record<string, string>;
        month?: string;
        name?: string;
        parent_plan_paused?: boolean;
        payment_reference?: string;
        retry_if_possible?: boolean;
        start_date?: string;
        status?: string;
        upcoming_payments?: { amount?: number; charge_date?: string }[];
    }
    Index
    amount? count? created_at? currency? day_of_month? earliest_charge_date_after_resume? end_date? id interval? interval_unit? links? metadata? month? name? parent_plan_paused? payment_reference? retry_if_possible? start_date? status? upcoming_payments?
    amount?: number
    count?: number
    created_at?: string
    currency?: string
    day_of_month?: number
    earliest_charge_date_after_resume?: string
    end_date?: string
    id: string
    interval?: number

    Number of interval_units between charge dates (defaults to 1).

    interval_unit?: string

    weekly | monthly | yearly.

    links?: { mandate?: string }
    metadata?: Record<string, string>
    month?: string
    name?: string

    Merchant-facing name; also set as the description on each payment created.

    parent_plan_paused?: boolean
    payment_reference?: string
    retry_if_possible?: boolean
    start_date?: string
    status?: string
    upcoming_payments?: { amount?: number; charge_date?: string }[]

    Settings
    Member Visibility

    On This Page
    Properties