> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wepayout.co/llms.txt
> Use this file to discover all available pages before exploring further.

# List Schedules

> List all schedules

<Note>
  Schedules are created **one at a time**. When an authorization is confirmed, only the first upcoming schedule is generated. The next one is created automatically once the current schedule is paid or processed — not all future installments are pre-created upfront.

  This means that at any given time, you will typically see **one active schedule per authorization**. Additional schedules will appear in this list as their payment dates approach.
</Note>

## Response

<ResponseField name="Response" type="array">
  List of schedules

  <Expandable title="schedule object">
    <ResponseField name="id" type="integer">
      Unique identifier for this specific schedule. Each billing cycle generates a new schedule with its own ID — do not assume this ID is stable across cycles.
    </ResponseField>

    <ResponseField name="merchant_id" type="integer">
      Merchant ID
    </ResponseField>

    <ResponseField name="authorization" type="object">
      Authorization

      <Expandable title="authorization properties">
        <ResponseField name="id" type="integer">Authorization ID</ResponseField>
        <ResponseField name="name" type="string">Authorization Name</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="amount" type="number">
      Amount
    </ResponseField>

    <ResponseField name="due_date" type="string">
      Due Date
    </ResponseField>

    <ResponseField name="settlement_date" type="string or null">
      Settlement Date
    </ResponseField>

    <ResponseField name="status" type="object">
      Status

      <Expandable title="status properties">
        <ResponseField name="id" type="integer">
          Status ID
        </ResponseField>

        <ResponseField name="name" type="string">
          Status Name
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="history" type="array or null">
      History

      <Expandable title="history items">
        <ResponseField name="id" type="integer">History ID</ResponseField>
        <ResponseField name="schedule_id" type="integer">ID of the schedule this history entry belongs to. Matches the parent schedule `id` — each billing cycle has its own unique schedule ID.</ResponseField>
        <ResponseField name="status_id" type="integer">Status ID</ResponseField>
        <ResponseField name="status_name" type="string">Status Name</ResponseField>
        <ResponseField name="created_at" type="string">Date</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="tx_id" type="string or null">
      Transaction ID
    </ResponseField>

    <ResponseField name="attempts" type="array">
      Attempts

      <Expandable title="attempt items">
        <ResponseField name="id" type="integer">Attempt ID</ResponseField>
        <ResponseField name="status" type="string">Status</ResponseField>
        <ResponseField name="end_to_end_id" type="string">End To End ID</ResponseField>
        <ResponseField name="attempt_date" type="string">Date</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="created_at" type="string">
      Creation Date
    </ResponseField>

    <ResponseField name="buyer" type="object">
      Buyer

      <Expandable title="buyer properties">
        <ResponseField name="id" type="integer">
          Buyer ID
        </ResponseField>

        <ResponseField name="name" type="string">
          Buyer Name
        </ResponseField>

        <ResponseField name="document" type="string">
          Buyer Document
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "id": 1,
      "merchant_id": 1,
      "authorization": {
        "id": 1,
        "name": "Authorization Name"
      },
      "amount": 100.00,
      "due_date": "2023-01-01",
      "settlement_date": null,
      "status": {
        "id": 1,
        "name": "PENDING"
      },
      "history": [
        {
          "id": 1,
          "schedule_id": 1,
          "status_id": 1,
          "status_name": "PENDING",
          "created_at": "2023-01-01T00:00:00Z"
        }
      ],
      "tx_id": null,
      "attempts": [],
      "created_at": "2023-01-01T00:00:00Z",
      "buyer": {
        "id": 1,
        "name": "Buyer Name",
        "document": "12345678900"
      }
    }
  ]
  ```
</ResponseExample>
