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

# Update a subscription

> Update the editable fields of a subscription. Only the allow-listed properties may be changed; any other field is ignored. `billing_address` replaces the subscription's billing address (all of street, house number, zip, city are required); the address row is mutated in place, so a row shared across a customer's subscriptions changes everywhere it is referenced. `payment_method` attaches a new SEPA direct-debit mandate to the subscription, replacing the current mandate. `metadata` is merged key-by-key onto the stored metadata (a key set to `null` is removed; `metadata: null` clears every key). Returns the updated subscription. From API version 2026-09-08.gauss, the body must be JSON without repeated keys.



## OpenAPI

````yaml /openapi/openapi.curie.json patch /subscriptions/{id}
openapi: 3.0.0
info:
  title: Nomos API
  version: 2026-05-27.curie
servers:
  - url: https://api.nomos.energy
    description: production
security: []
tags:
  - name: Plans
  - name: Leads
  - name: Subscriptions
  - name: Customers
  - name: Usage
  - name: Prices
  - name: Invoices
  - name: Smart Meter Orders
  - name: Grid Fee Reductions
  - name: Market Partners
  - name: Events
  - name: Authentication
paths:
  /subscriptions/{id}:
    patch:
      tags:
        - Subscriptions
      summary: Update a subscription
      description: >-
        Update the editable fields of a subscription. Only the allow-listed
        properties may be changed; any other field is ignored. `billing_address`
        replaces the subscription's billing address (all of street, house
        number, zip, city are required); the address row is mutated in place, so
        a row shared across a customer's subscriptions changes everywhere it is
        referenced. `payment_method` attaches a new SEPA direct-debit mandate to
        the subscription, replacing the current mandate. `metadata` is merged
        key-by-key onto the stored metadata (a key set to `null` is removed;
        `metadata: null` clears every key). Returns the updated subscription.
        From API version 2026-09-08.gauss, the body must be JSON without
        repeated keys.
      parameters:
        - schema:
            type: string
            example: sub_mi4f0oda6x9m7gcsvjk0ole1
          required: true
          name: id
          in: path
      requestBody:
        description: The subscription fields to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscription'
      responses:
        '200':
          description: The updated subscription
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
        '400':
          description: >-
            The request is invalid: a field fails validation, breaks a business
            rule, or the body is not valid JSON. `errors` lists every problem
            with its field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequest'
              examples:
                Invalid billing address:
                  summary: Invalid billing address
                  value:
                    code: BAD_REQUEST
                    message: Postleitzahl muss mindestens 5 Zeichen lang sein
                    requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
                    docs: >-
                      https://docs.nomos.energy/api-references/errors/BAD_REQUEST
                    errors:
                      - code: too_small
                        field: billing_address.zip
                        message: Postleitzahl muss mindestens 5 Zeichen lang sein
                Malformed IBAN:
                  summary: Malformed IBAN
                  value:
                    code: BAD_REQUEST
                    message: Invalid IBAN format
                    requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
                    docs: >-
                      https://docs.nomos.energy/api-references/errors/BAD_REQUEST
                    errors:
                      - code: invalid_format
                        field: payment_method.sepa_debit.iban
                        message: Invalid IBAN format
                Body is not valid JSON:
                  $ref: '#/components/examples/400-body-is-not-valid-json'
                Unsupported version header:
                  $ref: '#/components/examples/400-unsupported-version-header'
        '401':
          description: The access token is missing, expired or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrUnauthorized'
              examples:
                No token:
                  $ref: '#/components/examples/401-no-token'
                Expired token:
                  $ref: '#/components/examples/401-expired-token'
                Invalid token:
                  $ref: '#/components/examples/401-invalid-token'
        '403':
          description: The access token is valid but not allowed to use this endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrForbidden'
              examples:
                Role without access:
                  $ref: '#/components/examples/403-role-without-access'
                Token without scope:
                  $ref: '#/components/examples/403-token-without-scope-2'
                Customer token without customer:
                  $ref: '#/components/examples/403-customer-token-without-customer'
        '404':
          description: >-
            A resource in the path or the body does not exist or belongs to
            another organization, or the endpoint does not exist in the API
            version of your token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrNotFound'
              examples:
                Unknown subscription:
                  $ref: '#/components/examples/404-unknown-subscription'
                Endpoint not in your API version:
                  summary: Endpoint not in your API version
                  value:
                    code: NOT_FOUND
                    message: >-
                      There is no PATCH /subscriptions/{id} in API version
                      2025-12-01.chucky.
                    requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
                    docs: https://docs.nomos.energy/api-references/errors/NOT_FOUND
        '500':
          description: >-
            Something went wrong on our side. Retry later, and send us the
            `requestId` if it persists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrInternalServerError'
              examples:
                Unexpected error:
                  $ref: '#/components/examples/500-unexpected-error'
      security:
        - Bearer: []
