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

# Update usage overage policy

> Changes the overage setting of the current policy. From GET /v1/usage/policy, send current_period.start_date as expected_period_start_date and governing_revision.id as expected_governing_revision_id so that concurrent changes are rejected. Set confirmed_billing_impact when increasing billable capacity.



## OpenAPI

````yaml /openapi.json patch /v1/usage/policy
openapi: 3.1.0
info:
  title: Watchdog API
  version: 1.0.0
  description: >-
    The Watchdog API is served from https://api.watchdog.no. Request bodies are
    limited to 2 MiB unless an endpoint says otherwise. Files are uploaded
    directly to storage, not through the API.
servers:
  - url: https://api.watchdog.no
    description: Watchdog API
security: []
paths:
  /v1/usage/policy:
    patch:
      tags:
        - Usage
        - Settings
      summary: Update usage overage policy
      description: >-
        Changes the overage setting of the current policy. From GET
        /v1/usage/policy, send current_period.start_date as
        expected_period_start_date and governing_revision.id as
        expected_governing_revision_id so that concurrent changes are rejected.
        Set confirmed_billing_impact when increasing billable capacity.
      operationId: updateUsagePolicy
      parameters:
        - name: X-Organization-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            The organization to act in. Required for personal API keys; list the
            organizations you can access with GET /v1/organizations.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                expected_current_month:
                  type: string
                  pattern: ^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$
                expected_period_start_date:
                  type: string
                  format: date
                expected_governing_revision_id:
                  type: string
                  format: uuid
                overage:
                  oneOf:
                    - type: object
                      properties:
                        mode:
                          type: string
                          enum:
                            - disallowed
                      required:
                        - mode
                      additionalProperties: false
                    - type: object
                      properties:
                        mode:
                          type: string
                          enum:
                            - capped
                        quantity:
                          type: integer
                          minimum: 0
                          maximum: 10000000
                          exclusiveMinimum: 0
                      required:
                        - mode
                        - quantity
                      additionalProperties: false
                    - type: object
                      properties:
                        mode:
                          type: string
                          enum:
                            - uncapped
                      required:
                        - mode
                      additionalProperties: false
                confirmed_billing_impact:
                  type: boolean
              required:
                - expected_governing_revision_id
                - overage
                - confirmed_billing_impact
              additionalProperties: false
      responses:
        '200':
          description: Current policy after the update.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePolicy'
        '400':
          description: >-
            The request is invalid. details lists up to 20 field errors. Request
            bodies are limited to 2 MiB.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_validation_error'
              example:
                error:
                  code: validation_error
                  message: >-
                    The request is invalid. details lists up to 20 field errors.
                    Request bodies are limited to 2 MiB.
                  request_id: req_example
        '401':
          description: The bearer token is missing or invalid.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            WWW-Authenticate:
              schema:
                type: string
              required: false
              description: Bearer authentication challenge, when supplied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_invalid_token'
              example:
                error:
                  code: invalid_token
                  message: The bearer token is missing or invalid.
                  request_id: req_example
        '403':
          description: >-
            Access denied. The error code says why: forbidden, token_disabled,
            organization_required, insufficient_role or mfa_required.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required
              example:
                error:
                  code: forbidden
                  message: >-
                    Access denied. The error code says why: forbidden,
                    token_disabled, organization_required, insufficient_role or
                    mfa_required.
                  request_id: req_example
        '409':
          description: >-
            The policy changed since you read it, or no policy is configured.
            Read the policy again before retrying.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_conflict'
              example:
                error:
                  code: conflict
                  message: >-
                    The policy changed since you read it, or no policy is
                    configured. Read the policy again before retrying.
                  request_id: req_example
        '429':
          description: Too many requests. Wait for the Retry-After delay before retrying.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_rate_limit_exceeded'
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Wait for the Retry-After delay before
                    retrying.
                  request_id: req_example
        '500':
          description: >-
            Unexpected server failure. Include the request ID when contacting
            support.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_internal_error'
              example:
                error:
                  code: internal_error
                  message: >-
                    Unexpected server failure. Include the request ID when
                    contacting support.
                  request_id: req_example
        '503':
          description: >-
            Temporarily unavailable. Retry after the Retry-After delay, when
            provided.
          headers:
            X-Request-Id:
              schema:
                type: string
              required: true
              description: >-
                Request ID, also included in error bodies. Include it when
                contacting support.
            Cache-Control:
              schema:
                type: string
                enum:
                  - private, no-store
                  - private, no-store, no-transform
              required: false
              description: API responses are private and must not be cached.
            X-RateLimit-Limit:
              schema:
                type: string
                example: '500'
              required: false
              description: >-
                Requests allowed per minute for this credential, or failed API
                key attempts allowed per minute from this IP address.
            Retry-After:
              schema:
                type: string
                example: '60'
              required: true
              description: Seconds to wait before retrying the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error_service_unavailable'
              example:
                error:
                  code: service_unavailable
                  message: >-
                    Temporarily unavailable. Retry after the Retry-After delay,
                    when provided.
                  request_id: req_example
      security:
        - ApiKeyBearer: []
