v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
Account

Retrieve Credits Details

get/account/credits/

Response

promotional_creditsinteger

Number of promotional credits available.

purchased_creditsinteger

Number of purchased credits available.

outstanding_creditsinteger

Number of credits in debt. A positive number means debt.

on_hold_promotionalinteger

Number of promotional credits assigned to running scans.

on_hold_purchasedinteger

Number of purchased credits assigned to running scans.

promotional_expiration_datestring date nullable

Date of expiration of the promotional credits, in ISO 8601 UTC format. For example, "2023-08-09".

purchased_expiration_datestring date nullable

Date of expiration of the purchased credits, in ISO 8601 UTC format. For example, "2023-08-09".

balanceinteger required

Total number of credits available.

Calculated from promotional, purchased, and outstanding credits.