Skip to main content
GET
/
plans
List all plans
curl --request GET \
  --url https://api.salesbricks.com/api/v2/plans \
  --header 'X-SALESBRICKS-KEY: <api-key>'
{
  "count": 123,
  "results": [
    {
      "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "plan_name": "<string>",
      "description": "<string>",
      "code": "<string>",
      "bricks": [
        {
          "brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "brick_name": "<string>",
          "included_units": 123,
          "min_units": 123,
          "tiers": [
            {
              "from": 123
            }
          ],
          "blocks": [
            {
              "from": 123,
              "to": 123
            }
          ]
        }
      ]
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

​
X-SALESBRICKS-KEY
string
header
required

API key for authentication

Query Parameters

​
currency
enum<string>

Currency for pricing tiers (default: USD)

Available options:
AUD,
CAD,
EUR,
GBP,
INR,
USD
​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

​
ordering
enum<string>

Order results by field (prefix with '-' for descending order)

Available options:
-created_at,
created_at

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"