components:
  schemas:
    UsagePolicy:
      type: object
      properties:
        current_month:
          type: string
          pattern: ^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$
        current_date:
          type: string
          format: date
        current_period:
          type: object
          properties:
            cadence:
              type: string
              enum:
                - calendar_month
                - three_months
                - year
            anchor_date:
              type:
                - string
                - 'null'
              format: date
            start_date:
              type: string
              format: date
            end_date:
              type: string
              format: date
            period_start:
              type: string
              format: date-time
            period_end:
              type: string
              format: date-time
          required:
            - cadence
            - anchor_date
            - start_date
            - end_date
            - period_start
            - period_end
        billing_timezone:
          type: string
        billing_started:
          type: boolean
        policy:
          oneOf:
            - type: object
              properties:
                kind:
                  type: string
                  enum:
                    - none
              required:
                - kind
            - type: object
              properties:
                kind:
                  type: string
                  enum:
                    - configured
                included_quantity:
                  type: integer
                  minimum: 0
                period:
                  oneOf:
                    - type: object
                      properties:
                        cadence:
                          type: string
                          enum:
                            - calendar_month
                      required:
                        - cadence
                    - type: object
                      properties:
                        cadence:
                          type: string
                          enum:
                            - three_months
                            - year
                        anchor_date:
                          type: string
                          format: date
                      required:
                        - cadence
                        - anchor_date
                overage:
                  oneOf:
                    - type: object
                      properties:
                        mode:
                          type: string
                          enum:
                            - disallowed
                      required:
                        - mode
                      additionalProperties: false
                    - type: object
                      properties:
                        mode:
                          type: string
                          enum:
                            - capped
                        quantity:
                          type: integer
                          minimum: 0
                          maximum: 10000000
                          exclusiveMinimum: 0
                      required:
                        - mode
                        - quantity
                      additionalProperties: false
                    - type: object
                      properties:
                        mode:
                          type: string
                          enum:
                            - uncapped
                      required:
                        - mode
                      additionalProperties: false
              required:
                - kind
                - included_quantity
                - period
                - overage
        governing_revision:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              format: uuid
            effective_month:
              type: string
              pattern: ^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$
            effective_date:
              type: string
              format: date
            created_at:
              type: string
              format: date-time
          required:
            - id
            - effective_month
            - effective_date
            - created_at
        upcoming_policies:
          type: array
          items:
            type: object
            properties:
              effective_month:
                type: string
                pattern: ^(?:[1-9]\d{3})-(?:0[1-9]|1[0-2])$
              effective_date:
                type: string
                format: date
              policy:
                oneOf:
                  - type: object
                    properties:
                      kind:
                        type: string
                        enum:
                          - none
                    required:
                      - kind
                  - type: object
                    properties:
                      kind:
                        type: string
                        enum:
                          - configured
                      included_quantity:
                        type: integer
                        minimum: 0
                      period:
                        oneOf:
                          - type: object
                            properties:
                              cadence:
                                type: string
                                enum:
                                  - calendar_month
                            required:
                              - cadence
                          - type: object
                            properties:
                              cadence:
                                type: string
                                enum:
                                  - three_months
                                  - year
                              anchor_date:
                                type: string
                                format: date
                            required:
                              - cadence
                              - anchor_date
                      overage:
                        oneOf:
                          - type: object
                            properties:
                              mode:
                                type: string
                                enum:
                                  - disallowed
                            required:
                              - mode
                            additionalProperties: false
                          - type: object
                            properties:
                              mode:
                                type: string
                                enum:
                                  - capped
                              quantity:
                                type: integer
                                minimum: 0
                                maximum: 10000000
                                exclusiveMinimum: 0
                            required:
                              - mode
                              - quantity
                            additionalProperties: false
                          - type: object
                            properties:
                              mode:
                                type: string
                                enum:
                                  - uncapped
                            required:
                              - mode
                            additionalProperties: false
                    required:
                      - kind
                      - included_quantity
                      - period
                      - overage
            required:
              - effective_month
              - effective_date
              - policy
      required:
        - current_month
        - current_date
        - current_period
        - billing_timezone
        - billing_started
        - policy
        - governing_revision
        - upcoming_policies
    Error_validation_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_invalid_token:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_token
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - forbidden
                - token_disabled
                - organization_required
                - insufficient_role
                - mfa_required
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_conflict:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - conflict
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_rate_limit_exceeded:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - rate_limit_exceeded
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_internal_error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - internal_error
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
    Error_service_unavailable:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - service_unavailable
            message:
              type: string
            request_id:
              type: string
            description:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  field:
                    type: string
                  message:
                    type: string
                required:
                  - code
                  - field
                  - message
              maxItems: 20
            workflow_run_id:
              type: string
              format: uuid
            import_id:
              type: string
              format: uuid
            existing_party:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - supplier
                    - recipient
                id:
                  type: string
                  format: uuid
              required:
                - type
                - id
          required:
            - code
            - message
            - request_id
      required:
        - error
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      description: >-
        Personal API key sent as a bearer token, together with
        X-Organization-Id. The key must have at least the access level the
        endpoint requires (read, write or admin).

````

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