Change subscription plan | Afternoon

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

{
  "success": true,
  "status": "completed",
  "old_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"
  },
  "new_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"
}

Changes a subscription to a new plan immediately or schedules the change for end of period.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Path parameters

idstringRequiredformat: "cuid"

Request

This endpoint expects an object.

target_plan_codestringRequiredformat: "^[a-z0-9]+(?:_[a-z0-9]+)*$">=1 character

Target plan code to transition this subscription to

change_modeenumRequired

When to change plan: “now” transitions immediately, “end_of_period” transitions at the end of the current billing cycle

Allowed values:

cancel_now_prepaid_refund_policyenumOptional

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

Allowed values:

Response

Plan change completed or scheduled

successboolean

statusenum

Whether plan transition is complete now or scheduled

Allowed values:

old_subscriptionobject

new_subscriptionobject

request_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error