SAP BRIM (Billing and Revenue Innovation Management)

SAP BRIM (Billing and Revenue Innovation Management) Plans API

Subscription plan and offer catalog management

GitHub OpenAPI
Business capability
Plan & Entitlement Design BC-4240.10

Operations 5

GET /plans SAP BRIM (Billing and Revenue Innovation Management) List subscription plans #
POST /plans SAP BRIM (Billing and Revenue Innovation Management) Create a subscription plan #
GET /plans/{planId} SAP BRIM (Billing and Revenue Innovation Management) Get a subscription plan #
PUT /plans/{planId} SAP BRIM (Billing and Revenue Innovation Management) Update a subscription plan #
DELETE /plans/{planId} SAP BRIM (Billing and Revenue Innovation Management) Delete a subscription plan #

Documentation

📖
Documentation
https://help.sap.com/docs/SAP_CONVERGENT_CHARGING
📖
Authentication
https://help.sap.com/docs/SAP_CONVERGENT_CHARGING/authentication
📖
Documentation
https://help.sap.com/docs/SAP_CONVERGENT_INVOICING
📖
Documentation
https://help.sap.com/docs/SAP_SUBSCRIPTION_BILLING
📖
GettingStarted
https://help.sap.com/doc/13f339973aee49e4a59f153b3c8299d8/2025-12-15/en-US/SAP_Subscription_Billing_API_Guide.pdf
📖
Documentation
https://help.sap.com/docs/SAP_CONTRACT_ACCOUNTS_RECEIVABLE_PAYABLE
📖
Documentation
https://help.sap.com/docs/SAP_BRIM_USAGE_DATA_INTAKE
📖
Documentation
https://help.sap.com/docs/SAP_REVENUE_ACCOUNTING_REPORTING

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sap-brim-billing-and-revenue-innovation-management/refs/heads/main/openapi/sap-brim-billing-and-revenue-innovation-management-plans-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sap-brim-billing-and-revenue-innovation-management/refs/heads/main/json-schema/sap-brim-subscription-schema.json

Other Resources

🔗
Sandbox
https://api.sap.com/api/convergent_invoicing/tryout
🔗
Console
https://api.sap.com/api/subscription_billing/console
🔗
Reference
https://api.sap.com/package/SAPHybrisRevenueCloud/rest
🔗
Integration Guide
https://help.sap.com/docs/SAP_FICA/integration
🔗
Technical Specifications
https://help.sap.com/docs/SAP_BRIM_USAGE_DATA_INTAKE/specs
🔗
Compliance Guide
https://help.sap.com/docs/SAP_REVENUE_ACCOUNTING_REPORTING/compliance

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sap-brim-billing-and-revenue-innovation-management-plans-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sap-brim-billing-and-revenue-innovation-management-plans-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SAP BRIM (Billing and Revenue Innovation Management) SAP…
  description: API for managing subscription lifecycle within the SAP BRIM (Billing and Revenue Innovation Management) suite. Supports creation, modification, renewal, suspension, and cancellation of subscriptions across various billing frequencies and subscription models including recurring, usage-based, and hybrid subscriptions.
  version: 1.0.0
  contact:
    name: SAP Support
    email: support@sap.com
    url: https://support.sap.com
  license:
    name: SAP Developer License
    url: https://www.sap.com/about/legal/terms-of-use.html
  termsOfService: https://www.sap.com/about/legal/terms-of-use.html
servers:
- url: https://api.sap.com/subscription-billing/v1
  description: SAP API Business Hub - Production
- url: https://sandbox.api.sap.com/subscription-billing/v1
  description: SAP API Business Hub - Sandbox
security:
- OAuth2:
  - read
  - write
- ApiKeyAuth: []
tags:
- name: Plans
  description: Subscription plan and offer catalog management
