Set a subscription price or end tracking

PATCH/api/companies/{companyId}/costs/subscriptions/{subscriptionId}
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Set a subscription price or end tracking.

Owner only for personal subscriptions; connection managers for shared subscriptions. Appends price history from now. Expected revision prevents lost updates. Ending tracking does not cancel provider billing. Monthly estimates never change recorded charges or agent budgets.

Authorization

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.
subscriptionIdstring (uuid)RequiredThe subscription's id.

Request body

application/json · required

expectedRevisionintegerRequired≥ 0
planstringRequired1–100 characters
amountCentsstring | number | nullRequired
currencystringRequiredone of: "USD", "EUR", "GBP", "CAD", "AUD", "CHF"
cadencestringRequiredone of: "month", "year"
statusstringRequiredone of: "active", "ended", "excluded"

Responses

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Costs and budgets