nodes/generated

Interface StripeNodeParameters

Source


interface StripeNodeParameters {
    additionalFields?:
        | {
            description?: string;
            metadata?: {
                metadataProperties: {
                    key?: string;
                    value?: string;
                }[];
            };
            receipt_email?: string;
            shipping?: {
                shippingProperties: {
                    address?: {
                        details: {
                            city?: string;
                            country?: string;
                            line1?: string;
                            line2?: string;
                            postal_code?: string;
                            state?: string;
                        };
                    };
                    name?: string;
                }[];
            };
        }
        | {
            address?: {
                details: {
                    city?: string;
                    country?: string;
                    line1?: string;
                    line2?: string;
                    postal_code?: string;
                    state?: string;
                };
            };
            description?: string;
            email?: string;
            metadata?: {
                metadataProperties: {
                    key?: string;
                    value?: string;
                }[];
            };
            phone?: string;
            shipping?: {
                shippingProperties: {
                    address?: {
                        details: {
                            city?: string;
                            country?: string;
                            line1?: string;
                            line2?: string;
                            postal_code?: string;
                            state?: string;
                        };
                    };
                    name?: string;
                    phone?: string;
                }[];
            };
        }
        | {
            customPayload?: {
                properties: { key?: string; value?: string }[];
            };
            identifier?: string;
            timestamp?: string;
        }
        | {
            metadata?: {
                metadataProperties: {
                    key?: string;
                    value?: string;
                }[];
            };
            statement_descriptor?: string;
        };
    amount?: number;
    amountOff?: number;
    cardId?: string;
    chargeId?: string;
    currency?: string;
    customerId?: string;
    cvc?: string;
    duration?: "once"
    | "forever";
    eventName?: string;
    expirationMonth?: string;
    expirationYear?: string;
    filters?: { email?: string };
    limit?: number;
    name?: string;
    number?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "add"
        | "remove"
        | "delete";
    percentOff?: number;
    resource?: | "charge"
    | "customer"
    | "token"
    | "source"
    | "balance"
    | "coupon"
    | "customerCard"
    | "meterEvent";
    returnAll?: boolean;
    source?: string;
    sourceId?: string;
    token?: string;
    type?: | "percent"
    | "fixedAmount"
    | "wechat"
    | "cardToken";
    updateFields?: | {
        description?: string;
        metadata?: {
            metadataProperties: {
                key?: string;
                value?: string;
            }[];
        };
        receipt_email?: string;
        shipping?: {
            shippingProperties: {
                address?: {
                    details: {
                        city?: string;
                        country?: string;
                        line1?: string;
                        line2?: string;
                        postal_code?: string;
                        state?: string;
                    };
                };
                name?: string;
            }[];
        };
    }
    | {
        address?: {
            details: {
                city?: string;
                country?: string;
                line1?: string;
                line2?: string;
                postal_code?: string;
                state?: string;
            };
        };
        description?: string;
        email?: string;
        metadata?: {
            metadataProperties: {
                key?: string;
                value?: string;
            }[];
        };
        name?: string;
        phone?: string;
        shipping?: {
            shippingProperties: {
                address?: {
                    details: {
                        city?: string;
                        country?: string;
                        line1?: string;
                        line2?: string;
                        postal_code?: string;
                        state?: string;
                    };
                };
                name?: string;
                phone?: string;
            }[];
        };
    };
    value?: number;
}

Properties§

