Get a subscription

GET

/subscriptions/:id

GET

/api/v1/public/subscriptions/:id

1 curl https://api.prolifi.co/api/v1/public/subscriptions/id \
2      -H "Authorization: Bearer <token>"

1 {
2   "data": {
3     "id": "string",
4     "customer_id": "string",
5     "plan_id": "string",
6     "plan_name": "string",
7     "status": "active",
8     "billing_cycle": "string",
9     "current_period_start": "2023-01-15",
10     "current_period_end": "2023-01-15",
11     "start_date": "2023-01-15",
12     "billing_date": "2023-01-15",
13     "cancel_at": "2024-01-15T09:30:00Z",
14     "canceled_at": "2024-01-15T09:30:00Z",
15     "pause_start": "2024-01-15T09:30:00Z",
16     "pause_end": "2024-01-15T09:30:00Z",
17     "pricing": {
18       "amount": 1.1,
19       "currency": "string",
20       "pricing_scheme_id": "string"
21     },
22     "metadata": {},
23     "created_at": "2024-01-15T09:30:00Z",
24     "updated_at": "2024-01-15T09:30:00Z"
25   }
26 }

Retrieves a single subscription by its unique identifier.

Authentication

AuthorizationBearer

Use a secret key (sk_test_* or sk_live_*) for full read/write access, or a public key (pk_test_* or pk_live_*) for read-only access.

Path parameters

idstringRequiredformat: "uuid"

The unique identifier of the subscription.

Response

The subscription object

dataobject

Errors

401

Unauthorized Error

404

Not Found Error