Skip to main content
GET
/
plans
cURL
curl --request GET \
  --url https://api.spotflow.co/api/v1/plans \
  --header 'Authorization: Bearer <token>'
[
  {
    "content": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "frequency": "DAILY",
        "internalReference": "<string>",
        "amount": 123,
        "currency": "<string>",
        "status": "<string>",
        "regions": [
          "<string>"
        ],
        "subscribers": 123,
        "subscriptions": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "trial": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "periodInDays": 123,
          "pricingList": [
            {
              "type": "FLAT",
              "amount": 123,
              "currency": "<string>"
            }
          ]
        },
        "pricingOptions": [
          {
            "amount": 123,
            "currency": "<string>"
          }
        ]
      }
    ],
    "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

title
string

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

internal-reference
string

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

query
string
status
string
from
string<date-time>
to
string<date-time>
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[]
required

List of plan items

pageNumber
integer
required

Current page number

pageSize
integer
required

Number of records per page

totalElements
integer
required

Total number of plan records

totalPages
integer
required

Total number of available pages