---
title: "Billing Feature Change"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/operations/billingFeatureChange1"
---

> Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md

# Billing Feature Change

`POST` `/policy/v1/transactions/{planCode}/{policyNumber}/billingfeaturechange`

Operation ID: `billingFeatureChange1`

Submit billing feature change request against business rules before submission.

## Path parameters

- `planCode` (string, required) - Plan Code
- `policyNumber` (string, required) - Policy Number

## Request body (required)

Content types: `application/json`

## Responses

- `202` - Success
- `500` - Unexpected error occured, please check server logs

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.9
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
paths:
  /policy/v1/transactions/{planCode}/{policyNumber}/billingfeaturechange:
    post:
      x-kong-plugin-pre-function:
        config:
          access:
            - >
              local path = kong.request.get_path()

              local new_path = path:gsub("^/policy/v1/transactions",
              "/bpm/v1/policies")

              kong.service.request.set_path(new_path)
      tags:
        - Non Financial Transactions
      summary: Billing Feature Change
      description: Submit billing feature change request against business rules before
        submission.
      operationId: billingFeatureChange1
      parameters:
        - name: planCode
          in: path
          required: true
          schema:
            type: string
          description: Plan Code
        - name: policyNumber
          in: path
          required: true
          schema:
            type: string
          description: Policy Number
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BillingFeatureChangeRequest"
            examples:
              billingFeatureChangeValidationExample:
                summary: Billing feature change validation request example
                value:
                  correlationId: e3bdb22b-790f-4357-ae60-42cdb0ff0d12
                  effectiveDate: 2026-07-24
                  transactionReason: AMOUNT
                  policyFeatures:
                    - featureType: BILLING
                      paymentAmount: 1000
                      approvalDate: 2026-07-24
                      frequency: DAILY
                  signatures:
                    - isSignedPresent: true
                      signDate: 2026-06-26
                      signDesignation: null
                      signType: OWNER
                      signTypeForUI: Owner
                    - isSignedPresent: false
                      signDate: null
                      signDesignation: null
                      signType: JOINTOWNER
                      signTypeForUI: Joint Owner
                  documents:
                    - documentId: DOC123456
                      documentType: NFO_FORM
                      documentDate: 2026-06-26
                      caseId: CA0000007389
                      policyNumber: WL987654321
                      planCode: WL1001
                  selfServeFlow: true
                  supportingDocumentAttached: true
      responses:
        "202":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionAcceptedResponse"
        "500":
          description: Unexpected error occured, please check server logs
      security:
        - Auth0: []
security:
  - Auth0: []
components:
  schemas:
    BillingFeatureChangeRequest:
      type: object
      description: |
        Request body for billing feature change validation
        (POST `/bpm/v1/policies/{planCode}/{policyNumber}/billingfeaturechange/validation`
        and policy API alias).
      properties:
        planCode:
          type: string
          description: Plan code (may duplicate path parameter)
        policyNumber:
          type: string
          description: Policy number (may duplicate path parameter)
        caseId:
          type: string
          example: CA0000007389
          description: Zinnia Live Case ID
        correlationId:
          type: string
          description: The unique ID to track transaction request across all systems
          example: e3bdb22b-790f-4357-ae60-42cdb0ff0d12
        carrierId:
          type: string
          example: FNWL
          description: Carrier identifier
        effectiveDate:
          type: string
          format: date
          example: 2026-07-24
          description: Effective date for the billing feature change
        transactionReason:
          $ref: "#/components/schemas/BillingFeatureChangeTransactionReason"
        policyFeatures:
          type: array
          minItems: 1
          description: Billing feature lines for the request
          items:
            $ref: "#/components/schemas/BillingFeatureChangePolicyFeature"
        signatures:
          type: array
          description: Signatures associated with the billing feature change
          items:
            $ref: "#/components/schemas/BillingFeatureChangeSignature"
        documents:
          type: array
          description: Supporting documents for the billing feature change
          items:
            $ref: "#/components/schemas/BillingFeatureChangeDocument"
        selfServeFlow:
          type: boolean
          description: Whether the request originated from a self-serve flow
          example: true
        supportingDocumentAttached:
          type: boolean
          description: Indicates whether supporting documents are attached
          example: true
      required:
        - effectiveDate
        - policyFeatures
    TransactionAcceptedResponse:
      type: object
      properties:
        correlationId:
          type: string
          example: 3a2a3435-2089-4b81-9959-e0d569ccf4f0
          description: Unique identifier which used by every system to trace the request
        caseId:
          type: string
          example: CA0000369469
          description: Zinnia Live Case ID
        caseStatus:
          type: string
          example: IN_PROGRESS
          description: Zinnia Live Case Status
        pdfId:
          type: string
          description: Identifier for the generated or associated PDF document (e.g.
            OnBase document number). Returned on systematic program setup and
            update submit when available.
          example: DOC-10004567
    BillingFeatureChangeTransactionReason:
      type: string
      enum:
        - AMOUNT
        - FREQUENCY
        - PAYMENTDUEDATE
      description: Reason for initiating the billing feature change transaction
      example: AMOUNT
    BillingFeatureChangePolicyFeature:
      type: object
      description: Billing policy feature details for the change request
      properties:
        featureType:
          type: string
          enum:
            - BILLING
          description: Type of the policy feature
          example: BILLING
        paymentAmount:
          type: number
          format: double
          description: Billing payment amount
          example: 1000
        approvalDate:
          type: string
          format: date
          description: Date on which the feature change was approved
          example: 2026-07-24
        frequency:
          $ref: "#/components/schemas/Frequency"
      required:
        - featureType
    BillingFeatureChangeSignature:
      type: object
      description: Signature details for billing feature change
      properties:
        isSignedPresent:
          type: boolean
          example: true
        signDate:
          type: string
          format: date
          nullable: true
          example: 2026-06-26
        signDesignation:
          type: string
          nullable: true
        signType:
          type: string
          description: Signature type code
          example: OWNER
        signTypeForUI:
          type: string
          description: Signature type label for UI display
          example: Owner
    BillingFeatureChangeDocument:
      type: object
      description: Supporting document reference for billing feature change
      properties:
        documentId:
          type: string
          example: DOC123456
        documentType:
          type: string
          example: NFO_FORM
        documentDate:
          type: string
          format: date
          example: 2026-06-26
        caseId:
          type: string
          example: CA0000007389
        policyNumber:
          type: string
          example: WL987654321
        planCode:
          type: string
          example: WL1001
    Frequency:
      type: string
      enum:
        - DAILY
        - EVERYTWOWEEKS
        - MONTHLY
        - SEMIANNUAL
        - BIANNUAL
        - QUARTERLY
        - ANNUAL
        - SINGLEPAYMENT
        - DEFAULT
      description: frequency
  securitySchemes:
    Auth0:
      type: openIdConnect
      openIdConnectUrl: https://login.qa.zinnia.com/.well-known/openid-configuration
      x-kong-security-openid-connect:
        config:
          run_on_preflight: true
          scopes_claim:
            - https://qa.api.zinnia.io/permissions
          audience_claim:
            - aud
          audience_required:
            - https://qa.api.zinnia.io
          client_id:
            - client_id
          auth_methods:
            - bearer
        enabled: true
        protocols:
          - grpc
          - grpcs
          - http
          - https
```
