list-customer-mandate-debit-schedules

Method: GET
Path: /customers/{customer_id}/mandate-debit-schedules

Tags: Customers

Summary

List mandate debit schedules

Description

Retrieves the paginated list of MandateDebitSchedule entries for a customer across all mandates. Each entry represents a queued, executed, retried, or cancelled mandate-based debit attempt.

Storefront SDK Usage

SDK Method: sdk.customer.listMandateDebitSchedules()

Example:

const { data, error } = await sdk.customer.listMandateDebitSchedules();

if (error) {
  console.error("Failed to list mandate debit schedules:", error);
  return;
}

console.log("Debit schedules:", data.mandate_debit_schedules);
console.log("Pagination:", data.pagination);

// With pagination
const { data: page2 } = await sdk.customer.listMandateDebitSchedules({
  page: 2,
  limit: 20
});

TypeScript Definition

"list-customer-mandate-debit-schedules": {
        parameters: {
            query?: {
                /** @description page number of pagination list */
                page?: components["parameters"]["pageParam"];
                /** @description Number of results per page. */
                limit?: components["parameters"]["pageLimitParam"];
            };
            header?: never;
            path: {
                /** @description Customer Id */
                customer_id: string;
            };
            cookie?: never;
        };
        requestBody?: never;
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            mandate_debit_schedules: components["schemas"]["MandateDebitSchedule"][];
                            pagination: components["schemas"]["Pagination"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
            404: components["responses"]["NotFound"];
        };
    };

Component References

Reference	Resolves To
components["parameters"]["pageParam"]	pageParam
components["parameters"]["pageLimitParam"]	pageLimitParam
components["schemas"]["MandateDebitSchedule"]	MandateDebitSchedule
components["schemas"]["Pagination"]	Pagination
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized
components["responses"]["NotFound"]	NotFound

Parameters

• page (query): page number of pagination list
• limit (query): Number of results per page.

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

404

Requested resource not found

OpenAPI Definition

{
  "tags": [
    "Customers"
  ],
  "operationId": "list-customer-mandate-debit-schedules",
  "summary": "List mandate debit schedules",
  "description": "Retrieves the paginated list of `MandateDebitSchedule` entries for a customer across all mandates. Each entry represents a queued, executed, retried, or cancelled mandate-based debit attempt.",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/list-customer-mandate-debit-schedules",
    "description": "API reference for the list-customer-mandate-debit-schedules operation"
  },
  "parameters": [
    {
      "$ref": "#/components/parameters/pageParam"
    },
    {
      "$ref": "#/components/parameters/pageLimitParam"
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "mandate_debit_schedules": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/MandateDebitSchedule"
                    }
                  },
                  "pagination": {
                    "$ref": "#/components/schemas/Pagination"
                  }
                },
                "required": [
                  "mandate_debit_schedules",
                  "pagination"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "customers",
  "x-speakeasy-ignore": false,
  "x-speakeasy-name-override": "listCustomerMandateDebitSchedules"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions