Skip to main content
GET
/
account
/
subscription
Get subscription
curl --request GET \
  --url https://api.veryfront.com/account/subscription \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "server_usage": 123,
  "sandbox_usage": 123,
  "server_usage_details": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "short_id": "<string>",
      "environment_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "environments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "project_name": "<string>",
          "project_slug": "<string>"
        }
      ]
    }
  ],
  "line_items": [
    {
      "quantity": 123,
      "unit_amount": 123,
      "currency": "<string>"
    }
  ],
  "status": "<string>",
  "current_period_start": "<string>",
  "current_period_end": "<string>",
  "expires_at": "<string>",
  "canceled_at": "<string>",
  "created_at": "<string>"
}

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Response

Subscription details

id
string<uuid>

Subscription ID

user_id
string<uuid>

User that owns the subscription

project_id
string<uuid> | null

Project this subscription is scoped to, when applicable

server_usage
number

Active dedicated server records for the account

sandbox_usage
number

Active sandbox records for the account

server_usage_details
object[]

Active server add-on usage with linked project and environment labels

line_items
object[]

Subscription line items. Credits are one-time top-ups and are not included here.

status
string

Subscription status

current_period_start
string | null

Current billing period start timestamp

current_period_end
string | null

Current billing period end timestamp

expires_at
string | null

Subscription expiration timestamp

canceled_at
string | null

Subscription cancellation timestamp

created_at
string

Subscription creation timestamp