Cancel Series

Cancel the whole series. Every upcoming session booking is cancelled; sessions whose date has already passed are left untouched. To cancel a single session instead, use Cancel Session.

Endpoint

POST /v1/series/{id}/cancel

Authentication

Requires a live or test API key with series:write scope.

Path Parameters

Parameter	Type	Description
id	integer	Series ID

Request Body

No request body.

Example Request

curl -X POST "https://app.equipdash.com/api/v1/series/1/cancel" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Success (200 OK)

Returns the series in the same shape as Get Series, including totals, with status: "cancelled" and each upcoming session's booking showing a cancelled status.

{
  "data": {
    "id": 1,
    "name": "Intro Course — Tuesday Group",
    "experience": {
      "id": 12,
      "name": "Intro Course"
    },
    "group": {
      "id": 7,
      "name": "Tuesday Group"
    },
    "billing_mode": "consolidated",
    "status": "cancelled",
    "totals": {
      "total": 450.00,
      "paid": 150.00,
      "balance": 300.00
    },
    "sessions": [
      {
        "id": 101,
        "session_index": 1,
        "schedule": {
          "id": 501,
          "start_datetime_utc": "2026-09-01T17:00:00Z",
          "end_datetime_utc": "2026-09-01T18:30:00Z"
        },
        "booking": {
          "id": 9001,
          "status": "cancelled",
          "payment_status": "paid"
        },
        "created_at": "2026-07-20T10:00:00Z",
        "updated_at": "2026-07-21T11:00:00Z"
      },
      {
        "id": 102,
        "session_index": 2,
        "schedule": {
          "id": 502,
          "start_datetime_utc": "2026-09-08T17:00:00Z",
          "end_datetime_utc": "2026-09-08T18:30:00Z"
        },
        "booking": {
          "id": 9002,
          "status": "cancelled",
          "payment_status": "pending"
        },
        "created_at": "2026-07-20T10:00:00Z",
        "updated_at": "2026-07-21T11:00:00Z"
      }
    ],
    "created_at": "2026-07-20T10:00:00Z",
    "updated_at": "2026-07-21T11:00:00Z"
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

Errors

Status	Code	Description
401	authentication_required	No API key provided
403	insufficient_scope	API key lacks series:write scope
403	forbidden	Series belongs to a different supplier
404	resource_not_found	Series does not exist

Notes

• The supplier's cancellation policy applies to each upcoming session booking individually, exactly as if it were cancelled on its own
• Past sessions keep their bookings and payment records as they stand
• Cancelling a series does not issue refunds automatically — refund any paid session bookings through the Bookings API as needed