Retrieve a subscription

GET

/v1/subscriptions/:id

GET

/v1/subscriptions/:id

1 import { AfternoonClient } from "afternoon-sdk";
2 
3 async function main() {
4     const client = new AfternoonClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.subscriptions.get("cm5x9z8nv0000h85r7l9p2k1m");
8 }
9 main();

1 {
2   "success": true,
3   "subscription": {
4     "id": "cm5x9z8nv0000h85r7l9p2k1m",
5     "customer_id": "cm5x9z8nv0001h85r7l9p2k2m",
6     "plan_id": "cm5x9z8nv0002h85r7l9p2k3m",
7     "plan_code": "starter_plan",
8     "status": "active",
9     "start_date": "2024-01-15T00:00:00.000Z",
10     "billing_anchor_day": 1,
11     "next_renewal_date": "2024-02-15T00:00:00.000Z",
12     "cancel_at_period_end": false,
13     "plan_transition_at_period_end": false,
14     "created_at": "2024-01-15T10:30:00.000Z",
15     "updated_at": "2024-01-15T10:30:00.000Z"
16   },
17   "request_id": "req_abc123"
18 }

Fetches a subscription by its ID.

Authentication

AuthorizationBearer

API key obtained from the Afternoon dashboard

Path parameters

idstringRequiredformat: "cuid"

Response

Subscription found

successboolean

subscriptionobject

request_idstring

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error