Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Account

Retrieve Subscription Information

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

get/account/subscription/

Response

subscription_status'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_trialboolean
trial_endstring date-time nullable

Date and time the trial period ends.

next_billing_atstring date-time nullable

Date and time for next billing cycle.

next_billing_amountinteger

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

plan_amountinteger

Plan cost in cents.

auto_collectionboolean

Auto-collection enabled.

number_free_ultd_targetsinteger

Number of promotional targets with unlimited scans.

max_ultd_targetsinteger required
number_paid_ultd_targetsinteger

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

number_used_ultd_targetsinteger

Number of targets with unlimited scans in use.

number_available_ultd_targetsinteger

Number of targets with unlimited scans available.

number_available_ultd_targets_minus_team_quotasinteger

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

number_used_credit_targetsinteger required

Return number of targets that can spend credits.

number_available_credit_targetsinteger required
past_year_ultd_target_changesinteger required

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

max_yearly_ultd_target_changesinteger required

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

next_allowed_ultd_target_changestring date-time nullable required

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

channel'self-service' | 'assisted-sales' | 'partners' | 'resellers' | 'null' nullable

Customer channel

  • self-service - Self Service
  • assisted-sales - Assisted Sales
  • partners - Partners
  • resellers - Resellers
snyk_account_integration_enabledboolean