Retrieve Subscription Information

GET 
/account/subscription/

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

Responses

200

application/json

Schema

Schema

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
subscription_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
has_used_trial booleanrequired
trial_end date-timenullablerequired

Date and time the trial period ends.

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).

plan_amount int64required

Possible values: <= 4294967295

Plan cost in cents.

auto_collection booleanrequired

Auto-collection enabled.

number_free_ultd_targets int64required

Possible values: <= 4294967295

Number of promotional targets with unlimited scans.

max_ultd_targets integerrequired
number_paid_ultd_targets int64required

Possible values: <= 4294967295

Number of subscribed targets with unlimited scans. DO NOT change this for pro plans!!

number_used_ultd_targets int64required

Possible values: <= 4294967295

Number of targets with unlimited scans in use.

number_available_ultd_targets int64required

Possible values: <= 4294967295

Number of targets with unlimited scans available.

number_available_ultd_targets_minus_team_quotas int64required

Possible values: <= 4294967295

Number of targets with unlimited scans available and which have not been assigned to any team's quota.

number_used_credit_targets integerrequired

Return number of targets that can spend credits.

number_available_credit_targets integerrequired
past_year_ultd_target_changes integerrequired

Number of unlimited scans' target changes in the past year.

max_yearly_ultd_target_changes integerrequired

Maximum number of allowed unlimited scans' target changes in a year.

next_allowed_ultd_target_change date-timenullablerequired

Date time when unlimited scans' target changes are next allowed (if already at maximum).

channel stringnullablerequired
Possible values: [self-service, assisted-sales, partners, resellers, null]
Customer channel
• self-service - Self Service
• assisted-sales - Assisted Sales
• partners - Partners
• resellers - Resellers

Example (from schema)

{
  "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": {}
  },
  "subscription_status": "future",
  "has_used_trial": true,
  "trial_end": "2024-09-10T15:58:28.932Z",
  "next_billing_at": "2024-09-10T15:58:28.932Z",
  "next_billing_amount": 0,
  "plan_amount": 0,
  "auto_collection": true,
  "number_free_ultd_targets": 0,
  "max_ultd_targets": 0,
  "number_paid_ultd_targets": 0,
  "number_used_ultd_targets": 0,
  "number_available_ultd_targets": 0,
  "number_available_ultd_targets_minus_team_quotas": 0,
  "number_used_credit_targets": 0,
  "number_available_credit_targets": 0,
  "past_year_ultd_target_changes": 0,
  "max_yearly_ultd_target_changes": 0,
  "next_allowed_ultd_target_change": "2024-09-10T15:58:28.932Z",
  "channel": "self-service"
}

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