Cancel a subscription | Afternoon

import { AfternoonClient } from "afternoon-sdk";
async function main() {
    const client = new AfternoonClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.subscriptions.cancel("cm5x9z8nv0000h85r7l9p2k1m", {
        cancelMode: "now",
    });
}
main();

{
  "success": true,
  "subscription": {
    "id": "cm5x9z8nv0000h85r7l9p2k1m",
    "customer_id": "cm5x9z8nv0001h85r7l9p2k2m",
    "plan_id": "cm5x9z8nv0002h85r7l9p2k3m",
    "plan_code": "starter_plan",
    "status": "active",
    "start_date": "2024-01-15T00:00:00.000Z",
    "billing_anchor_day": 1,
    "next_renewal_date": "2024-02-15T00:00:00.000Z",
    "cancel_at_period_end": false,
    "plan_transition_at_period_end": false,
    "created_at": "2024-01-15T10:30:00.000Z",
    "updated_at": "2024-01-15T10:30:00.000Z"
  },
  "request_id": "req_abc123"
}

Cancels a subscription immediately or at the end of the current billing period.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Path parameters

idstringRequiredformat: "cuid"

Request

This endpoint expects an object.

cancel_modeenumRequired

When to cancel: “now” cancels immediately, “end_of_period” cancels at the end of the current billing cycle

Allowed values:

cancel_now_prepaid_refund_policyenumOptional

Applies only when cancel_mode is “now”: refund prorated prepaid fixed fees or skip refunds.

Allowed values:

Response

Subscription canceled

successboolean

subscriptionobject

request_idstring

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error