Create a subscription | Afternoon

import { AfternoonClient } from "afternoon-sdk";
async function main() {
    const client = new AfternoonClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.subscriptions.create({
        customerId: "cm5x9z8nv0001h85r7l9p2k2m",
        planCode: "starter_plan",
    });
}
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"
}

Creates a new subscription linking a customer to a plan. Both must belong to the authenticated company.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Request

This endpoint expects an object.

customer_idstringRequiredformat: "cuid"

Customer ID

plan_codestringRequiredformat: "^[a-z0-9]+(?:_[a-z0-9]+)*$"

Plan code

start_datedatetimeOptional

ISO 8601 subscription start date (defaults to now)

billing_anchor_dayintegerOptional1-31

Day of month for billing anchor (1-31, defaults to 1)

initial_statusenumOptional

Initial status of the subscription. Defaults to pending.

Allowed values:

Response

Subscription created

successboolean

subscriptionobject

request_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error