API Reference — Product Rate Plan Charges

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Product Rate Plan Charges
  description: 'API Reference — Product Rate Plan Charges. 5 operations. Lead operation: CRUD: Create a product rate plan
    charge. Self-contained Naftiko capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Product Rate Plan Charges
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-product-rate-plan-charges
    baseUri: https://rest.zuora.com
    description: API Reference — Product Rate Plan Charges business capability. Self-contained, no shared references.
    resources:
    - name: v1-object-product-rate-plan-charge
      path: /v1/object/product-rate-plan-charge
      operations:
      - name: objectpostproductrateplancharge
        method: POST
        description: 'CRUD: Create a product rate plan charge'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: CreateRequest
          in: body
          type: string
          required: true
    - name: v1-object-product-rate-plan-charge-id
      path: /v1/object/product-rate-plan-charge/{id}
      operations:
      - name: objectgetproductrateplancharge
        method: GET
        description: 'CRUD: Retrieve a product rate plan charge'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: string
          description: Object fields to return
        - name: id
          in: path
          type: string
          description: The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19.
          required: true
      - name: objectputproductrateplancharge
        method: PUT
        description: 'CRUD: Update a product rate plan charge'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ModifyRequest
          in: body
          type: string
          required: true
        - name: id
          in: path
          type: string
          description: The unique ID of the product rate plan charge to be updated. For example, 2c93808457d787030157e031fcd34e19.
          required: true
      - name: objectdeleteproductrateplancharge
        method: DELETE
        description: 'CRUD: Delete a product rate plan charge'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The unique ID of the product rate plan charge to be deleted. For example, 2c93808457d787030157e031fcd34e19.
          required: true
    - name: v1-product-rate-plan-charges-product-rate-plan-charge-key
      path: /v1/product-rate-plan-charges/{product-rate-plan-charge-key}
      operations:
      - name: getretrieveproductrateplancharge
        method: GET
        description: Retrieve a product rate plan charge
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: product-rate-plan-charge-key
          in: path
          type: string
          description: The unique number or ID of the product rate plan charge to be retrieved.
          required: true
        - name: show-charge-definitions
          in: query
          type: boolean
          description: Specifies whether to include the product charge definitions of this charge in the response.
  exposes:
  - type: rest
    namespace: v1-product-rate-plan-charges-rest
    port: 8080
    description: REST adapter for API Reference — Product Rate Plan Charges. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/object/product-rate-plan-charge
      name: v1-object-product-rate-plan-charge
      description: REST surface for v1-object-product-rate-plan-charge.
      operations:
      - method: POST
        name: objectpostproductrateplancharge
        description: 'CRUD: Create a product rate plan charge'
        call: v1-product-rate-plan-charges.objectpostproductrateplancharge
        with:
          CreateRequest: rest.CreateRequest
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/object/product-rate-plan-charge/{id}
      name: v1-object-product-rate-plan-charge-id
      description: REST surface for v1-object-product-rate-plan-charge-id.
      operations:
      - method: GET
        name: objectgetproductrateplancharge
        description: 'CRUD: Retrieve a product rate plan charge'
        call: v1-product-rate-plan-charges.objectgetproductrateplancharge
        with:
          fields: rest.fields
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: objectputproductrateplancharge
        description: 'CRUD: Update a product rate plan charge'
        call: v1-product-rate-plan-charges.objectputproductrateplancharge
        with:
          ModifyRequest: rest.ModifyRequest
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: objectdeleteproductrateplancharge
        description: 'CRUD: Delete a product rate plan charge'
        call: v1-product-rate-plan-charges.objectdeleteproductrateplancharge
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/product-rate-plan-charges/{product-rate-plan-charge-key}
      name: v1-product-rate-plan-charges-product-rate-plan-charge-key
      description: REST surface for v1-product-rate-plan-charges-product-rate-plan-charge-key.
      operations:
      - method: GET
        name: getretrieveproductrateplancharge
        description: Retrieve a product rate plan charge
        call: v1-product-rate-plan-charges.getretrieveproductrateplancharge
        with:
          product-rate-plan-charge-key: rest.product-rate-plan-charge-key
          show-charge-definitions: rest.show-charge-definitions
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-product-rate-plan-charges-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Product Rate Plan Charges. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: crud-create-product-rate-plan
      description: 'CRUD: Create a product rate plan charge'
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-product-rate-plan-charges.objectpostproductrateplancharge
      with:
        CreateRequest: tools.CreateRequest
      outputParameters:
      - type: object
        mapping: $.
    - name: crud-retrieve-product-rate-plan
      description: 'CRUD: Retrieve a product rate plan charge'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-product-rate-plan-charges.objectgetproductrateplancharge
      with:
        fields: tools.fields
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: crud-update-product-rate-plan
      description: 'CRUD: Update a product rate plan charge'
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-product-rate-plan-charges.objectputproductrateplancharge
      with:
        ModifyRequest: tools.ModifyRequest
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: crud-delete-product-rate-plan
      description: 'CRUD: Delete a product rate plan charge'
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-product-rate-plan-charges.objectdeleteproductrateplancharge
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-product-rate-plan-charge
      description: Retrieve a product rate plan charge
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-product-rate-plan-charges.getretrieveproductrateplancharge
      with:
        product-rate-plan-charge-key: tools.product-rate-plan-charge-key
        show-charge-definitions: tools.show-charge-definitions
      outputParameters:
      - type: object
        mapping: $.