nodes/generated

Interface ChargebeeNodeParameters

Source
interface ChargebeeNodeParameters {
    endOfTerm?: boolean;
    filters?: {
        date: {
            operation?: "is" | "is_not" | "after" | "before";
            value?: string;
        }[];
        total: {
            operation?: | "is"
            | "is_not"
            | "gte"
            | "gt"
            | "lte"
            | "lt";
            value?: number;
        }[];
    };
    invoiceId?: string;
    maxResults?: number;
    operation?: | "create"
    | "list"
    | "delete"
    | "pdfUrl"
    | "cancel";
    properties?: {
        company?: string;
        customProperties?: {
            property: { name?: string; value?: string }[];
        };
        email?: string;
        first_name?: string;
        id?: string;
        last_name?: string;
        phone?: string;
    };
    resource?: "customer"
    | "invoice"
    | "subscription";
    subscriptionId?: string;
}

Properties§

Source§

readonly endOfTerm?: boolean

Whether it will not cancel it directly in will instead schedule the cancelation for the end of the term

Source§

readonly filters?: {
    date: {
        operation?: "is" | "is_not" | "after" | "before";
        value?: string;
    }[];
    total: {
        operation?: | "is"
        | "is_not"
        | "gte"
        | "gt"
        | "lte"
        | "lt";
        value?: number;
    }[];
}

Filter for invoices Default: {} Type options: {"multipleValues":true}

Source§

readonly invoiceId?: string

The ID of the invoice to get

Source§

readonly maxResults?: number

Max. amount of results to return(< 100). Default: 10 Type options: {"minValue":1,"maxValue":100}

Source§

readonly operation?: "create" | "list" | "delete" | "pdfUrl" | "cancel"

Default: "create"

Source§

readonly properties?: {
    company?: string;
    customProperties?: {
        property: { name?: string; value?: string }[];
    };
    email?: string;
    first_name?: string;
    id?: string;
    last_name?: string;
    phone?: string;
}

Properties to set on the new user Default: {}

Source§

readonly resource?: "customer" | "invoice" | "subscription"

Default: "invoice"

Source§

readonly subscriptionId?: string

The ID of the subscription to cancel