Cancel immediately

Immediate cancellation terminates the subscription right away. No further invoices are generated.

The subscription transitions to Cancelled state. This is a terminal state and cannot be reversed.

Cancel at period end

Schedule the subscription to cancel at the end of the current billing period. The customer continues to have access until the period expires.

$
curl -X PATCH https://app.paymentkit.com/api/{account_id}/subscriptions/{subscription_id} \
>
-H "Authorization: Bearer sk_live_..." \
>
-H "Content-Type: application/json" \
>
-d '{
>
  "cancel_at_period_end": true
>
}'

The subscription remains Active until the current period ends, then automatically transitions to Cancelled.

Cancel on a specific date

Schedule the subscription to cancel on a custom date. Use this for contract end dates or customer-requested future cancellations.

$
curl -X POST https://app.paymentkit.com/api/{account_id}/subscriptions/{subscription_id}/schedule-cancellation \
>
-H "Authorization: Bearer sk_live_..." \
>
-H "Content-Type: application/json" \
>
-d '{
>
  "cancel_at": "2026-06-01T00:00:00Z",
>
  "refund_option": "none"
>
}'

The subscription continues billing normally until the scheduled date, then cancels automatically.

Refund options

When cancelling, choose how to handle the customer’s payments:

Preview a cancellation

Before confirming, preview the refund amount without applying any changes:

$
curl -X POST https://app.paymentkit.com/api/{account_id}/subscriptions/{subscription_id}/cancel \
>
-H "Authorization: Bearer sk_live_..." \
>
-H "Content-Type: application/json" \
>
-d '{
>
  "refund_option": "prorated",
>
  "is_preview": true
>
}'

The response includes the calculated refund amount. No database changes or payment operations are performed.

Undo a scheduled cancellation

Remove a scheduled cancellation before it takes effect. This clears both cancel_at_period_end and cancel_at flags.

$
curl -X DELETE https://app.paymentkit.com/api/{account_id}/subscriptions/{subscription_id}/scheduled-cancellation \
>
-H "Authorization: Bearer sk_live_..."

The subscription continues renewing as normal.

Cancel a pending plan change

If a subscription has a pending plan change scheduled for period end (via effective_at: "period_end" on the change-plan endpoint), cancel it before it applies.

$
curl -X DELETE https://app.paymentkit.com/api/{account_id}/subscriptions/{subscription_id}/pending-change \
>
-H "Authorization: Bearer sk_live_..."

Response:

1
{
2
  "status": "cancelled",
3
  "cancelled_items": [
4
    {
5
      "action": "update",
6
      "subscription_item_id": "si_abc123",
7
      "new_price_id": "prc_xyz789"
8
    }
9
  ]
10
}

If no pending change exists, the response returns status: "not_found" with an empty cancelled_items array.

When to use each approach

Webhook events