components:
  schemas:
    UpdateSubscription:
      type: object
      properties:
        billing_address:
          $ref: '#/components/schemas/BillingAddress'
        payment_method:
          $ref: '#/components/schemas/InsertPaymentMethod'
        metadata:
          type: object
          nullable: true
          additionalProperties:
            nullable: true
          description: >-
            Key-based metadata update. Keys sent here are merged onto the stored
            metadata; set a key to `null` to remove it. Send `metadata: null` to
            clear every key. Omit the field to leave the metadata unchanged. The
            resulting metadata is restricted to 10KB.
          example:
            utm_source: google
            utm_campaign: campaign_name
            user_id: '1234567890'
      example:
        billing_address:
          street: Torstraße
          house_number: '119'
          zip: '10115'
          city: Berlin
        payment_method:
          type: sepa_debit
          sepa_debit:
            iban: DE68500105178297336485
            account_holder: John Doe
        metadata:
          user_id: '1234567890'
    Subscription:
      type: object
      properties:
        object:
          type: string
          enum:
            - subscription
          description: Type of the object, always 'subscription'
        id:
          type: string
          description: Unique identifier for the subscription
          example: sub_rocbrf1u5e48mm0reeqoag90
        plan:
          type: string
          description: ID of the plan
          example: pln_ctj3tjzc7dywznuw1dy80lb3
        customer:
          $ref: '#/components/schemas/Customer'
        household:
          type: string
          description: >-
            ID of the household the subscription belongs to. A household groups
            the contracts at one metering point: one consumption subscription at
            a time, plus the feed-in subscriptions on that same meter. It
            belongs to one customer and stays the same when they cancel and sign
            up again. A separately metered device, such as a heat pump with its
            own meter and consumption subscription, is a household of its own,
            so one customer at one address can have two.
          example: dom_k2m9x4qpz7w1c8v3n6b5t0ry
        address:
          $ref: '#/components/schemas/Address'
        meter:
          $ref: '#/components/schemas/Meter'
        payment_method:
          $ref: '#/components/schemas/PaymentMethod'
        supplier:
          $ref: '#/components/schemas/SubscriptionSupplier'
        number:
          type: string
          nullable: true
          description: Human-readable identifier for the subscription
          example: 4X44EMKX
        status:
          type: string
          enum:
            - pending
            - active
            - ended
          description: Status of the subscription
          example: active
        estimated_usage:
          type: number
          description: >-
            Estimated yearly usage in kWh, provided by the customer in the
            checkout.
          example: 2500
        created_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
          description: Timestamp when the subscription was created
          example: '2024-03-14T12:00:00Z'
        updated_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
          description: Timestamp when the subscription was updated
          example: '2024-03-14T12:00:00Z'
        start_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
            - nullable: true
          description: Timestamp when delivery was started / will start
          example: '2024-03-14T12:00:00Z'
        terminated_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
            - nullable: true
          description: Timestamp when delivery was terminated
          example: '2024-03-14T12:00:00Z'
        end_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
            - nullable: true
          description: Timestamp when the subscription was ended / will end
          example: '2024-03-14T12:00:00Z'
        metadata:
          type: object
          nullable: true
          additionalProperties:
            nullable: true
          description: >-
            Metadata of the subscription. Store any type of information, custom
            to your needs. E.g. the `user_id` of your in-house user. Restricted
            to 10KB.
          example:
            utm_source: google
            utm_campaign: campaign_name
            user_id: '1234567890'
        type:
          type: string
          enum:
            - consumption
            - feed_in
          description: >-
            Whether the subscription covers electricity consumption or feed-in.
            Feed-in subscriptions are only available from the 2026-05-27.curie
            API version onwards.
          example: consumption
        billing_address:
          $ref: '#/components/schemas/Address'
      required:
        - object
        - id
        - plan
        - customer
        - household
        - address
        - meter
        - payment_method
        - status
        - estimated_usage
        - created_at
        - updated_at
        - type
        - billing_address
    ErrBadRequest:
      type: object
      properties:
        code:
          type: string
          enum:
            - BAD_REQUEST
          description: The error code related to the status code.
          example: BAD_REQUEST
        message:
          type: string
          description: A human readable message describing the issue.
        requestId:
          type: string
          description: The request id to be used for debugging and error reporting.
          example: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs:
          type: string
          description: The docs related to the error code.
          example: https://docs.nomos.energy/api-references/errors/BAD_REQUEST
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: >-
                  What is wrong with the field, such as `invalid_type` or
                  `asset_not_found`. `x-extensible-enum` lists the values known
                  today. New values can be added in any API version, so treat an
                  unknown value like any other error of the response's status.
                example: invalid_type
                x-extensible-enum:
                  - invalid_type
                  - too_big
                  - too_small
                  - invalid_format
                  - not_multiple_of
                  - unrecognized_keys
                  - invalid_union
                  - invalid_key
                  - invalid_element
                  - invalid_value
                  - custom
                  - unserviceable_zip
                  - ended_subscription
                  - duplicate_grid_reduction
                  - missing_smart_meter
                  - missing_module_1
                  - incompatible_grid_reduction
                  - unsupported_product
                  - unsupported_meter_order
                  - duplicate_meter_order
                  - unsupported_meter
                  - out_of_period_meter_reading
                  - unsupported_meter_reading
                  - duplicate_meter_reading
                  - implausible_meter_reading
                  - duplicate_customer_email
                  - invalid_iban
                  - upgrade_api_version
                  - withdrawal_not_allowed
                  - invalid_termination_date
                  - subscription_not_started
                  - terminated_subscription
                  - missing_household
                  - invalid_household_customer
                  - invalid_household_meter
                  - duplicate_consumption_subscription
                  - invalid_inverter
                  - read_only_asset
                  - duplicate_external_id
                  - asset_has_children
                  - asset_decommissioned
                  - asset_not_found
                  - mixed_households
                  - field_not_allowed
                  - invalid_direction
                  - duplicate_timestamp
                  - asset_not_steerable
                  - mode_not_allowed
                  - slot_missing
              field:
                type: string
                example: customer.email
              message:
                type: string
                example: 'Invalid input: expected string, received undefined'
            required:
              - code
              - field
              - message
          description: >-
            Per-field breakdown of a validation or business-rule failure.
            Omitted for API versions before the structured-errors cutoff.
      required:
        - code
        - message
        - requestId
        - docs
    ErrUnauthorized:
      type: object
      properties:
        code:
          type: string
          enum:
            - UNAUTHORIZED
          description: The error code related to the status code.
          example: UNAUTHORIZED
        message:
          type: string
          description: A human readable message describing the issue.
        requestId:
          type: string
          description: The request id to be used for debugging and error reporting.
          example: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs:
          type: string
          description: The docs related to the error code.
          example: https://docs.nomos.energy/api-references/errors/UNAUTHORIZED
      required:
        - code
        - message
        - requestId
        - docs
    ErrForbidden:
      type: object
      properties:
        code:
          type: string
          enum:
            - FORBIDDEN
          description: The error code related to the status code.
          example: FORBIDDEN
        message:
          type: string
          description: A human readable message describing the issue.
        requestId:
          type: string
          description: The request id to be used for debugging and error reporting.
          example: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs:
          type: string
          description: The docs related to the error code.
          example: https://docs.nomos.energy/api-references/errors/FORBIDDEN
      required:
        - code
        - message
        - requestId
        - docs
    ErrNotFound:
      type: object
      properties:
        code:
          type: string
          enum:
            - NOT_FOUND
          description: The error code related to the status code.
          example: NOT_FOUND
        message:
          type: string
          description: A human readable message describing the issue.
        requestId:
          type: string
          description: The request id to be used for debugging and error reporting.
          example: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs:
          type: string
          description: The docs related to the error code.
          example: https://docs.nomos.energy/api-references/errors/NOT_FOUND
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: >-
                  What is wrong with the field, such as `invalid_type` or
                  `asset_not_found`. `x-extensible-enum` lists the values known
                  today. New values can be added in any API version, so treat an
                  unknown value like any other error of the response's status.
                example: invalid_type
                x-extensible-enum:
                  - invalid_type
                  - too_big
                  - too_small
                  - invalid_format
                  - not_multiple_of
                  - unrecognized_keys
                  - invalid_union
                  - invalid_key
                  - invalid_element
                  - invalid_value
                  - custom
                  - unserviceable_zip
                  - ended_subscription
                  - duplicate_grid_reduction
                  - missing_smart_meter
                  - missing_module_1
                  - incompatible_grid_reduction
                  - unsupported_product
                  - unsupported_meter_order
                  - duplicate_meter_order
                  - unsupported_meter
                  - out_of_period_meter_reading
                  - unsupported_meter_reading
                  - duplicate_meter_reading
                  - implausible_meter_reading
                  - duplicate_customer_email
                  - invalid_iban
                  - upgrade_api_version
                  - withdrawal_not_allowed
                  - invalid_termination_date
                  - subscription_not_started
                  - terminated_subscription
                  - missing_household
                  - invalid_household_customer
                  - invalid_household_meter
                  - duplicate_consumption_subscription
                  - invalid_inverter
                  - read_only_asset
                  - duplicate_external_id
                  - asset_has_children
                  - asset_decommissioned
                  - asset_not_found
                  - mixed_households
                  - field_not_allowed
                  - invalid_direction
                  - duplicate_timestamp
                  - asset_not_steerable
                  - mode_not_allowed
                  - slot_missing
              field:
                type: string
                example: customer.email
              message:
                type: string
                example: 'Invalid input: expected string, received undefined'
            required:
              - code
              - field
              - message
          description: >-
            Per-field breakdown of a validation or business-rule failure.
            Omitted for API versions before the structured-errors cutoff.
      required:
        - code
        - message
        - requestId
        - docs
    ErrInternalServerError:
      type: object
      properties:
        code:
          type: string
          enum:
            - INTERNAL_SERVER_ERROR
          description: The error code related to the status code.
          example: INTERNAL_SERVER_ERROR
        message:
          type: string
          description: A human readable message describing the issue.
        requestId:
          type: string
          description: The request id to be used for debugging and error reporting.
          example: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs:
          type: string
          description: The docs related to the error code.
          example: >-
            https://docs.nomos.energy/api-references/errors/INTERNAL_SERVER_ERROR
      required:
        - code
        - message
        - requestId
        - docs
    BillingAddress:
      type: object
      properties:
        street:
          type: string
          minLength: 2
          maxLength: 100
          pattern: '[a-zA-Z\u00E4\u00F6\u00FC\u00DF\u00C4\u00D6\u00DC]'
          description: Street name of the address
          example: Torstraße
        house_number:
          type: string
          minLength: 1
          maxLength: 10
          pattern: ^[A-Za-z0-9\-/\s]+$
          description: House number including any additions
          example: '119'
        zip:
          type: string
          minLength: 5
          maxLength: 5
          pattern: ^\d+$
          description: ZIP/Postal code
          example: '10115'
        city:
          type: string
          minLength: 2
          maxLength: 100
          pattern: ^[^\d]*$
          description: City name
          example: Berlin
      required:
        - street
        - house_number
        - zip
        - city
      description: New billing address for the subscription
    InsertPaymentMethod:
      type: object
      properties:
        type:
          type: string
          enum:
            - sepa_debit
          description: Type of payment method
          example: sepa_debit
        sepa_debit:
          type: object
          properties:
            iban:
              type: string
              pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$
              description: >-
                IBAN number. From API version 2026-09-08.gauss its checksum must
                be valid, and known test IBANs are accepted in the sandbox only.
              example: DE68500105178297336485
            account_holder:
              type: string
              minLength: 1
              description: Name of the account holder
              example: John Doe
          required:
            - iban
            - account_holder
      required:
        - type
        - sepa_debit
      description: >-
        Attach a new SEPA direct-debit mandate. The new payment method replaces
        the subscription's current mandate.
    Customer:
      anyOf:
        - type: object
          properties:
            object:
              type: string
              enum:
                - customer
              description: Type of the object, always 'customer'
            id:
              type: string
              description: Unique identifier for the customer
              example: cus_mi4f0oda6x9m7gcsvjk0ole1
            type:
              type: string
              enum:
                - person
              default: person
              description: Type of the customer, always 'person'
            first_name:
              type: string
              description: Customer's first name
              example: John
            last_name:
              type: string
              description: Customer's last name
              example: Doe
            email:
              type: string
              format: email
              description: Email address
              example: john.doe@example.com
            vat_id:
              type: string
              nullable: true
              description: >-
                Tax number (Steuernummer) or VAT identification number
                (USt-IdNr.) of the customer
              example: DE123456789
            created_at:
              anyOf:
                - type: string
                - type: string
                  format: date-time
              description: Timestamp when the customer was created
              example: '2024-03-14T12:00:00Z'
          required:
            - object
            - id
            - first_name
            - last_name
            - email
            - created_at
          title: Person
        - type: object
          properties:
            object:
              type: string
              enum:
                - customer
              description: Type of the object, always 'customer'
            id:
              type: string
              description: Unique identifier for the customer
              example: cus_mi4f0oda6x9m7gcsvjk0ole1
            type:
              type: string
              enum:
                - company
              description: Type of the customer, always 'company'
            first_name:
              type: string
              description: First name of the customer
              example: John
            last_name:
              type: string
              description: Last name of the customer
              example: Doe
            company_name:
              type: string
              description: Company name
              example: Example GmbH
            email:
              type: string
              format: email
              description: Email address
              example: gmbh@example.com
            vat_id:
              type: string
              nullable: true
              description: >-
                Tax number (Steuernummer) or VAT identification number
                (USt-IdNr.) of the customer
              example: DE123456789
            created_at:
              anyOf:
                - type: string
                - type: string
                  format: date-time
              description: Timestamp when the customer was created
              example: '2024-03-14T12:00:00Z'
          required:
            - object
            - id
            - type
            - first_name
            - last_name
            - company_name
            - email
            - created_at
          title: Company
    Address:
      type: object
      properties:
        object:
          type: string
          enum:
            - address
          description: Type of the object, always 'address'
        id:
          type: string
          description: Unique identifier for the address
          example: adr_mi4f0oda6x9m7gcsvjk0ole1
        street:
          type: string
          minLength: 1
          description: Street name of the address
          example: Torstraße
        house_number:
          type: string
          minLength: 1
          description: House number including any additions
          example: '119'
        zip:
          type: string
          minLength: 5
          description: ZIP/Postal code
          example: '10115'
        city:
          type: string
          minLength: 1
          description: City name
          example: Berlin
        created_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
          description: Timestamp when the address was created
          example: '2024-03-14T12:00:00Z'
      required:
        - object
        - id
        - street
        - house_number
        - zip
        - city
        - created_at
    Meter:
      type: object
      properties:
        object:
          type: string
          enum:
            - meter
          description: Type of the object, always 'meter'
        id:
          type: string
          description: Unique identifier for the meter
          example: mtr_tihqsqnxx3xs1gonbnk0ccou
        melo:
          type: string
          nullable: true
          description: Metering Location ID
          example: DE0000001234567890
        number:
          type: string
          minLength: 1
          description: Meter identification number
          example: 1APA0195124010
        type:
          type: string
          enum:
            - smart
            - analog
          description: Type of the meter. Must be 'smart' for feed-in plans
          example: smart
        malo:
          type: string
          nullable: true
          description: >-
            Market Location Identifier (MaLo) for the meter: 11 digits with a
            check digit. A signup checks it from API version 2026-09-08.gauss
            on.
          example: '41373559241'
        created_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
          description: Timestamp when the meter was created
          example: '2024-03-14T12:00:00Z'
      required:
        - object
        - id
        - number
        - type
        - created_at
    PaymentMethod:
      type: object
      properties:
        object:
          type: string
          enum:
            - payment_method
          description: Type of the object, always 'payment_method'
        id:
          type: string
          description: Unique identifier for the payment method
          example: pm_adc9utqqpcp7tx054l7vg56s2
        type:
          type: string
          enum:
            - sepa_debit
          description: >-
            Type of payment method - Currently only SEPA direct debit is
            supported
          example: sepa_debit
        sepa_debit:
          type: object
          properties:
            iban:
              type: string
              description: >-
                International Bank Account Number (IBAN) for SEPA direct debit,
                partially masked for security
              example: DE************6485
            account_holder:
              type: string
              description: >-
                Full legal name of the bank account holder as registered with
                the bank
              example: John Doe
          required:
            - iban
            - account_holder
        created_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
          description: Timestamp when the payment method was created
          example: '2024-03-14T12:00:00Z'
      required:
        - object
        - id
        - type
        - sepa_debit
        - created_at
    SubscriptionSupplier:
      type: object
      nullable: true
      properties:
        object:
          type: string
          enum:
            - supplier
          description: Type of the object, always 'supplier'
        id:
          type: string
          description: Unique identifier for the supplier
          example: mp_a0x6jm5h92wde6s5dnuvha4c
        name:
          type: string
          minLength: 1
          description: Name of the energy supplier
          example: Sample Energy GmbH
        country:
          type: string
          minLength: 2
          maxLength: 2
          description: Two-letter country code
          example: DE
        created_at:
          anyOf:
            - type: string
            - type: string
              format: date-time
          description: Timestamp when the supplier was created
          example: '2024-03-14T12:00:00Z'
      required:
        - object
        - id
        - name
        - country
        - created_at
  examples:
    400-body-is-not-valid-json:
      summary: Body is not valid JSON
      value:
        code: BAD_REQUEST
        message: Malformed JSON in request body
        requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs: https://docs.nomos.energy/api-references/errors/BAD_REQUEST
    400-unsupported-version-header:
      summary: Unsupported version header
      value:
        code: BAD_REQUEST
        message: Version header 2026-01-01.foo is invalid.
        requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs: https://docs.nomos.energy/api-references/errors/BAD_REQUEST
    401-no-token:
      summary: No token
      value:
        code: UNAUTHORIZED
        message: No authorization header provided.
        requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs: https://docs.nomos.energy/api-references/errors/UNAUTHORIZED
    401-expired-token:
      summary: Expired token
      value:
        code: UNAUTHORIZED
        message: Token expired
        requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs: https://docs.nomos.energy/api-references/errors/UNAUTHORIZED
    401-invalid-token:
      summary: Invalid token
      value:
        code: UNAUTHORIZED
        message: Invalid or malformed token
        requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs: https://docs.nomos.energy/api-references/errors/UNAUTHORIZED
    403-role-without-access:
      summary: Role without access
      value:
        code: FORBIDDEN
        message: Forbidden to access this route.
        requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs: https://docs.nomos.energy/api-references/errors/FORBIDDEN
    403-token-without-scope-2:
      summary: Token without scope
      value:
        code: FORBIDDEN
        message: 'Insufficient scope: write:* required.'
        requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs: https://docs.nomos.energy/api-references/errors/FORBIDDEN
    403-customer-token-without-customer:
      summary: Customer token without customer
      value:
        code: FORBIDDEN
        message: Customer not found.
        requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs: https://docs.nomos.energy/api-references/errors/FORBIDDEN
    404-unknown-subscription:
      summary: Unknown subscription
      value:
        code: NOT_FOUND
        message: Subscription not found
        requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs: https://docs.nomos.energy/api-references/errors/NOT_FOUND
    500-unexpected-error:
      summary: Unexpected error
      value:
        code: INTERNAL_SERVER_ERROR
        message: Internal Server Error
        requestId: 37a04f8f-e791-491c-81e1-86cd304649bb
        docs: https://docs.nomos.energy/api-references/errors/INTERNAL_SERVER_ERROR
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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