Typescript SDK Type Docs
    Preparing search index...

    Interface RecurringOrderSetExpiresAtAction

    Setting the expiration date and time generates the RecurringOrderExpiresAtSet Message.

    interface RecurringOrderSetExpiresAtAction {
        action: "setExpiresAt";
        expiresAt?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    action expiresAt?

    Properties

    action: "setExpiresAt"
    expiresAt?: string

    Date and time (UTC) the Recurring Order should expire. If empty, any existing value will be removed.

    If the date or time is extended or removed when the [RecurringOrderState](ctp:api:type:RecurringOrderState) is `Expired`, the state will be updated to `Active`.

    Settings

    Member Visibility

    On This Page

    Properties