Skip to main content

Retrieve Subscription Information

GET 
/account/
deprecated

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

Responses​

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

    object

    required

    id stringrequired

    Possible values: <= 255 characters

    Plan identifier.

    name string

    Possible values: <= 50 characters

    Plan name.

    family stringnullable

    Plan family.

    description string

    Possible values: <= 500 characters

    Plan description.

    is_trial boolean

    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 integer

    Possible values: >= -2147483648 and <= 2147483647

    Plan billing is done every N units.

    period_unit string

    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 string

    Possible values: <= 50 characters

    price integer

    Possible values: >= -2147483648 and <= 2147483647

    currency_code string

    Possible values: [USD, EUR, GBP, ``]

    • USD - USD
    • EUR - EUR
    • GBP - GBP
    pack_amount int64

    Possible values: <= 4294967295

    discount integerrequired
    savings integerrequired

  • ]

    • discount integerrequired
    savings integerrequired

    tiers

    object

    nullable

    property name* anynullable
    plan_target_quantity integerrequired

    Subscribed target in account.

    pool_size integerrequired

    Subscribed pool size.

    auto_collection boolean

    Auto-collection enabled.

    next_billing_at date-timenullable

    Date and time for next billing cycle.

    next_billing_amount int64

    Possible values: <= 4294967295

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

    trial_end date-timenullable

    Date and time the trial period ends.

    balance integer

    Possible values: >= -2147483648 and <= 2147483647

    Credit in clients account in cents.

    balance_currency_code string

    Possible values: [USD, EUR, GBP, ``]

    Currency unit for balance.

    • USD - USD
    • EUR - EUR
    • GBP - GBP
    has_used_trial boolean
    heroku booleanrequired

    Heroku only account.

    plan_amount int64

    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

Loading...