Retrieve Subscription Information
GET/account/subscription/
Details about the accounts subscription (subscribed plan, billing cycle, etc..).
Responses
- 200
- 400
- 401
- 500
- application/json
- Schema
- Example (from schema)
Schema
per_unit- per_unitflat_fee- flat_feevolume- volumetiered- tieredUSD- USDEUR- EURGBP- GBPweek- Weekmonth- Monthyear- YearArray [
USD- USDEUR- EURGBP- GBP]
future- Futurein_trial- In Trialactive- Activenon_renewing- Non Renewingcancelled- Canceledself-service- Self Serviceassisted-sales- Assisted Salespartners- Partnersresellers- Resellers
plan
object
required
Possible values: <= 255 characters
Plan identifier.
Possible values: <= 50 characters
Plan name.
Plan family.
Possible values: <= 500 characters
Plan description.
Does plan include trial.
Possible values: [per_unit, flat_fee, volume, tiered]
Possible values: [USD, EUR, GBP]
Possible values: >= -2147483648 and <= 2147483647
Plan billing is done every N units.
Possible values: [week, month, year]
Unit for the plan billing cycle.
allowed_credits_packs
object[]
required
Possible values: <= 100 characters
Possible values: <= 50 characters
Possible values: >= -2147483648 and <= 2147483647
Possible values: [USD, EUR, GBP, ``]
Possible values: <= 4294967295
tiers
object
nullable
Possible values: [future, in_trial, active, non_renewing, cancelled, ``]
Subscription status
Date and time the trial period ends.
Date and time for next billing cycle.
Possible values: <= 4294967295
Amount to pay for next subscription renewal (in cents).
Possible values: <= 4294967295
Plan cost in cents.
Auto-collection enabled.
Possible values: <= 4294967295
Number of promotional targets with unlimited scans.
Possible values: <= 4294967295
Number of subscribed targets with unlimited scans. DO NOT change this for pro plans!!
Possible values: <= 4294967295
Number of targets with unlimited scans in use.
Possible values: <= 4294967295
Number of targets with unlimited scans available.
Possible values: <= 4294967295
Number of targets with unlimited scans available and which have not been assigned to any team's quota.
Return number of targets that can spend credits.
Number of unlimited scans' target changes in the past year.
Maximum number of allowed unlimited scans' target changes in a year.
Date time when unlimited scans' target changes are next allowed (if already at maximum).
Possible values: [self-service, assisted-sales, partners, resellers, null]
Customer channel
{
"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-07-29T15:51:28.071Z",
"next_billing_at": "2024-07-29T15:51:28.071Z",
"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-07-29T15:51:28.071Z",
"channel": "self-service"
}
- application/json
- Schema
- Example (from schema)
Schema
{
"<field name>": [
"Errors related to field <field name>."
],
"non_field_errors": [
"Errors not related to any field specific field."
]
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Incorrect authentication credentials."
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Unexpected error while handling your request."
}