# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Efí Pay Cobranças Subscriptions API
  version: 1.0.0
extends: openapi/gerencianet-subscriptions-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: 10
- target: $.paths['/plan/{id}/subscription'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a customer to a plan
      effect: write
      questions:
      - How do I subscribe a customer to one of my plans?
      - Can I create a subscription now and set the payment method later?
      instructions:
      - text: Create a subscription on plan {id}.
        slots:
          id: path.id
      - text: Subscribe a customer to plan {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/plan/{id}/subscription/one-step'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe and set payment in one step
      effect: write
      questions:
      - Can I create a subscription with its card or boleto payment in a single call?
      - What is the one-step way to subscribe someone?
      instructions:
      - text: Create a one-step subscription on plan {id}.
        slots:
          id: path.id
      - text: Subscribe a customer to plan {id} with payment in one call.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/plan/{id}/subscription/one-step/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a subscription payment link
      effect: write
      questions:
      - Can I generate a link so customers subscribe to a plan themselves?
      - What creates a subscription checkout link?
      instructions:
      - text: Create a subscription link for plan {id}.
        slots:
          id: path.id
      - text: Generate a sign-up payment link on plan {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription
      effect: read
      questions:
      - Can I look up a subscription and its charges?
      - What status is a customer's subscription in?
      instructions:
      - text: Show subscription {id}.
        slots:
          id: path.id
      - text: Get the details of subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription
      effect: write
      questions:
      - Can I change a subscription after it started?
      - What edits an existing subscription?
      instructions:
      - text: Update subscription {id}.
        slots:
          id: path.id
      - text: Edit subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription/{id}/pay'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the payment method on a subscription
      effect: write
      questions:
      - How do I add the card or boleto payment to a subscription I created?
      - Can I choose how a subscription gets paid after creating it?
      instructions:
      - text: Set the payment method for subscription {id}.
        slots:
          id: path.id
      - text: Pay subscription {id} by card or boleto.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription/{id}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a subscription
      effect: destructive
      questions:
      - Can I cancel a customer's subscription?
      - What stops future charges on a subscription?
      instructions:
      - text: Cancel subscription {id}.
        slots:
          id: path.id
      - text: Stop recurring billing on subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription/{id}/metadata'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription's metadata
      effect: write
      questions:
      - Can I change the custom metadata on a subscription?
      - What updates a subscription's metadata?
      instructions:
      - text: Update the metadata of subscription {id}.
        slots:
          id: path.id
      - text: Change the custom fields on subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/subscription/{id}/history'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a subscription's history
      effect: write
      questions:
      - Can I add my own note to a subscription's history?
      - Where do I log a comment on a subscription?
      instructions:
      - text: Add a history note to subscription {id}.
        slots:
          id: path.id
      - text: Record a comment on subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/charge/{id}/subscription/resend'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a subscription link to the customer
      effect: write
      questions:
      - Can I resend a subscription payment link by email?
      - What emails the sign-up link for a subscription again?
      instructions:
      - text: Resend the subscription link for charge {id}.
        slots:
          id: path.id
      - text: Email the subscription link on charge {id} to the customer.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'