get__subscriptions

GET /subscriptions

List Subscriptions

Get all active subscriptions for the platform, including their active billing periods and capabilities.

Parameters

This endpoint does not accept query parameters.

TypeScript Client Library

public getSubscriptions = async (): Promise<GetSubscriptionsResponse> => {
  return this.makeRequest<GetSubscriptionsResponse>('subscriptions', 'GET', null);
};

Code Samples

# You can also use wget
curl -X GET https://backend.flashback.tech/subscriptions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Pro Plan",
      "description": "Includes higher limits and priority support",
      "periods": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "subscriptionId": "550e8400-e29b-41d4-a716-446655440000",
          "periodType": "MONTHLY",
          "price": 1999
        },
        {
          "id": "223e4567-e89b-12d3-a456-426614174000",
          "subscriptionId": "550e8400-e29b-41d4-a716-446655440000",
          "periodType": "YEARLY",
          "price": 19999
        }
      ],
      "capabilities": [
        {
          "id": "c13e4567-e89b-12d3-a456-426614174000",
          "code": "EXTENDED_SUPPORT",
          "description": "Priority support with faster SLAs",
          "type": "BOOLEAN",
          "price": 0,
          "periodType": "MONTHLY",
          "value": 1
        },
        {
          "id": "c23e4567-e89b-12d3-a456-426614174000",
          "code": "STORAGE_TB",
          "description": "Included storage in terabytes",
          "type": "QUOTA",
          "price": 0,
          "periodType": "MONTHLY",
          "value": 5
        }
      ]
    }
  ]
}

500 Response

{
  "success": false,
  "error_code": "INTERNAL_ERROR",
  "message": "An unexpected error occurred"
}

Responses

Status
Meaning
Description
Schema

200

List of active subscriptions

Inline

500

Server error

Inline

Response Schema

Status Code 200

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Indicates if the request was successful

» data

[object]

false

none

Array of subscriptions

»» id

string

false

none

Unique identifier for the subscription

»» name

string

false

none

Human-readable name for the subscription

»» description

string

false

none

Description of what the subscription includes

»» periods

[object]

false

none

Array of active billing periods for the subscription

»»» id

string

false

none

Unique identifier for the subscription period

»»» subscriptionId

string

false

none

Identifier of the parent subscription

»»» periodType

string

false

none

Billing period type (e.g., MONTHLY, YEARLY)

»»» price

number

false

none

Price for the period in the smallest currency unit

»» capabilities

[object]

false

none

Array of active capabilities for the subscription

»»» id

string

false

none

Unique identifier for the capability

»»» code

string

false

none

Machine-readable code for the capability

»»» description

string

false

none

Human-readable description of the capability

»»» type

string

false

none

Capability type (e.g., BOOLEAN, QUOTA)

»»» price

number

false

none

Price for the capability in the smallest currency unit

»»» periodType

string

false

none

Billing period type associated with the capability

»»» value

number

false

none

Value of the capability (semantics depend on capability)

Status Code 500

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Will be false for error responses

» error_code

string

false

none

Machine-readable error code

» message

string

false

none

Human-readable error message

Last updated

Was this helpful?