Skip to main content
GET
/
plans
/
{plan-id}
cURL
curl --request GET \
  --url https://api.spotflow.co/api/v1/plans/{plan-id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "string",
  "frequency": "DAILY",
  "internalReference": "string",
  "amount": 123,
  "currency": "NGN",
  "status": "ACTIVE",
  "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": "NGN"
      }
    ]
  },
  "pricingOptions": [
    {
      "amount": 123,
      "currency": "NGN"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
plan-id
string<uuid>
required

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

Response

Successfully retrieved subscription plan details.

Represents detailed information about a subscription plan including pricing, trial, and region availability.

​
id
string<uuid>
required

Unique identifier of the subscription plan (UUID).

​
title
string
required

The title or name of the subscription plan.

Example:

"string"

​
frequency
enum<string>
required

Billing frequency for the subscription plan.

Available options:
DAILY,
WEEKLY,
MONTHLY,
QUARTERLY,
BIANNUAL,
ANNUAL
​
amount
number
required

The cost amount for the subscription plan.

​
currency
string
required

The currency of the subscription plan (e.g., NGN, USD).

Example:

"NGN"

​
status
enum<string>
required

The current status of the subscription plan.

Available options:
ACTIVE,
INACTIVE,
ARCHIVED
​
createdAt
string<date-time>
required

Date and time when the plan was created.

​
internalReference
string

Internal reference code or identifier for the plan.

Example:

"string"

​
regions
string[]

List of regions where this plan is available.

​
subscribers
integer

Total number of active subscribers under this plan.

​
subscriptions
integer

Total number of subscriptions created for this plan.

​
trial
object

Details about the trial period associated with this plan.

​
pricingOptions
object[]

Different pricing options available for the plan.