Retrieve Subscription Information

GET 
/account/

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Details about the accounts subscription (subscribed plan, billing cycle, etc..).

Responses

200

application/json

Schema

Schema

status stringrequired
Possible values: [future, in_trial, active, non_renewing, cancelled]
Subscription status.
• future - Future
• in_trial - In Trial
• active - Active
• non_renewing - Non Renewing
• cancelled - Canceled
plan objectrequired
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
plan_target_quantity integerrequired

Subscribed target in account.

pool_size integerrequired

Subscribed pool size.

auto_collection booleanrequired

Auto-collection enabled.

next_billing_at date-timenullablerequired

Date and time for next billing cycle.

next_billing_amount int64required

Possible values: <= 4294967295

Amount to pay for next subscription renewal (in cents).

trial_end date-timenullablerequired

Date and time the trial period ends.

balance integerrequired

Possible values: >= -2147483648 and <= 2147483647

Credit in clients account in cents.

balance_currency_code stringrequired
Possible values: [USD, EUR, GBP, ``]
Currency unit for balance.
• USD - USD
• EUR - EUR
• GBP - GBP
has_used_trial booleanrequired
heroku booleanrequired

Heroku only account.

plan_amount int64required

Possible values: <= 4294967295

Plan cost in cents.

available_slots integernullablerequired

Number of free slots of targets with unlimited scans.
Calculated for targets with unlimited scans as follows:
Free slots = Account slots - Slots in use - Slots reserved for teams

Example (from schema)

{
  "status": "future",
  "plan": {
    "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": {}
  },
  "plan_target_quantity": 0,
  "pool_size": 0,
  "auto_collection": true,
  "next_billing_at": "2024-09-10T15:58:28.896Z",
  "next_billing_amount": 0,
  "trial_end": "2024-09-10T15:58:28.897Z",
  "balance": 0,
  "balance_currency_code": "USD",
  "has_used_trial": true,
  "heroku": true,
  "plan_amount": 0,
  "available_slots": 0
}

Example

{
  "status": "active",
  "plan": {
    "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": []
  },
  "plan_target_quantity": 5,
  "pool_size": 10,
  "auto_collection": true,
  "next_billing_at": "2019-08-24T14:15:22Z",
  "trial_end": "2019-08-24T14:15:22Z",
  "balance": 0,
  "balance_currency_code": "eur",
  "has_used_trial": true,
  "heroku": false,
  "plan_amount": 56000,
  "next_billing_amount": 56000,
  "available_slots": 5
}

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."
}

404

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

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

Loading...