Skip to main content
GET
/
api
/
v1
/
billing
/
subscription
Get subscription billing overview
curl --request GET \
  --url https://neo.api.projectdiscovery.io/api/v1/billing/subscription \
  --header 'Authorization: Bearer <token>'
{
  "has_subscription": true,
  "available_credits": 123,
  "cancel_at_period_end": true,
  "discount_credits": 123,
  "next_charge_cents": 123,
  "next_charge_display": "<string>",
  "payment_methods": [
    {
      "brand": "<string>",
      "exp_month": 123,
      "exp_year": 123,
      "id": "<string>",
      "is_default": true,
      "last4": "<string>"
    }
  ],
  "pending_change": {
    "credits_per_user": 123,
    "demote_member_emails": [
      "<string>"
    ],
    "effective_at": "2023-11-07T05:31:56Z",
    "interval": "<string>",
    "seats": 123
  },
  "per_seat_usage": [
    {
      "allotment": 123,
      "email": "<string>",
      "remaining": 123,
      "seat_status": "<string>",
      "used": 123
    }
  ],
  "plan": {
    "collection_method": "<string>",
    "credits_per_user": 123,
    "interval": "<string>",
    "seats": 123
  },
  "renews_at": "2023-11-07T05:31:56Z",
  "reset_at": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "subscription_credits": 123,
  "subscription_remaining": 123,
  "subscription_used": 123,
  "topup_credits": 123,
  "topup_expires_at": "2023-11-07T05:31:56Z",
  "topup_purchased": 123,
  "topup_remaining": 123,
  "topup_used": 123,
  "used_credits": 123
}

Authorizations

Authorization
string
header
required

JWT authentication token

Response

Subscription overview

has_subscription
boolean
required
available_credits
number<double>
cancel_at_period_end
boolean
discount_credits
number<double>

Bonus subscription credits currently granted from the first-month discount (per-seat allotment above the billed tier). 0 once the first credit-month has settled or when no discount applies.

next_charge_cents
integer
next_charge_display
string
payment_methods
object[]
pending_change
object
per_seat_usage
object[]
plan
object
renews_at
string<date-time>
reset_at
string<date-time>

When the monthly subscription credits next reset

status
string

active, past_due, canceled, incomplete

subscription_credits
number<double>

Monthly subscription grant total (seats x credits_per_user)

subscription_remaining
number<double>
subscription_used
number<double>
topup_credits
number<double>

Current top-up bucket total (issued_credits)

topup_expires_at
string<date-time>
topup_purchased
number<double>

Lifetime total top-up credits purchased for this resource.

topup_remaining
number<double>
topup_used
number<double>

Lifetime top-up credits consumed (purchased - current balance).

used_credits
number<double>