Skip to main content
GET
/
subscriptions
/
{subscription-id}
cURL
curl --request GET \
  --url https://api.spotflow.co/api/v1/subscriptions/{subscription-id} \
  --header 'Authorization: Bearer <token>'
{
  "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",
    "name": "John Doe",
    "email": "jsmith@example.com",
    "phoneNumber": "+234 80 7855 4801"
  },
  "metadata": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "currency": "NGN",
  "regionName": "Nigeria",
  "amount": 5000
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
subscription-id
string<uuid>
required

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

Query Parameters

​
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.

​
id
string<uuid>
required

Unique identifier for the subscription

​
customerId
string<uuid>
required

Identifier of the customer associated with this subscription

​
planId
string<uuid>
required

Identifier of the subscribed plan

​
status
enum<string>
required

Current status of the subscription (e.g. active, inactive)

Available options:
active,
inactive
​
startDate
string<date-time>
required

Date when the subscription started

​
currency
string
required

The currency in which the subscription is billed,

Example:

"NGN"

​
amount
number
required

The amount to be charged for the subscription.

Example:

5000

​
nextPaymentDate
string<date-time>

Next scheduled payment date

​
createdAt
string<date-time>

Date and time the subscription was created

​
customer
object

Details about the customer

​
metadata
object

Additional custom data associated with the subscription

​
regionName
string

The geographical region associated with the subscription.

Example:

"Nigeria"