Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Billing Management Custom Plan Template API

6 actions 6 updates phrasing extends openapi/conga-custom-plan-template-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/custom-plan-templates'].post
$.paths['/custom-plan-templates'].patch
$.paths['/custom-plan-templates/activate'].patch
$.paths['/custom-plan-templates/{planTemplateId}'].get
$.paths['/custom-plan-templates/{planTemplateId}/activate'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Billing Management Custom Plan Template API
  version: 1.0.0
extends: openapi/conga-custom-plan-template-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/custom-plan-templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create custom billing plan templates
      effect: write
      questions:
      - How do I create custom billing plan templates with installment or milestone line items?
      - Can I create several plan templates in one request and get per-record feedback?
      instructions:
      - text: Create these custom billing plan templates with their line items.
      - text: Add a batch of new plan templates with installment line items.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-plan-templates'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit custom plan templates in bulk
      effect: write
      questions:
      - Can I edit several custom plan templates and their line items together?
      - What comes back after a bulk edit of plan templates?
      instructions:
      - text: Bulk-edit these custom plan templates and their template line items.
      - text: Apply changes to multiple plan templates in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-plan-templates/activate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Activate or deactivate plan templates in bulk
      effect: write
      questions:
      - Can I switch a list of custom plan templates active or inactive at once?
      - Does bulk activation report success or failure for each template?
      instructions:
      - text: Activate every custom plan template in this list.
      - text: Deactivate the listed plan templates in one batch.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-plan-templates/{planTemplateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom plan template
      effect: read
      questions:
      - What line items and settings does a specific custom plan template have?
      - Can I include related records when fetching one plan template?
      instructions:
      - text: Show custom plan template {template_id}.
        slots:
          template_id: path.planTemplateId
      - text: Get plan template {template_id} including {includes}.
        slots:
          template_id: path.planTemplateId
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-plan-templates/{planTemplateId}/activate'].patch
  update:
    x-apievangelist-phrasing:
      intent: Activate or deactivate one plan template
      effect: write
      questions:
      - How do I turn a single custom plan template on or off?
      - Which flag sets one template's active status?
      instructions:
      - text: Set plan template {template_id} active to {active}.
        slots:
          template_id: path.planTemplateId
          active: query.active
      - text: Deactivate only custom plan template {template_id}.
        slots:
          template_id: path.planTemplateId
      method: generated
      generated: '2026-10-01'