> For the complete documentation index, see [llms.txt](https://docs.flashback.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flashback.tech/support-reference/platform-api-reference/subscriptions/get__subscriptions.md).

# 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

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

#### Code Samples

{% tabs %}
{% tab title="Shell" %}

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

{% endtab %}

{% tab title="HTTP" %}

```http
GET https://backend.flashback.tech/subscriptions HTTP/1.1
Host: localhost:3000
Accept: application/json
Authorization: Bearer {access-token}
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/subscriptions',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
```

{% endtab %}

{% tab title="Ruby" %}

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://backend.flashback.tech/subscriptions',
  params: {
  }, headers: headers

p JSON.parse(result)
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://backend.flashback.tech/subscriptions', headers = headers)

print(r.json())
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://backend.flashback.tech/subscriptions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
```

{% endtab %}

{% tab title="Java" %}

```java
URL obj = new URL("https://backend.flashback.tech/subscriptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://backend.flashback.tech/subscriptions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

{% endtab %}
{% endtabs %}

> Example responses

> 200 Response

```json
{
  "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

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

#### Responses <a href="#get__subscriptions-responses" id="get__subscriptions-responses"></a>

| Status | Meaning                                                                                             | Description                  | Schema |
| ------ | --------------------------------------------------------------------------------------------------- | ---------------------------- | ------ |
| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)                                             | List of active subscriptions | Inline |
| 500    | [Internal Server Error](https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error) | Server error                 | Inline |

#### Response Schema <a href="#get__subscriptions-responseschema" id="get__subscriptions-responseschema"></a>

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      |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.flashback.tech/support-reference/platform-api-reference/subscriptions/get__subscriptions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
