Retrieve a plan

Returns the details of a plan, including its name and bricks.

GET /plans/{plan_id}

Retrieve a plan

cURL

curl --request GET \
  --url https://api.salesbricks.com/api/v2/plans/{plan_id} \
  --header 'X-SALESBRICKS-KEY: <api-key>'

200

{
  "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "plan_name": "<string>",
  "description": "<string>",
  "code": "<string>",
  "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "product_name": "<string>",
  "is_product_active": true,
  "is_private": true,
  "bricks": [
    {
      "brick_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "brick_name": "<string>",
      "brick_type": "SUBSCRIPTION",
      "included_units": 123,
      "min_units": 123,
      "tiers": [
        {
          "from": 123
        }
      ],
      "blocks": [
        {
          "from": 123,
          "to": 123
        }
      ]
    }
  ]
}

Authorizations

X-SALESBRICKS-KEY · string · header · required

API key for authentication

Path Parameters

plan_id · string · required

Pattern: ^([a-zA-Z\d\-]+)$

Query Parameters

currency · enum<string>

Currency for pricing tiers (default: USD)

Available options: AUD, CAD, EUR, GBP, INR, USD

Response

200

application/json

plan_id · string<uuid> · required

Unique identifier for the plan

plan_name · string · required

Name of the plan

description · string | null · required

Description of the plan

code · string | null · required

Code for the plan

product_id · string<uuid> · required

Unique identifier for the product the plan belongs to

product_name · string · required

Name of the product the plan belongs to

is_product_active · boolean · required

Whether the product is active. Plans on an inactive product are still listed here but cannot be used to build new orders.

is_private · boolean · required

Private plans are not selectable by a buyer during self-serve, though your team can still build orders on them.

bricks · object[] · required · read-only

Bricks for the plan

Show child attributes