Typescript SDK Type Docs
    Preparing search index...

    Interface RecurringOrderFailedMessagePayload

    Generated after a RecurringOrder failed to process an Order.

    interface RecurringOrderFailedMessagePayload {
        cartId: string;
        errors?: RecurringOrderFailureError[];
        failedAt: string;
        failureReason: string;
        orderScheduledAt: string;
        type: "RecurringOrderFailed";
    }

    Hierarchy (View Summary)

    Index

    Properties

    cartId errors? failedAt failureReason orderScheduledAt type

    Properties

    cartId: string

    ID of the Cart used in the failed Order creation attempt.

    errors?: RecurringOrderFailureError[]

    Errors due to which the Order creation failed.

    failedAt: string

    Date and time (UTC) when the Order creation attempt failed.

    failureReason: string

    Description of why the Order creation failed, such as insufficient stock.

    orderScheduledAt: string

    Date and time (UTC) the Order was scheduled to be created.

    type: "RecurringOrderFailed"

    Settings

    Member Visibility

    On This Page

    Properties