SAP BRIM (Billing and Revenue Innovation Management) SAP BRIM Subscription Billing API — Subscriptions

naftiko: 1.0.0-alpha2
info:
  label: SAP BRIM (Billing and Revenue Innovation Management) SAP BRIM Subscription Billing API — Subscriptions
  description: 'SAP BRIM (Billing and Revenue Innovation Management) SAP BRIM Subscription Billing API — Subscriptions. 10
    operations. Lead operation: SAP BRIM (Billing and Revenue Innovation Management) List subscriptions. Self-contained Naftiko
    capability covering one Sap Brim Billing And Revenue Innovation Management business surface.'
  tags:
  - Sap Brim Billing And Revenue Innovation Management
  - Subscriptions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAP_BRIM_BILLING_AND_REVENUE_INNOVATION_MANAGEMENT_API_KEY: SAP_BRIM_BILLING_AND_REVENUE_INNOVATION_MANAGEMENT_API_KEY
capability:
  consumes:
  - type: http
    namespace: sap-brim-subscription-billing-subscriptions
    baseUri: https://api.sap.com/subscription-billing/v1
    description: SAP BRIM (Billing and Revenue Innovation Management) SAP BRIM Subscription Billing API — Subscriptions business
      capability. Self-contained, no shared references.
    resources:
    - name: subscriptions
      path: /subscriptions
      operations:
      - name: listsubscriptions
        method: GET
        description: SAP BRIM (Billing and Revenue Innovation Management) List subscriptions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customerId
          in: query
          type: string
          description: Filter by customer identifier
        - name: status
          in: query
          type: string
          description: Filter by subscription status
        - name: planId
          in: query
          type: string
          description: Filter by subscription plan
        - name: createdFrom
          in: query
          type: string
        - name: createdTo
          in: query
          type: string
      - name: createsubscription
        method: POST
        description: SAP BRIM (Billing and Revenue Innovation Management) Create a subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: subscriptions-subscriptionId
      path: /subscriptions/{subscriptionId}
      operations:
      - name: getsubscription
        method: GET
        description: SAP BRIM (Billing and Revenue Innovation Management) Get a subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesubscription
        method: PATCH
        description: SAP BRIM (Billing and Revenue Innovation Management) Update a subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesubscription
        method: DELETE
        description: SAP BRIM (Billing and Revenue Innovation Management) Delete a subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: subscriptions-subscriptionId-activate
      path: /subscriptions/{subscriptionId}/activate
      operations:
      - name: activatesubscription
        method: POST
        description: SAP BRIM (Billing and Revenue Innovation Management) Activate a subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: subscriptions-subscriptionId-cancel
      path: /subscriptions/{subscriptionId}/cancel
      operations:
      - name: cancelsubscription
        method: POST
        description: SAP BRIM (Billing and Revenue Innovation Management) Cancel a subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: subscriptions-subscriptionId-change-plan
      path: /subscriptions/{subscriptionId}/change-plan
      operations:
      - name: changesubscriptionplan
        method: POST
        description: SAP BRIM (Billing and Revenue Innovation Management) Change subscription plan
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: subscriptions-subscriptionId-renew
      path: /subscriptions/{subscriptionId}/renew
      operations:
      - name: renewsubscription
        method: POST
        description: SAP BRIM (Billing and Revenue Innovation Management) Renew a subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: subscriptions-subscriptionId-suspend
      path: /subscriptions/{subscriptionId}/suspend
      operations:
      - name: suspendsubscription
        method: POST
        description: SAP BRIM (Billing and Revenue Innovation Management) Suspend a subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.SAP_BRIM_BILLING_AND_REVENUE_INNOVATION_MANAGEMENT_API_KEY}}'
  exposes:
  - type: rest
    namespace: sap-brim-subscription-billing-subscriptions-rest
    port: 8080
    description: REST adapter for SAP BRIM (Billing and Revenue Innovation Management) SAP BRIM Subscription Billing API —
      Subscriptions. One Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/subscriptions
      name: subscriptions
      description: REST surface for subscriptions.
      operations:
      - method: GET
        name: listsubscriptions
        description: SAP BRIM (Billing and Revenue Innovation Management) List subscriptions
        call: sap-brim-subscription-billing-subscriptions.listsubscriptions
        with:
          customerId: rest.customerId
          status: rest.status
          planId: rest.planId
          createdFrom: rest.createdFrom
          createdTo: rest.createdTo
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsubscription
        description: SAP BRIM (Billing and Revenue Innovation Management) Create a subscription
        call: sap-brim-subscription-billing-subscriptions.createsubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}
      name: subscriptions-subscriptionid
      description: REST surface for subscriptions-subscriptionId.
      operations:
      - method: GET
        name: getsubscription
        description: SAP BRIM (Billing and Revenue Innovation Management) Get a subscription
        call: sap-brim-subscription-billing-subscriptions.getsubscription
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesubscription
        description: SAP BRIM (Billing and Revenue Innovation Management) Update a subscription
        call: sap-brim-subscription-billing-subscriptions.updatesubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesubscription
        description: SAP BRIM (Billing and Revenue Innovation Management) Delete a subscription
        call: sap-brim-subscription-billing-subscriptions.deletesubscription
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/activate
      name: subscriptions-subscriptionid-activate
      description: REST surface for subscriptions-subscriptionId-activate.
      operations:
      - method: POST
        name: activatesubscription
        description: SAP BRIM (Billing and Revenue Innovation Management) Activate a subscription
        call: sap-brim-subscription-billing-subscriptions.activatesubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/cancel
      name: subscriptions-subscriptionid-cancel
      description: REST surface for subscriptions-subscriptionId-cancel.
      operations:
      - method: POST
        name: cancelsubscription
        description: SAP BRIM (Billing and Revenue Innovation Management) Cancel a subscription
        call: sap-brim-subscription-billing-subscriptions.cancelsubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/change-plan
      name: subscriptions-subscriptionid-change-plan
      description: REST surface for subscriptions-subscriptionId-change-plan.
      operations:
      - method: POST
        name: changesubscriptionplan
        description: SAP BRIM (Billing and Revenue Innovation Management) Change subscription plan
        call: sap-brim-subscription-billing-subscriptions.changesubscriptionplan
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/renew
      name: subscriptions-subscriptionid-renew
      description: REST surface for subscriptions-subscriptionId-renew.
      operations:
      - method: POST
        name: renewsubscription
        description: SAP BRIM (Billing and Revenue Innovation Management) Renew a subscription
        call: sap-brim-subscription-billing-subscriptions.renewsubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/suspend
      name: subscriptions-subscriptionid-suspend
      description: REST surface for subscriptions-subscriptionId-suspend.
      operations:
      - method: POST
        name: suspendsubscription
        description: SAP BRIM (Billing and Revenue Innovation Management) Suspend a subscription
        call: sap-brim-subscription-billing-subscriptions.suspendsubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sap-brim-subscription-billing-subscriptions-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP BRIM (Billing and Revenue Innovation Management) SAP BRIM Subscription Billing API —
      Subscriptions. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: sap-brim-billing-and-revenue
      description: SAP BRIM (Billing and Revenue Innovation Management) List subscriptions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sap-brim-subscription-billing-subscriptions.listsubscriptions
      with:
        customerId: tools.customerId
        status: tools.status
        planId: tools.planId
        createdFrom: tools.createdFrom
        createdTo: tools.createdTo
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-brim-billing-and-revenue-2
      description: SAP BRIM (Billing and Revenue Innovation Management) Create a subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sap-brim-subscription-billing-subscriptions.createsubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-brim-billing-and-revenue-3
      description: SAP BRIM (Billing and Revenue Innovation Management) Get a subscription
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sap-brim-subscription-billing-subscriptions.getsubscription
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-brim-billing-and-revenue-4
      description: SAP BRIM (Billing and Revenue Innovation Management) Update a subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: sap-brim-subscription-billing-subscriptions.updatesubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-brim-billing-and-revenue-5
      description: SAP BRIM (Billing and Revenue Innovation Management) Delete a subscription
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sap-brim-subscription-billing-subscriptions.deletesubscription
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-brim-billing-and-revenue-6
      description: SAP BRIM (Billing and Revenue Innovation Management) Activate a subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sap-brim-subscription-billing-subscriptions.activatesubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-brim-billing-and-revenue-7
      description: SAP BRIM (Billing and Revenue Innovation Management) Cancel a subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sap-brim-subscription-billing-subscriptions.cancelsubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-brim-billing-and-revenue-8
      description: SAP BRIM (Billing and Revenue Innovation Management) Change subscription plan
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sap-brim-subscription-billing-subscriptions.changesubscriptionplan
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-brim-billing-and-revenue-9
      description: SAP BRIM (Billing and Revenue Innovation Management) Renew a subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sap-brim-subscription-billing-subscriptions.renewsubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-brim-billing-and-revenue-10
      description: SAP BRIM (Billing and Revenue Innovation Management) Suspend a subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sap-brim-subscription-billing-subscriptions.suspendsubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.