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

# Update BillPay Number Status

> **Deprecated.** Use PATCH /billpay/{billPayNumber} with body { billStatus } instead. Updates the status of a BillPay reference. Inactive references will be rejected during verification and confirmation.



## OpenAPI

````yaml PUT /billpay/update-status
openapi: 3.0.1
info:
  title: CORE API - BillPay Control Number Creation
  description: API for creating BillPay Control Numbers
  version: 1.0.0
servers:
  - url: https://api.clickpesa.com/third-parties
security:
  - bearerAuth: []
paths:
  /billpay/update-status:
    put:
      description: >-
        **Deprecated.** Use PATCH /billpay/{billPayNumber} with body {
        billStatus } instead. Updates the status of a BillPay reference.
        Inactive references will be rejected during verification and
        confirmation.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - billPayNumber
                - status
              properties:
                billPayNumber:
                  type: string
                  description: The BillPay reference number to update
                  example: '55042914871931'
                status:
                  type: string
                  enum:
                    - ACTIVE
                    - INACTIVE
                  description: >-
                    The status to set for the BillPay reference. ACTIVE allows
                    payments to be processed, INACTIVE prevents payments from
                    being processed.
                  example: INACTIVE
            example:
              billPayNumber: '55042914871931'
              status: INACTIVE
      responses:
        '200':
          description: Successfully updated BillPay reference status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusUpdateResponse'
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      deprecated: true
components:
  schemas:
    StatusUpdateResponse:
      type: object
      properties:
        billPayNumber:
          type: string
          description: The BillPay reference number that was updated
          example: '55042914871931'
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          description: The updated status of the BillPay reference
          example: INACTIVE
    ValidationError:
      type: object
      properties:
        message:
          type: string
          description: Validation error message
          example: billPayNumber is required
    UnauthorizedError:
      type: object
      properties:
        message:
          type: string
          description: Unauthorized Error
          example: Unauthorized
    NotFoundError:
      type: object
      properties:
        message:
          type: string
          example: BillPay Number does not exist
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authorization header containing the JWT access token returned from the
        generate token endpoint. The token already includes the Bearer prefix.
        Example: `Authorization: Bearer eyJhbGciOi...`
      bearerFormat: JWT

````