naftiko: 1.0.0-alpha2
info:
  label: Efí Pay Cobranças — Subscriptions
  description: >-
    Recurring billing on the Efí Pay Cobranças API: create a plan, attach a
    subscription, define payment method, and cancel.
  tags:
    - Efí Pay
    - Cobranças
    - Subscriptions
    - Recurring
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
  - namespace: env
    keys:
      EFI_COBRANCAS_CLIENT_ID: EFI_COBRANCAS_CLIENT_ID
      EFI_COBRANCAS_CLIENT_SECRET: EFI_COBRANCAS_CLIENT_SECRET
capability:
  consumes:
    - type: http
      namespace: efi-subscriptions
      baseUri: https://cobrancas.api.efipay.com.br
      description: Efí Pay subscriptions endpoints
      resources:
        - name: plans
          path: /v1/plans
          operations:
            - name: listPlans
              method: GET
              description: List plans
        - name: plan
          path: /v1/plan
          operations:
            - name: createPlan
              method: POST
              description: Create plan
        - name: plan-detail
          path: /v1/plan/{id}
          operations:
            - name: updatePlan
              method: PUT
              description: Update plan
            - name: deletePlan
              method: DELETE
              description: Delete plan
        - name: plan-subscription
          path: /v1/plan/{id}/subscription
          operations:
            - name: createSubscription
              method: POST
              description: Create subscription on plan
        - name: subscription
          path: /v1/subscription/{id}
          operations:
            - name: detailSubscription
              method: GET
              description: Retrieve subscription
            - name: updateSubscription
              method: PUT
              description: Update subscription
        - name: subscription-pay
          path: /v1/subscription/{id}/pay
          operations:
            - name: defineSubscriptionPayMethod
              method: POST
              description: Set subscription payment method
        - name: subscription-cancel
          path: /v1/subscription/{id}/cancel
          operations:
            - name: cancelSubscription
              method: PUT
              description: Cancel subscription