§readonly additionalFields?:
    | {
        description?: string;
        metadata?: {
            metadataProperties: {
                key?: string;
                value?: string;
            }[];
        };
        receipt_email?: string;
        shipping?: {
            shippingProperties: {
                address?: {
                    details: {
                        city?: string;
                        country?: string;
                        line1?: string;
                        line2?: string;
                        postal_code?: string;
                        state?: string;
                    };
                };
                name?: string;
            }[];
        };
    }
    | {
        address?: {
            details: {
                city?: string;
                country?: string;
                line1?: string;
                line2?: string;
                postal_code?: string;
                state?: string;
            };
        };
        description?: string;
        email?: string;
        metadata?: {
            metadataProperties: {
                key?: string;
                value?: string;
            }[];
        };
        phone?: string;
        shipping?: {
            shippingProperties: {
                address?: {
                    details: {
                        city?: string;
                        country?: string;
                        line1?: string;
                        line2?: string;
                        postal_code?: string;
                        state?: string;
                    };
                };
                name?: string;
                phone?: string;
            }[];
        };
    }
    | {
        customPayload?: {
            properties: { key?: string; value?: string }[];
        };
        identifier?: string;
        timestamp?: string;
    }
    | {
        metadata?: {
            metadataProperties: {
                key?: string;
                value?: string;
            }[];
        };
        statement_descriptor?: string;
    }

Default: {}

§readonly amount?: number

Amount in cents to be collected for this charge, e.g. enter 100 for $1.00 Type options: {"minValue":0,"maxValue":99999999}

§readonly amountOff?: number

Amount in cents to subtract from an invoice total, e.g. enter 100 for $1.00 Type options: {"minValue":0,"maxValue":99999999}

§readonly cardId?: string

ID of the card to remove

§readonly chargeId?: string

ID of the charge to retrieve

§readonly currency?: string

Three-letter ISO currency code, e.g. USD or EUR. It must be a Stripe-supported currency. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getCurrencies"}

§readonly customerId?: string

ID of the customer to be associated with this card

§readonly cvc?: string

Security code printed on the back of the card

§readonly duration?: "once" | "forever"

How long the discount will be in effect Default: "once"

§readonly eventName?: string

The name of the meter event. Corresponds with the event_name field on a meter.

§readonly expirationMonth?: string

Number of the month when the card will expire

§readonly expirationYear?: string

Year when the card will expire

§readonly filters?: { ... }

Default: {}

§readonly limit?: number

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

§readonly name?: string

Full name or business name of the customer to create

§readonly number?: string
§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"

Default: "get"

§readonly percentOff?: number

Percentage to apply with the coupon Default: 1 Type options: {"minValue":1,"maxValue":100}

§readonly resource?:
    | "charge"
    | "customer"
    | "token"
    | "source"
    | "balance"
    | "coupon"
    | "customerCard"
    | "meterEvent"

Default: "balance"

§readonly returnAll?: boolean

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

§readonly source?: string

ID of the customer's payment source to be charged

§readonly sourceId?: string

ID of the source to retrieve

§readonly token?: string

Token representing sensitive card information Type options: {"password":true}

§readonly type?: "percent" | "fixedAmount" | "wechat" | "cardToken"

Whether the coupon discount is a percentage or a fixed amount Default: "percent"

§readonly updateFields?:
    | {
        description?: string;
        metadata?: {
            metadataProperties: {
                key?: string;
                value?: string;
            }[];
        };
        receipt_email?: string;
        shipping?: {
            shippingProperties: {
                address?: {
                    details: {
                        city?: string;
                        country?: string;
                        line1?: string;
                        line2?: string;
                        postal_code?: string;
                        state?: string;
                    };
                };
                name?: string;
            }[];
        };
    }
    | {
        address?: {
            details: {
                city?: string;
                country?: string;
                line1?: string;
                line2?: string;
                postal_code?: string;
                state?: string;
            };
        };
        description?: string;
        email?: string;
        metadata?: {
            metadataProperties: {
                key?: string;
                value?: string;
            }[];
        };
        name?: string;
        phone?: string;
        shipping?: {
            shippingProperties: {
                address?: {
                    details: {
                        city?: string;
                        country?: string;
                        line1?: string;
                        line2?: string;
                        postal_code?: string;
                        state?: string;
                    };
                };
                name?: string;
                phone?: string;
            }[];
        };
    }

Default: {}

§readonly value?: number

The value of the meter event. Must be an integer. Can be positive or negative. Default: 1