MandateDebitSchedule

Type: schema

TypeScript Definition

MandateDebitSchedule: {{
            id: string;
            mandate_id: string;
            order_id: string;
            /** @description Order number of the order that triggered this debit. */
            order_number?: string | null;
            amount: number;
            /** @enum {string} */
            status: "scheduled" | "debit-pending" | "debit-success" | "debit-failed" | "cancelled" | "awaiting-retry";
            /** Format: date-time */
            scheduled_at: string;
            /**
             * Format: date-time
             * @description Time at which the worker picked the schedule for execution.
             */
            picked_at?: string | null;
            /**
             * Format: date-time
             * @description Time at which the debit was executed against the mandate provider.
             */
            executed_at?: string | null;
            /** @description Mandate provider reference returned for this debit. */
            external_reference_id?: string | null;
            /** @description Order ID submitted to the mandate provider for this debit. */
            gateway_order_id?: string | null;
            retry_attempt: number;
            max_retries: number;
            /**
             * Format: date-time
             * @description Time at which the next retry will be attempted.
             */
            next_retry_at?: string | null;
            store_id: string;
            /** Format: date-time */
            created_at: string;
            /** Format: date-time */
            modified_at: string;
        };
        /** @enum {string} */
}

OpenAPI Schema

{
  "title": "MandateDebitSchedule",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/MandateDebitSchedule",
    "description": "API reference for the MandateDebitSchedule schema"
  },
  "required": [
    "id",
    "mandate_id",
    "order_id",
    "amount",
    "status",
    "scheduled_at",
    "retry_attempt",
    "max_retries",
    "store_id",
    "created_at",
    "modified_at"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "mandate_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "order_number": {
      "description": "Order number of the order that triggered this debit.",
      "type": [
        "string",
        "null"
      ]
    },
    "amount": {
      "type": "number"
    },
    "status": {
      "type": "string",
      "enum": [
        "scheduled",
        "debit-pending",
        "debit-success",
        "debit-failed",
        "cancelled",
        "awaiting-retry"
      ]
    },
    "scheduled_at": {
      "type": "string",
      "format": "date-time"
    },
    "picked_at": {
      "description": "Time at which the worker picked the schedule for execution.",
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "executed_at": {
      "description": "Time at which the debit was executed against the mandate provider.",
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "external_reference_id": {
      "description": "Mandate provider reference returned for this debit.",
      "type": [
        "string",
        "null"
      ]
    },
    "gateway_order_id": {
      "description": "Order ID submitted to the mandate provider for this debit.",
      "type": [
        "string",
        "null"
      ]
    },
    "retry_attempt": {
      "type": "integer"
    },
    "max_retries": {
      "type": "integer"
    },
    "next_retry_at": {
      "description": "Time at which the next retry will be attempted.",
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "store_id": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions