# List all subscription plans

Source: https://developers.swell.is/backend-api/subscription-plans/list-all-subscriptions

Return a list of products with subscription plans.

## Fields

- `expand` (string): Expand link fields and child collections by using the expand argument.

  - For example, `expand=account` would return a related customer account if one exists.

  When the field represents a collection, you can specify the query limit.

  - For example, `expand=variants:10` would return up to 10 records of the variants collection.

  See [expanding](https://developers.swell.is/backend-api/querying/expanding) for more details.
- `fields` (string): Returns only the specified fields in the result.

  - For example `fields=name,slug` would return only the fields `name` and `slug` in the response.

  Supports nested object and array fields using dot-notation.

  - For example, `items.product_id`. The product `id` is always returned.
- `include` (object): Include one or more arbitrary queries in the response which are potentially related to the main query.

  See [including](https://developers.swell.is/backend-api/querying/including) for more details.
- `limit` (int): Limit the number of records returned, ranging between `1` and `1000`. Defaults to `15`. Default: `15`.
- `page` (int): The page number of results to return given the specified or default `limit`.
- `search` (string): A text search is performed using the search argument. Searchable fields are defined by the model.

  - For example, `search=red` would return records containing the word "red" anywhere in the defined text fields.

  See [searching](https://developers.swell.is/backend-api/querying/searching) for more details.
- `sort` (string): Expression to sort results by using a format similar to a SQL sort statement.

  - For example, `sort=name asc` would return records sorted by name ascending.

  See [sorting](https://developers.swell.is/backend-api/querying/sorting) for more details.
- `where` (object): An object with criteria to filter the result.

  - For example, `active=true` would return records containing a field `active` with the value `true`.

  It's also possible to use query operators, for example, `$eq`, `$ne`, `$gt`, and more.

  See [querying](https://developers.swell.is/backend-api/querying) for more details.

## Example request

`GET /products`

**cURL**

```bash
$ curl -H "filter={'key':'subscription','value':'true'}" "https://api.swell.store/products?limit=25&page=1" \
  -u store-id:secret-key \
  -G
```

**Node**

```javascript
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');

await swell.get('/products', {
  limit: 25,
  page: 1,
  headers: {
    'filter': JSON.stringify({
      'key': 'subscription',
      'value': 'true'
    })
  }
});
```

**PHP**

```php
<?php

use Swell\Client;

$swell = new Client('store-id', 'secret-key');

$swell->get('/products', [
  'limit' => 25,
  'page' => 1,
  'filter' => [
    'key' => 'subscription',
    'value' => 'true'
  ]
]);

?>
```

## Example response

```json
{
  "count": 15,
  "results": [
    {
      "name": "Skooma",
      "purchase_options": {
        "subscription": {
          "active": true,
          "plans": [
            {
              "name": "Monthly",
              "description": null,
              "price": 75,
              "billing_schedule": {
                "interval": "monthly",
                "interval_count": 1,
                "limit": null,
                "trial_days": 1
              },
              "id": "64e799c1307e48001237eef5",
              "active": true,
              "$locale": {
                "en-US": {
                  "name": "Monthly",
                  "description": null
                }
              }
            }
          ]
        }
      },
      "currency": "USD",
      "slug": "skooma",
      "price": 75,
      "type": "standard",
      "delivery": "shipment",
      "tax_class": "standard",
      "date_created": "2023-08-24T17:56:17.162Z",
      "active": false,
      "stock_status": null,
      "id": "64e799c1307e48001237eef4"
    }
  ],
  "page": 1,
  "page_count": 1,
  "limit": 25
}
```