paths:
  /plans:
    get:
      operationId: listPlans
      summary: SAP BRIM (Billing and Revenue Innovation Management) List subscription plans
      description: Retrieves a paginated list of available subscription plans from the product catalog.
      tags:
      - Plans
      parameters:
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Limit'
      - name: status
        in: query
        schema:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - DRAFT
      - name: billingFrequency
        in: query
        schema:
          type: string
          enum:
          - MONTHLY
          - QUARTERLY
          - SEMI_ANNUAL
          - ANNUAL
          - CUSTOM
      responses:
        '200':
          description: List of plans
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Plan'
                  totalCount:
                    type: integer
                  offset:
                    type: integer
                  limit:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      operationId: createPlan
      summary: SAP BRIM (Billing and Revenue Innovation Management) Create a subscription plan
      description: Creates a new subscription plan in the product catalog with pricing, billing frequency, and included items.
      tags:
      - Plans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanCreate'
      responses:
        '201':
          description: Plan created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: Plan with the same identifier already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /plans/{planId}:
    get:
      operationId: getPlan
      summary: SAP BRIM (Billing and Revenue Innovation Management) Get a subscription plan
      description: Retrieves details of a specific subscription plan.
      tags:
      - Plans
      parameters:
      - $ref: '#/components/parameters/PlanId'
      responses:
        '200':
          description: Plan details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    put:
      operationId: updatePlan
      summary: SAP BRIM (Billing and Revenue Innovation Management) Update a subscription plan
      description: Updates an existing subscription plan. Changes do not affect existing subscriptions unless explicitly propagated.
      tags:
      - Plans
      parameters:
      - $ref: '#/components/parameters/PlanId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlanCreate'
      responses:
        '200':
          description: Plan updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plan'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      operationId: deletePlan
      summary: SAP BRIM (Billing and Revenue Innovation Management) Delete a subscription plan
      description: Deletes a subscription plan. Only DRAFT or INACTIVE plans with no active subscriptions can be deleted.
      tags:
      - Plans
      parameters:
      - $ref: '#/components/parameters/PlanId'
      responses:
        '204':
          description: Plan deleted
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    PlanId:
      name: planId
      in: path
      required: true
      description: Unique identifier of the subscription plan
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        default: 20
        minimum: 1
        maximum: 100
    Offset:
      name: offset
      in: query
      description: Number of items to skip for pagination
      schema:
        type: integer
        default: 0
        minimum: 0
  responses:
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    PlanCreate:
      type: object
      required:
      - name
      - billingFrequency
      - price
      properties:
        name:
          type: string
        description:
          type: string
        billingFrequency:
          type: string
          enum:
          - MONTHLY
          - QUARTERLY
          - SEMI_ANNUAL
          - ANNUAL
          - CUSTOM
        price:
          $ref: '#/components/schemas/MonetaryAmount'
        setupFee:
          $ref: '#/components/schemas/MonetaryAmount'
        trialPeriodDays:
          type: integer
          minimum: 0
          default: 0
        contractTermMonths:
          type: integer
        autoRenewDefault:
          type: boolean
          default: true
        features:
          type: array
          items:
            type: string
    MonetaryAmount:
      type: object
      required:
      - value
      - currency
      properties:
        value:
          type: number
          format: double
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: ISO 4217 currency code
    Plan:
      type: object
      properties:
        planId:
          type: string
        name:
          type: string
        description:
          type: string
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - DRAFT
        billingFrequency:
          type: string
          enum:
          - MONTHLY
          - QUARTERLY
          - SEMI_ANNUAL
          - ANNUAL
          - CUSTOM
        price:
          $ref: '#/components/schemas/MonetaryAmount'
        setupFee:
          $ref: '#/components/schemas/MonetaryAmount'
        trialPeriodDays:
          type: integer
          minimum: 0
        contractTermMonths:
          type: integer
          description: Minimum contract term in months
        autoRenewDefault:
          type: boolean
        includedItems:
          type: array
          items:
            type: object
            properties:
              productId:
                type: string
              productName:
                type: string
              quantity:
                type: integer
              billingType:
                type: string
                enum:
                - RECURRING
                - ONE_TIME
                - USAGE_BASED
        features:
          type: array
          items:
            type: string
          description: List of features included in this plan
        createdAt:
          type: string
          format: date-time
        modifiedAt:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            target:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.sap.com/oauth/token
          scopes:
            read: Read access to subscription resources
            write: Write access to subscription resources
    ApiKeyAuth:
      type: apiKey
      in: header
      name: APIKey