nodes/generated

Interface PaddleNodeParameters

Source
interface PaddleNodeParameters {
    additionalFields?:
        | {
            allowedUses?: number;
            couponCode?: string;
            couponPrefix?: string;
            description?: string;
            expires?: string;
            group?: string;
            numberOfCoupons?: number;
            recurring?: boolean;
        }
        | {
            allowedUses?: number;
            discount?: {
                discountProperties: {
                    currency?: | "ARS"
                    | "AUD"
                    | "BRL"
                    | "CAD"
                    | "CHF"
                    | "CNY"
                    | "CZK"
                    | "DKK"
                    | "EUR"
                    | "GBP"
                    | "HKD"
                    | "HUF"
                    | "INR"
                    | "JPY"
                    | "KRW"
                    | "MXN"
                    | "NOK"
                    | "NZD"
                    | "PLN"
                    | "RUB"
                    | "SEK"
                    | "SGD"
                    | "THB"
                    | "TWD"
                    | "USD"
                    | "ZAR";
                    discountAmount?: number;
                    discountType?: "percentage"
                    | "flat";
                };
            };
            expires?: string;
            newCouponCode?: string;
            newGroup?: string;
            productIds?: string;
            recurring?: boolean;
        }
        | {
            from?: string;
            isOneOffCharge?: boolean;
            isPaid?: boolean;
            plan?: string;
            state?: "active"
            | "paused"
            | "past_due"
            | "trialing";
            subscriptionId?: number;
            to?: string;
        }
        | {
            planId?: string;
            state?: "active"
            | "paused"
            | "past_due"
            | "trialing";
            subscriptionId?: string;
        };
    additionalFieldsJson?: string;
    couponCode?: string;
    couponType?: "product"
    | "checkout";
    currency?:
        | "ARS"
        | "AUD"
        | "BRL"
        | "CAD"
        | "CHF"
        | "CNY"
        | "CZK"
        | "DKK"
        | "EUR"
        | "GBP"
        | "HKD"
        | "HUF"
        | "INR"
        | "JPY"
        | "KRW"
        | "MXN"
        | "NOK"
        | "NZD"
        | "PLN"
        | "RUB"
        | "SEK"
        | "SGD"
        | "THB"
        | "TWD"
        | "USD"
        | "ZAR";
    date?: string;
    discountAmount?: number;
    discountType?: "percentage"
    | "flat";
    group?: string;
    jsonParameters?: boolean;
    limit?: number;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "reschedule";
    paymentId?: string;
    planId?: string;
    productId?: string;
    productIds?: unknown[];
    resource?: | "user"
    | "product"
    | "payment"
    | "plan"
    | "coupon";
    returnAll?: boolean;
    updateBy?: "group"
    | "couponCode";
}

Properties§

§readonly additionalFields?:
    | {
        allowedUses?: number;
        couponCode?: string;
        couponPrefix?: string;
        description?: string;
        expires?: string;
        group?: string;
        numberOfCoupons?: number;
        recurring?: boolean;
    }
    | {
        allowedUses?: number;
        discount?: {
            discountProperties: {
                currency?: | "ARS"
                | "AUD"
                | "BRL"
                | "CAD"
                | "CHF"
                | "CNY"
                | "CZK"
                | "DKK"
                | "EUR"
                | "GBP"
                | "HKD"
                | "HUF"
                | "INR"
                | "JPY"
                | "KRW"
                | "MXN"
                | "NOK"
                | "NZD"
                | "PLN"
                | "RUB"
                | "SEK"
                | "SGD"
                | "THB"
                | "TWD"
                | "USD"
                | "ZAR";
                discountAmount?: number;
                discountType?: "percentage"
                | "flat";
            };
        };
        expires?: string;
        newCouponCode?: string;
        newGroup?: string;
        productIds?: string;
        recurring?: boolean;
    }
    | {
        from?: string;
        isOneOffCharge?: boolean;
        isPaid?: boolean;
        plan?: string;
        state?: "active"
        | "paused"
        | "past_due"
        | "trialing";
        subscriptionId?: number;
        to?: string;
    }
    | {
        planId?: string;
        state?: "active"
        | "paused"
        | "past_due"
        | "trialing";
        subscriptionId?: string;
    }

Default: {}

§readonly additionalFieldsJson?: string

Attributes in JSON form Type options: {"alwaysOpenEditWindow":true}

§readonly couponCode?: string

Identify the coupon to update

§readonly couponType?: "product" | "checkout"

Either product (valid for specified products or subscription plans) or checkout (valid for any checkout) Default: "checkout"

§readonly currency?:
    | "ARS"
    | "AUD"
    | "BRL"
    | "CAD"
    | "CHF"
    | "CNY"
    | "CZK"
    | "DKK"
    | "EUR"
    | "GBP"
    | "HKD"
    | "HUF"
    | "INR"
    | "JPY"
    | "KRW"
    | "MXN"
    | "NOK"
    | "NZD"
    | "PLN"
    | "RUB"
    | "SEK"
    | "SGD"
    | "THB"
    | "TWD"
    | "USD"
    | "ZAR"

The currency must match the balance currency specified in your account Default: "EUR"

§readonly date?: string

Date you want to move the payment to

§readonly discountAmount?: number

Discount amount in currency Default: 1 Type options: {"minValue":1}

§readonly discountType?: "percentage" | "flat"

Either flat or percentage Default: "flat"

§readonly group?: string

The name of the group of coupons you want to update

§readonly jsonParameters?: boolean
§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

§readonly operation?: "create" | "get" | "getAll" | "update" | "reschedule"

Default: "create"

§readonly paymentId?: string

The upcoming subscription payment ID. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getPayments"}

§readonly planId?: string

Filter: The subscription plan ID

§readonly productId?: string

The specific product/subscription ID

§readonly productIds?: unknown[]

Comma-separated list of product IDs. Required if coupon_type is product. Choose from the list, or specify IDs using an expression. Default: [] Type options: {"loadOptionsMethod":"getProducts"}

§readonly resource?: "user" | "product" | "payment" | "plan" | "coupon"

Default: "coupon"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly updateBy?: "group" | "couponCode"

Either flat or percentage Default: "couponCode"