List Plans

GET 
/plans/

Request

Query Parameters

length integerrequired

Number of results to return per page.

page integerrequired

A page number within the paginated result set.

Responses

200

application/json

Schema

Schema

count integerrequired

Total number of results.

page_total integerrequired

Total number of pages.

page integerrequired

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

length integerrequired

Number of results returned per page.

results object[]
Array [
id stringrequired
Possible values: <= 255 characters
Plan identifier.
name stringrequired
Possible values: <= 50 characters
Plan name.
family stringnullablerequired
Plan family.
description stringrequired
Possible values: <= 500 characters
Plan description.
is_trial booleanrequired
Does plan include trial.
charge_model stringrequired
Possible values: [per_unit, flat_fee, volume, tiered]
• per_unit - per_unit
• flat_fee - flat_fee
• volume - volume
• tiered - tiered
price integerrequired
currency_code stringrequired
Possible values: [USD, EUR, GBP]
• USD - USD
• EUR - EUR
• GBP - GBP
period integerrequired
Possible values: >= -2147483648 and <= 2147483647
Plan billing is done every N units.
period_unit stringrequired
Possible values: [week, month, year]
Unit for the plan billing cycle.
• week - Week
• month - Month
• year - Year
allowed_builtin_scan_profiles string[]required
allowed_credits_packs object[]required
Array [
id stringrequired
Possible values: <= 100 characters
name stringrequired
Possible values: <= 50 characters
price integerrequired
Possible values: >= -2147483648 and <= 2147483647
currency_code stringrequired
Possible values: [USD, EUR, GBP, ``]
• USD - USD
• EUR - EUR
• GBP - GBP
pack_amount int64required
Possible values: <= 4294967295
discount integerrequired
savings integerrequired
]
discount integerrequired
savings integerrequired
tiers objectnullable
property name* anynullablerequired
]

Example (from schema)

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "string",
      "name": "string",
      "family": "string",
      "description": "string",
      "is_trial": true,
      "charge_model": "per_unit",
      "price": 0,
      "currency_code": "USD",
      "period": 0,
      "period_unit": "week",
      "allowed_builtin_scan_profiles": [
        "string"
      ],
      "allowed_credits_packs": [
        {
          "id": "string",
          "name": "string",
          "price": 0,
          "currency_code": "USD",
          "pack_amount": 0,
          "discount": 0,
          "savings": 0
        }
      ],
      "discount": 0,
      "savings": 0,
      "tiers": {}
    }
  ]
}

Example

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "enterprise-base-eur",
      "name": "Enterprise Plan",
      "family": "enterprise",
      "description": "",
      "is_trial": true,
      "charge_model": "flat_fee",
      "period": 1,
      "period_unit": "year",
      "allowed_scan_profiles": [
        "lightning",
        "safe",
        "normal",
        "full"
      ],
      "allowed_credits_packs": []
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]required
non_field_errors string[]required

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...