Cancel a Subscription Schedule

​

Cancels the schedule. Sets status to CANCELED and stops further phase transitions. The underlying subscription is not automatically canceled — cancel it separately if needed.

Path Parameters
  • id
    Type: string
    required

    Subscription schedule ID (ULID).

Body
application/json

All fields are optional. Omit the body or send {} to cancel immediately.

  • cancel_subscription
    Type: boolean

    If true, the underlying subscription is also canceled immediately. Defaults to false (the subscription continues billing independently).

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v1/subscription-schedules/{id}/cancel
curl https://api.paypercut.io/v1/subscription-schedules/01HD7M6DRKZ4Q4QEVWJB0RC1S6/cancel \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{}'

{
  "id": "01HD7M6DRKZ4Q4QEVWJB0RC1S6",
  "customer": "01KJQ34MWYH0TES77RDXA8T8TT",
  "status": "CANCELED",
  "end_behavior": "RELEASE",
  "subscription": "01XXXXXXXXXXXXXXXXXXXXXXX",
  "released_subscription": null,
  "livemode": false,
  "start_date": "2026-03-01T00:00:00Z",
  "current_phase_index": 1,
  "current_phase": null,
  "next_action_at": null,
  "canceled_at": "2026-03-15T09:00:00Z",
  "completed_at": null,
  "released_at": null,
  "phases": [
    {
      "start_date": "2026-03-01T00:00:00Z",
      "end_date": "2026-04-01T00:00:00Z",
      "phase_index": 0,
      "items": [
        {
          "price": "price_monthly",
          "unit_amount": 1000,
          "currency": "usd",
          "recurring": {
            "interval": "monthly",
            "interval_count": 1,
            "usage_type": "licensed"
          }
        }
      ]
    }
  ],
  "created": "2026-02-28T12:00:00Z",
  "updated_at": "2026-03-15T09:00:00Z"
}

Schedule canceled successfully.