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

# Payments and refunds

> List payments and refunds for payment reports.

These commands cover payments for bookings and package purchases. You need the **View own payments** or **View all payments** permission to run them. With **View own payments**, you get payments of the bookings you host. For fields and response details, see the [API reference](https://apidocs.neetocal.com/api/payments/list.md). Sample output on this page uses `--json`.

Date flags take an ISO 8601 date such as `2026-10-01` (midnight UTC) or a date-time such as `2026-10-01T00:00:00+05:30`. `--from-time` is inclusive and `--to-time` is exclusive, so a month is `--from-time 2026-10-01 --to-time 2026-11-01`.

## List payments

This command lists payments, newest first. It returns successful payments unless you pass `--status`. Each payment includes its refunds and `refunded_amount`.

```bash theme={"system"}
neetocal payments list --from-time 2026-10-01 --to-time 2026-11-01
neetocal payments list --type package_purchase
neetocal payments list --status declined --meeting-sid abc123x
```

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--from-time` | `string` | | | Only payments made at or after this time (ISO 8601 datetime or YYYY-MM-DD) |
| `--meeting-sid` | `string` | | | Only payments for bookings of this meeting, by SID or slug |
| `--page` | `int` | | `0` | Page number |
| `--page-size` | `int` | | `0` | Items per page (max 100) |
| `--status` | `string` | | | Payment status (default: successful), e.g. declined, pending |
| `--to-time` | `string` | | | Only payments made before this time (ISO 8601 datetime or YYYY-MM-DD) |
| `--type` | `string` | | | Only payments for bookings (booking) or package purchases (package\_purchase) |

```json Sample output (--json) theme={"system"}
{
  "data": [
    {
      "id": "2f4e6a8c-1b3d-4f5a-9c7e-0d2b4a6c8e1f",
      "identifier": "pi_3Q8x2LKs9d",
      "type": "booking",
      "provider": "stripe",
      "status": "successful",
      "amount": "100.0",
      "currency": "USD",
      "payment_at": "2026-10-14T09:30:00Z",
      "refunded_amount": "40.0",
      "client": { "name": "Oliver Smith", "email": "oliver@example.com" },
      "booking": {
        "id": "8b1d6f0e-2c4a-4e6b-9f3a-1d2c3b4a5f6e",
        "sid": "x7k2m9p",
        "meeting_sid": "abc123x",
        "meeting_name": "Consultation",
        "starts_at": "2026-10-20T10:00:00Z",
        "host_email": "host@example.com"
      },
      "package_purchase": null,
      "refunds": [
        {
          "id": "7e5c3a1f-9d2b-4c6e-8a0f-1b3d5f7a9c2e",
          "identifier": "re_3Q8x2LKs9d",
          "status": "successful",
          "amount": "40.0",
          "currency": "USD",
          "reason": "Cancelled by client",
          "refunded_at": "2026-10-18T12:00:00Z"
        }
      ]
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}
```

`--meeting-sid` returns booking payments only, since package purchases are not tied to a meeting.

## List refunds

This command lists refunds, newest first. It returns successful refunds unless you pass `--status`, and each refund includes the refunded payment. Refunds that have not succeeded are filtered by when they were requested.

```bash theme={"system"}
neetocal refunds list --from-time 2026-10-01 --to-time 2026-11-01
```

| Flag | Type | Required | Default | Description |
| - | - | - | - | - |
| `--from-time` | `string` | | | Only refunds made at or after this time (ISO 8601 datetime or YYYY-MM-DD) |
| `--meeting-sid` | `string` | | | Only refunds for bookings of this meeting, by SID or slug |
| `--page` | `int` | | `0` | Page number |
| `--page-size` | `int` | | `0` | Items per page (max 100) |
| `--status` | `string` | | | Refund status (default: successful), e.g. pending, declined |
| `--to-time` | `string` | | | Only refunds made before this time (ISO 8601 datetime or YYYY-MM-DD) |
| `--type` | `string` | | | Only refunds for bookings (booking) or package purchases (package\_purchase) |

```json Sample output (--json) theme={"system"}
{
  "data": [
    {
      "id": "7e5c3a1f-9d2b-4c6e-8a0f-1b3d5f7a9c2e",
      "identifier": "re_3Q8x2LKs9d",
      "status": "successful",
      "amount": "40.0",
      "currency": "USD",
      "reason": "Cancelled by client",
      "refunded_at": "2026-10-18T12:00:00Z",
      "type": "booking",
      "client": { "name": "Oliver Smith", "email": "oliver@example.com" },
      "booking": {
        "id": "8b1d6f0e-2c4a-4e6b-9f3a-1d2c3b4a5f6e",
        "sid": "x7k2m9p",
        "meeting_sid": "abc123x",
        "meeting_name": "Consultation",
        "starts_at": "2026-10-20T10:00:00Z",
        "host_email": "host@example.com"
      },
      "package_purchase": null,
      "payment": {
        "id": "2f4e6a8c-1b3d-4f5a-9c7e-0d2b4a6c8e1f",
        "identifier": "pi_3Q8x2LKs9d",
        "type": "booking",
        "provider": "stripe",
        "status": "successful",
        "amount": "100.0",
        "currency": "USD",
        "payment_at": "2026-10-14T09:30:00Z"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.