> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dezerx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update an addon

> Changes the quantity or status of a purchased addon. When the server is live and the addon was applied by the module, the change is pushed to the provider first; if that fails nothing is changed.

**Permission:** `services.addons.write`



## OpenAPI

````yaml /docs/service-api.yaml put /services/{service}/addons/{index}
openapi: 3.1.0
info:
  title: Spartan Service API
  version: '2026.11'
  description: >-
    Services: create, read and update, lifecycle actions, billing and pricing,
    plan changes, notes, members, addons, provider details and dispute evidence.


    All requests need an API key from **Admin, API** in the `Authorization:
    Bearer <key>` header. Replace `{domain}` with the domain of your Spartan
    installation. Successful responses use the envelope `{"data": ..., "meta":
    {"request_id": ...}}`; errors use `{"error": {"code", "message", "details"},
    "request_id"}`.
servers:
  - url: https://{domain}/api/application
    description: Your Spartan installation
    variables:
      domain:
        default: billing.example.com
        description: Domain of your Spartan installation, without https://
security:
  - bearerAuth: []
tags:
  - name: Services
  - name: Lifecycle
  - name: Billing
  - name: Upgrades
  - name: Notes
  - name: Members
  - name: Addons
  - name: Service details
  - name: Evidence
paths:
  /services/{service}/addons/{index}:
    put:
      tags:
        - Addons
      summary: Update an addon
      description: >-
        Changes the quantity or status of a purchased addon. When the server is
        live and the addon was applied by the module, the change is pushed to
        the provider first; if that fails nothing is changed.


        **Permission:** `services.addons.write`
      operationId: updateServiceAddon
      parameters:
        - name: service
          in: path
          required: true
          description: Service id.
          schema:
            type: integer
        - name: index
          in: path
          required: true
          description: Zero based position of the addon in the service `addons` array.
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                quantity:
                  type: integer
                  minimum: 1
                status:
                  type: string
                  enum:
                    - active
                    - cancelled
              required:
                - quantity
                - status
            example:
              quantity: 2
              status: active
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      addon:
                        $ref: '#/components/schemas/Addon'
                  message:
                    type: string
                    description: Human readable confirmation.
                  meta:
                    $ref: '#/components/schemas/Meta'
                required:
                  - data
                  - meta
              example:
                data:
                  addon:
                    addon_id: 1
                    name: Extra backup slot
                    quantity: 2
                    price: 2
                    billing_cycle: monthly
                    status: active
                    module_applied: false
                message: Service addon updated.
                meta:
                  request_id: fd7d4a19-2757-4491-82ea-1f11539a71af
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                not_found:
                  summary: Unknown id in the path
                  value:
                    error:
                      code: not_found
                      message: The requested resource was not found.
                      details: {}
                    request_id: cccbc627-4fd4-4727-889e-fa727c48792c
                addon_not_found:
                  summary: Unknown addon index
                  value:
                    error:
                      code: addon_not_found
                      message: The addon does not belong to this service.
                      details: {}
                    request_id: bf837644-1310-450e-bd41-8794a7a09e90
        '409':
          description: Conflict with the current state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                addon_change_failed:
                  summary: Change in progress
                  value:
                    error:
                      code: addon_change_failed
                      message: >-
                        Another addon change for this service is being
                        processed.
                      details: {}
                    request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
        '422':
          description: Validation failed.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ValidationError'
                  - $ref: '#/components/schemas/Error'
              examples:
                validation_failed:
                  summary: Invalid input
                  value:
                    error:
                      code: validation_failed
                      message: The request data is invalid.
                      details:
                        quantity:
                          - The quantity field is required.
                    request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
                addon_change_failed:
                  summary: Provider rejected the change
                  value:
                    error:
                      code: addon_change_failed
                      message: >-
                        The addon could not be changed on the server, so the
                        billing record was left as it was.
                      details: {}
                    request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
components:
  schemas:
    Addon:
      type: object
      properties:
        addon_id:
          type: integer
          description: Addon id.
        name:
          type: string
          description: Addon name.
        quantity:
          type: integer
          description: Purchased quantity.
        price:
          type: number
          description: Price per unit and billing cycle.
        billing_cycle:
          type: string
        status:
          type: string
          enum:
            - active
            - pending_cancellation
            - cancelled
          description: Addon status.
        module_applied:
          type: boolean
          description: >-
            Whether the provisioning module already applied the addon to the
            server.
      additionalProperties: true
    Meta:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: Request id, also sent in the `X-Request-ID` response header.
      required:
        - request_id
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine readable error code, for example `unauthorized`,
                `forbidden`, `not_found`, `invalid_service_state`.
            message:
              type: string
              description: Human readable explanation.
            details:
              type: object
              properties: {}
              description: Extra context. An empty object for most errors.
              additionalProperties: true
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: >-
            Request id. Also returned in the `X-Request-ID` header. Send your
            own with `X-Request-ID` to correlate logs.
      description: Error envelope returned by every failed request.
      required:
        - error
        - request_id
    ValidationError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_failed
              description: Always `validation_failed`.
            message:
              type: string
              description: Always `The request data is invalid.`
            details:
              type: object
              properties: {}
              description: >-
                Map of field name to a list of messages. Nested fields use dot
                notation, for example `ticket_ids.0`.
              additionalProperties:
                type: array
                items:
                  type: string
          required:
            - code
            - message
            - details
        request_id:
          type: string
          format: uuid
          description: Request id.
      description: Returned with HTTP 422 when the body or query string fails validation.
      required:
        - error
        - request_id
  responses:
    Unauthorized:
      description: Missing, invalid or inactive API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing:
              summary: No Authorization header
              value:
                error:
                  code: unauthorized
                  message: Bearer token required.
                  details: {}
                request_id: 9aca26ca-e06f-4725-8e4b-4385d6c03422
            invalid:
              summary: Unknown or inactive key
              value:
                error:
                  code: unauthorized
                  message: Invalid or inactive token.
                  details: {}
                request_id: 8802a669-6f06-453e-a1d8-0b81621167c3
    Forbidden:
      description: >-
        The key lacks the permission for this endpoint, or the request IP is not
        in the key allow list.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            forbidden:
              summary: Missing permission
              value:
                error:
                  code: forbidden
                  message: Insufficient permissions for this action.
                  details: {}
                request_id: 191c51e1-03a3-448e-8df7-3c584be888b0
            ip_not_allowed:
              summary: IP not allowed
              value:
                error:
                  code: ip_not_allowed
                  message: Access denied from this IP address.
                  details: {}
                request_id: 3f6c2a1e-8b4d-4f7a-9c2e-5d1b7a9e0c42
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in Admin, API. Send it as `Authorization: Bearer <key>`.
        Each key has its own permissions and optional IP allow list.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.