Skip to main content
GET
Manage Subscriptions

Authentication

All subscription management endpoints require a Bearer token in the Authorization header.

List Subscriptions

GET /v1/subscriptions
Retrieve a paginated list of all subscriptions for the authenticated merchant.

Query Parameters

integer
default:"1"
The page number for pagination.
integer
default:"20"
The number of subscriptions per page. Maximum value is 100.
string
Filter by subscription status. Accepted values: active, trialing, cancelled, past_due, expired.
string
Filter by a specific subscription plan ID.

Example Request

Example Response


Get Subscription Details

GET /v1/subscriptions/{id}
Retrieve the full details of a specific subscription.

Path Parameters

string
required
The unique identifier of the subscription.

Example Request

Example Response


Cancel Subscription

POST /v1/subscriptions/{id}/cancel
Cancel an active subscription. The subscription remains active until the end of the current billing period.

Path Parameters

string
required
The unique identifier of the subscription to cancel.

Example Request

Example Response

Subscription Statuses