Billing & Usage - Veryfront

Browse GraphQL domains.

Queries

Operation	Description
`accountUsageLimits`	Get account usage limits.
`accountUsageWarnings`	Get account usage warnings.
`aiBudget`	Get a budget named inside an input object.
`aiBudgets`	List budgets with the page cursors of the REST listing.
`billingDetails`	Read the name, email, phone, address and tax IDs that appear on the invoices of an account; returns empty details and customer_available false before the account has a billing customer.
`budget`	Get a budget and its usage for the current month.
`budgets`	List the budgets the caller may manage with their usage this month, for one project or narrowed to a member or API key.
`checkUsageLimit`	Check usage limit.
`conversationAnalytics`	Summarize the conversation activity and model use in the projects of an account, optionally for one project or label; returns totals, a daily series and recent conversations, with private titles limited to participants.
`creditBalance`	Read how many credits an account has left in its monthly and purchased pools, with its monthly allocation and top-up price; returns the balance.
`creditPackages`	List the credit packages an account can buy and their prices before starting a credit checkout; returns the whole catalogue as one page.
`creditTransactions`	List the credit grants, purchases, refunds and charges of an account, newest first unless sorted otherwise; returns one page of credit transactions.
`creditUsage`	Break the credit spend of an account down by day, project and model, optionally for one project; returns the series with token counts per model.
`featureGate`	Check whether a plan allows a feature before offering it, for the caller or for the owner of a project; returns allowed with the required tier, limit and current count, and a denied gate is a result, not an error.
`invoices`	List the issued invoices of an account, or with kind upcoming the previews and drafts of what it will be charged next; returns one page of invoices with amounts in minor currency units.
`paymentMethods`	List the cards saved for an account and which one is the default; returns one page of payment methods, which are changed in the billing portal.
`payments`	List the payments an account has made, with their receipt links; returns one page of payments with amounts in minor currency units.
`projectCollaboration`	Get available seats.
`subscription`	Read the plan, billing cycle, seats and add-ons of an account before changing or cancelling its subscription; returns the subscription with its seat usage.
`usage`	Read what an account has used of each plan quota in the current billing period, with its tier, project count, credits spent and warnings; returns usage where a total of -1 means unlimited.
`usageOverview`	Get account usage overview.
`usageSeries`	Chart one usage metric of an account by day, optionally for one project; returns the daily series with a total and a per-project breakdown.
`usageSummary`	Get usage summary.
`usageTier`	Get the account usage tier with its raw limits.
`usageWarnings`	Get account usage warnings as a bare list of messages.

Mutations

Operation	Description
`cancelSubscription`	Schedule the paid subscription of an account to end with its current billing period; returns the canceled subscription.
`createAiBudget`	Create a monthly AI spending limit, with the scope and limit in one input.
`createBillingPortalSession`	Open a Stripe billing portal session where a person changes payment methods, tax details or the renewal of an account; returns the portal URL.
`createBudget`	Create a monthly AI spending limit for a project, a member on a project, an API key, or a combination of these.
`createCreditCheckout`	Start a Stripe checkout to buy a credit package for an account, or for the account that owns a project; returns the checkout URL.
`deleteAiBudget`	Delete a budget named inside an input object.
`deleteBudget`	Delete budget.
`recordUsage`	Record usage.
`redeemCreditCoupon`	Redeem a coupon code for credits on an account; returns the credits granted and the new balance, or already_redeemed for a code the account used before.
`updateAiBudget`	Change the monthly limit of a budget named inside the input object.
`updateBillingDetails`	Change the name, email, phone or address on the invoices of an account, where an omitted field keeps its value and null clears it; returns the updated billing details.
`updateBudget`	Change the monthly limit of a budget, keeping its scope and this month’s usage.
`updateSubscription`	Change the plan, billing cycle, seats or add-ons of an account; returns what changed, or a checkout URL when the change needs payment.