Skip to navigation
aVenture APIAccount and BillingBilling

Read the Current Billing Subscription

View as Markdown

Returns your Essential, AI Plus, AI Pro, or Unlimited subscription (with sensitive payment details removed), what it entitles you to, monthly allowance usage, and additional usage spent and available.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Response headers

X-RateLimit-LimitintegerOptional

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

X-RateLimit-RemainingintegerOptional

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

X-RateLimit-ResetintegerOptional

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

Response

OK
additionalUsageobject

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

allowanceobject
Used, cap, and reset time of each monthly allowance
cancelAtPeriodEndboolean
True when the plan is cancelled and ends at periodEnd
creditPurchasableboolean

True when POST /v1/billing/credit-purchases sells this account a prepaid credit pack; requires an entitled eligible paid plan and is false for an operator, an App Store plan, or any absent, expired or non-entitled plan (INCOMPLETE, PAST_DUE, UNPAID, or PAUSED)

entitledboolean
True while the subscription grants its paid tier
statusenum
tierstring
Tier whose monthly allowances apply now
appStoreCreditPurchasableboolean or nullOptional

True when an entitled eligible paid plan may buy App Store consumable research credit, independent of who bills its plan. Absent on older servers; clients must require true before offering a purchase. Retained balances remain visible but spending requires an eligible subscription.

originalStartdatetime or nullOptional

Original start of the continuing paid subscription; absent when the provider did not supply it

pendingPlanstring or nullOptional

Plan a scheduled change moves the subscription to at pendingPlanAt; absent when nothing is scheduled

pendingPlanAtdatetime or nullOptional

When pendingPlan takes effect; absent when nothing is scheduled

periodEnddatetime or nullOptional
When the plan renews, or when access ends if cancelAtPeriodEnd
periodStartdatetime or nullOptional
Start of the current billing period
planstring or nullOptional

Paid plan and billing cycle; absent without a paid subscription

providerenumOptional

Who bills the continuing paid subscription, including one past due or paused: STRIPE (managed on the web) or APP_STORE; absent without one

Allowed values:
recurringPriceobject or nullOptional

Subscribed renewal price before discounts; absent without a known paid Price

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