List subscriptions | Afternoon

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

{
  "success": true,
  "subscriptions": [
    {
      "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"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "cm5x9z8nv0000h85r7l9p2k1m"
  },
  "request_id": "req_abc123"
}

Returns a paginated list of subscriptions. Supports optional customer_id and status filters.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Query parameters

limitstringOptionalDefaults to 50

cursorstringOptional

customer_idstringOptional

statusenumOptional

Filter by subscription status

Allowed values:

Response

Subscriptions list

successboolean

subscriptionslist of objects

paginationobject

request_idstring

Errors

401

Unauthorized Error

500

Internal Server Error