Errors

`addon_required`

HTTP HTTP 402.

HTTP status: 402
Problem type: https://docs.filmo.io/errors/addon_required

{
  "type": "https://docs.filmo.io/errors/addon_required",
  "title": "Add-on required",
  "status": 402,
  "code": "addon_required",
  "detail": "Your plan does not include the add-on this operation requires",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredAddon": "incidence"
}

When it happens

402. The account has not contracted (or has let expire) the add-on the operation belongs to, named in requiredAddon. No role or scope bypasses it. It is answered per resource: the CRM, maintenance and incidents (the incidence add-on), purchases and custom fields each need their own add-on, and POST /api/v1/ai/ask answers it when the account has no AI credits left. Operations that need no add-on are not affected.

What to do

An administrator adds the add-on named in requiredAddon to the plan, or you stop calling the operations of that module. Do not change the key or its scopes.

Retry

Stop401 · 402 · 403 (key, owner or plan)
Do not retry: resending the same request fails again. Act on the key, its owner or the plan: use a valid key with the right scope, ask an administrator for the missing permission, or add the add-on.

Fields of errors[]

requiredAddonstring

On addon_required: the id of the add-on the account plan needs (the ids GET /account lists in addons).

Available options: qr-codes, incidence, purchases, activity-log, custom-fields, profitability, web-builder, crm, consignments, email-calendar, sales-documents, internal-bookings, internal-communication, advanced-user-permissions

Returned by

37 operations

GET /api/v1/repair-tickets — List repair tickets
POST /api/v1/repair-tickets — Create a repair ticket
GET /api/v1/repair-tickets/{ticketId} — Get a repair ticket
PATCH /api/v1/repair-tickets/{ticketId} — Update a repair ticket
PATCH /api/v1/subrents/{subrentId} — Update a subrent
GET /api/v1/purchase-orders — List purchase orders
GET /api/v1/purchase-orders/{purchaseOrderId} — Get a purchase order
PATCH /api/v1/purchase-orders/{purchaseOrderId} — Update a purchase order
GET /api/v1/custom-fields — List custom field definitions
GET /api/v1/incidents — List incidents
POST /api/v1/incidents — Open an incident
GET /api/v1/incidents/{incidentId} — Get an incident
PATCH /api/v1/incidents/{incidentId} — Update an incident
GET /api/v1/incidents/status-counts — Count incidents by status
POST /api/v1/incidents/{incidentId}/comments — Comment on an incident
GET /api/v1/crm/opportunities — List opportunities
POST /api/v1/crm/opportunities — Create an opportunity
GET /api/v1/crm/opportunities/{opportunityId} — Get an opportunity
PATCH /api/v1/crm/opportunities/{opportunityId} — Update an opportunity
PATCH /api/v1/crm/opportunities/{opportunityId}/stage — Move an opportunity to another stage
POST /api/v1/crm/opportunities/{opportunityId}/close — Close an opportunity
POST /api/v1/crm/opportunities/{opportunityId}/links — Link a document to an opportunity
GET /api/v1/crm/pipelines — List pipelines
GET /api/v1/crm/pipelines/{pipelineId} — Get a pipeline
POST /api/v1/purchase-orders/{purchaseOrderId}/approve — Approve a purchase order
POST /api/v1/purchase-orders/{purchaseOrderId}/receive — Receive material from a purchase order
GET /api/v1/supplier-invoices — List supplier invoices
GET /api/v1/supplier-invoices/{supplierInvoiceId} — Get a supplier invoice
POST /api/v1/ai/ask — Ask the AI about your data
POST /api/v1/invoices/{invoiceId}/validate — Validate an invoice
PUT /api/v1/invoices/external/{originSystem}/{originExternalId} — Create or update the mirror of an externally issued invoice
PATCH /api/v1/proformas/{proformaId}/status — Change the commercial status of a proforma
PATCH /api/v1/quotes/{quoteId}/status — Change the commercial status of a quote
POST /api/v1/contracts/{contractId}/validate — Validate a contract
POST /api/v1/contracts/{contractId}/sign — Record the signature of a contract
POST /api/v1/supplier-invoices/{supplierInvoiceId}/validate — Validate a supplier invoice
POST /api/v1/supplier-invoices/{supplierInvoiceId}/void — Void a supplier invoice

Through MCP

A tool call that fails comes back with `isError` set and the problem as structured content, with the same `code`.

Was this page helpful?

Example