PayFanout API reference
    Preparing search index...

    Interface PayPalSubscriptionLike

    interface PayPalSubscriptionLike {
        billing_info?: {
            failed_payments_count?: number;
            final_payment_time?: string;
            last_payment?: { amount?: PayPalSubscriptionMoney; time?: string };
            next_billing_time?: string;
            outstanding_balance?: PayPalSubscriptionMoney;
        };
        create_time?: string;
        custom_id?: string;
        id?: string;
        links?: { href?: string; method?: string; rel?: string }[];
        plan?: { billing_cycles?: PayPalBillingCycleLike[] };
        plan_id?: string;
        plan_overridden?: boolean;
        quantity?: string;
        start_time?: string;
        status?: string;
        subscriber?: {
            email_address?: string;
            name?: { given_name?: string; surname?: string };
            payer_id?: string;
            payment_source?: {
                card?: { attributes?: { vault?: { id?: (...) | (...) } } };
            };
            phone?: { phone_number?: { national_number?: string } };
        };
        update_time?: string;
    }
    Index
    billing_info?: {
        failed_payments_count?: number;
        final_payment_time?: string;
        last_payment?: { amount?: PayPalSubscriptionMoney; time?: string };
        next_billing_time?: string;
        outstanding_balance?: PayPalSubscriptionMoney;
    }
    create_time?: string
    custom_id?: string

    "The custom id for the subscription. Can be invoice id."

    id?: string
    links?: { href?: string; method?: string; rel?: string }[]
    plan?: { billing_cycles?: PayPalBillingCycleLike[] }

    The effective plan — only present when the GET carried fields=plan.

    plan_id?: string
    plan_overridden?: boolean
    quantity?: string
    start_time?: string
    status?: string
    subscriber?: {
        email_address?: string;
        name?: { given_name?: string; surname?: string };
        payer_id?: string;
        payment_source?: {
            card?: { attributes?: { vault?: { id?: (...) | (...) } } };
        };
        phone?: { phone_number?: { national_number?: string } };
    }
    update_time?: string