Skip to main content
GET
/
subscriptions
cURL
curl --request GET \
  --url https://api.spotflow.co/api/v1/subscriptions \
  --header 'Authorization: Bearer <token>'
[
  {
    "content": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "active",
        "startDate": "2023-11-07T05:31:56Z",
        "nextPaymentDate": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "customer": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "email": "jsmith@example.com",
          "name": "John Doe"
        },
        "metadata": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "currency": "NGN",
        "regionName": "Nigeria",
        "amount": 5000
      }
    ],
    "pageNumber": 123,
    "pageSize": 123,
    "totalElements": 123,
    "totalPages": 123
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
customerId
string<uuid>

The unique identifier of the customer Id whose subscriptions are to be retrieved.

​
email
string<uuid>

The unique identifier of the email whose subscriptions are to be retrieved.

​
page
integer
default:0

Page number for pagination (default is 0).

​
size
integer
default:10

Number of items per page for pagination (default is 10).

Response

A JSON array of subscription objects.

​
content
object[]
​
pageNumber
integer
​
pageSize
integer
​
totalElements
integer
​
totalPages
integer