Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cart - V1 Usage Tiers API

5 actions 5 updates phrasing extends openapi/conga-usagetiers-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 5

$.info
$.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/usage-tiers'].get
$.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/usage-tiers'].put
$.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/usage-tiers'].post
$.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/usage-tiers'].delete

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 Cart - V1 Usage Tiers API
  version: 1.0.0
extends: openapi/conga-usagetiers-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: 4
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/usage-tiers'].get
  update:
    x-apievangelist-phrasing:
      intent: View usage price tiers on a cart line item
      effect: read
      questions:
      - What usage-based price tiers are set on a line item in my Conga cart?
      - Can I see the volume tier breakpoints currently applied to one cart line item?
      - Where do I check the usage pricing tiers for a product sitting in a quote cart?
      instructions:
      - text: Show the usage price tiers on line item {itemId} in cart {cartId}.
        slots:
          itemId: path.itemId
          cartId: path.cartId
      - text: Pull the current tier breakpoints for cart {cartId}, item {itemId}.
        slots:
          cartId: path.cartId
          itemId: path.itemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/usage-tiers'].put
  update:
    x-apievangelist-phrasing:
      intent: Change existing usage price tiers on a line item
      effect: write
      questions:
      - How do I edit usage price tiers that already exist on a cart line item?
      - Does changing an existing usage tier require the tier's ID?
      - Can I adjust the rates on usage tiers I added to a line item earlier?
      instructions:
      - text: Update the existing usage tiers on item {itemId} in cart {cartId} with the new rates.
        slots:
          itemId: path.itemId
          cartId: path.cartId
      - text: Revise the already-saved usage price tiers for cart {cartId} line {itemId}.
        slots:
          cartId: path.cartId
          itemId: path.itemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/usage-tiers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add usage price tiers to a cart line item
      effect: write
      questions:
      - Can I add new usage-based pricing tiers to a line item that has none yet?
      - Which call creates fresh volume tiers for a product in a cart?
      instructions:
      - text: Add new usage price tiers to line item {itemId} in cart {cartId}.
        slots:
          itemId: path.itemId
          cartId: path.cartId
      - text: Create tiered usage pricing for cart {cartId}, item {itemId}.
        slots:
          cartId: path.cartId
          itemId: path.itemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cart/v1/carts/{cartId}/items/{itemId}/usage-tiers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove usage price tiers from a line item
      effect: destructive
      questions:
      - Is there a way to strip all usage tiers off a cart line item?
      - What happens to a line item's usage pricing when I delete its tiers?
      instructions:
      - text: Delete the usage price tiers on item {itemId} in cart {cartId}.
        slots:
          itemId: path.itemId
          cartId: path.cartId
      - text: Clear every usage tier from cart {cartId} line item {itemId}.
        slots:
          cartId: path.cartId
          itemId: path.itemId
      method: generated
      generated: '2026-10-01'