Read the current billing subscription

GET

https://api.aventure.vc/v1/billing/subscription

GET

/v1/billing/subscription

curl https://api.aventure.vc/v1/billing/subscription \
     -H "Authorization: Bearer <token>"

{
  "additionalUsage": {
    "availableCreditCents": 1.1,
    "blocked": true,
    "enabled": true,
    "meter": [
      {
        "amountCents": 1.1,
        "quantity": 1,
        "type": "NEW_COMPANY"
      }
    ],
    "resetAt": "2024-01-15T09:30:00Z",
    "spentCents": 1.1,
    "unbilledCents": 1.1,
    "funding": "PREPAID_CREDIT",
    "invoiceIncrementCents": 1,
    "spendCapCents": 1
  },
  "allowance": {
    "entityView": {
      "resetAt": "2024-01-15T09:30:00Z",
      "used": 1,
      "limit": 1,
      "remaining": 1
    },
    "newCompany": {
      "resetAt": "2024-01-15T09:30:00Z",
      "used": 1,
      "limit": 1,
      "remaining": 1
    },
    "newPerson": {
      "resetAt": "2024-01-15T09:30:00Z",
      "used": 1,
      "limit": 1,
      "remaining": 1
    },
    "personView": {
      "resetAt": "2024-01-15T09:30:00Z",
      "used": 1,
      "limit": 1,
      "remaining": 1
    },
    "update": {
      "resetAt": "2024-01-15T09:30:00Z",
      "used": 1,
      "limit": 1,
      "remaining": 1
    },
    "updatePerson": {
      "resetAt": "2024-01-15T09:30:00Z",
      "used": 1,
      "limit": 1,
      "remaining": 1
    }
  },
  "cancelAtPeriodEnd": true,
  "entitled": true,
  "status": "NONE",
  "tier": "ESSENTIAL",
  "periodEnd": "2024-01-15T09:30:00Z",
  "periodStart": "2024-01-15T09:30:00Z",
  "plan": "PLUS_MONTHLY"
}

Return sanitized Essential, AI Plus, AI Pro, or Unlimited subscription, entitlement, monthly allowance usage, and additional usage spent and available.

Authentication

AuthorizationBearer

User bearer token: Clerk session JWT, Clerk OAuth access token, or Clerk API key

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

additionalUsageobject

Opt-in metered usage past the monthly allowance: settings, spend this UTC month, prepaid credit, and unbilled usage.

allowanceobject

cancelAtPeriodEndboolean

entitledboolean

statusenum

tierenum

Allowed values:

periodEnddatetime or nullOptional

periodStartdatetime or nullOptional

planenum or nullOptional

Canonical paid billing plan offered by aVenture.

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

406

Not Acceptable Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error