SAP BRIM (Billing and Revenue Innovation Management)

SAP BRIM (Billing and Revenue Innovation Management) Charging API

Real-time charging operations for prepaid and postpaid accounts

GitHub OpenAPI

Operations 5

POST /charging/charge SAP BRIM (Billing and Revenue Innovation Management) Charge an account #
POST /charging/refund SAP BRIM (Billing and Revenue Innovation Management) Refund a previous charge #
POST /charging/authorize SAP BRIM (Billing and Revenue Innovation Management) Authorize a charge reservation #
POST /charging/authorize/{authorizationId}/confirm SAP BRIM (Billing and Revenue Innovation Management) Confirm a charge authorization #
POST /charging/authorize/{authorizationId}/release SAP BRIM (Billing and Revenue Innovation Management) Release a charge authorization #

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-charging-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-charging-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-charging-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SAP BRIM (Billing and Revenue Innovation Management) SAP BRIM Convergent Balances Charging API
  description: API for real-time charging and rating of usage-based services within the SAP BRIM (Billing and Revenue Innovation Management) suite. Supports complex pricing models, prepaid and postpaid scenarios, tiered and volume-based pricing, and real-time balance management.
  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/convergent-charging/v1
  description: SAP API Business Hub - Production
- url: https://sandbox.api.sap.com/convergent-charging/v1
  description: SAP API Business Hub - Sandbox
security:
- OAuth2:
  - read
  - write
- ApiKeyAuth: []
tags:
- name: Charging
  description: Real-time charging operations for prepaid and postpaid accounts
paths:
  /charging/charge:
    post:
      operationId: chargeAccount
      summary: SAP BRIM (Billing and Revenue Innovation Management) Charge an account
      description: Executes a real-time charge against a subscriber account. Supports prepaid balance deduction and postpaid charge accumulation.
      tags:
      - Charging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChargingRequest'
      responses:
        '200':
          description: Charge executed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargingResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: Insufficient balance for prepaid charge
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /charging/refund:
    post:
      operationId: refundCharge
      summary: SAP BRIM (Billing and Revenue Innovation Management) Refund a previous charge
      description: Processes a full or partial refund for a previously executed charge. Restores prepaid balances or creates credit adjustments for postpaid.
      tags:
      - Charging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefundRequest'
      responses:
        '200':
          description: Refund processed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /charging/authorize:
    post:
      operationId: authorizeCharge
      summary: SAP BRIM (Billing and Revenue Innovation Management) Authorize a charge reservation
      description: Reserves an amount against a prepaid balance without executing the final charge. The reservation can later be confirmed or released.
      tags:
      - Charging
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthorizationRequest'
      responses:
        '200':
          description: Authorization successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: Insufficient balance for authorization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /charging/authorize/{authorizationId}/confirm:
    post:
      operationId: confirmAuthorization
      summary: SAP BRIM (Billing and Revenue Innovation Management) Confirm a charge authorization
      description: Confirms a previously created authorization, converting the reserved amount into a final charge.
      tags:
      - Charging
      parameters:
      - $ref: '#/components/parameters/AuthorizationId'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                finalAmount:
                  $ref: '#/components/schemas/MonetaryAmount'
      responses:
        '200':
          description: Authorization confirmed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChargingResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /charging/authorize/{authorizationId}/release:
    post:
      operationId: releaseAuthorization
      summary: SAP BRIM (Billing and Revenue Innovation Management) Release a charge authorization
      description: Releases a previously created authorization, restoring the reserved amount to the available balance.
      tags:
      - Charging
      parameters:
      - $ref: '#/components/parameters/AuthorizationId'
      responses:
        '200':
          description: Authorization released
          content:
            application/json:
              schema:
                type: object
                properties:
                  authorizationId:
                    type: string
                  status:
                    type: string
                    enum:
                    - RELEASED
                  releasedAt:
                    type: string
                    format: date-time
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    AuthorizationResponse:
      type: object
      properties:
        authorizationId:
          type: string
          format: uuid
        accountId:
          type: string
        reservedAmount:
          $ref: '#/components/schemas/MonetaryAmount'
        status:
          type: string
          enum:
          - AUTHORIZED
          - EXPIRED
          - CONFIRMED
          - RELEASED
        expiresAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
    MonetaryAmount:
      type: object
      required:
      - value
      - currency
      properties:
        value:
          type: number
          format: double
          description: The monetary value
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: ISO 4217 currency code
    RefundResponse:
      type: object
      properties:
        refundId:
          type: string
          format: uuid
        originalChargeId:
          type: string
          format: uuid
        amount:
          $ref: '#/components/schemas/MonetaryAmount'
        status:
          type: string
          enum:
          - COMPLETED
          - PENDING
        refundedAt:
          type: string
          format: date-time
    AuthorizationRequest:
      type: object
      required:
      - accountId
      - amount
      properties:
        accountId:
          type: string
        amount:
          $ref: '#/components/schemas/MonetaryAmount'
        expiresIn:
          type: integer
          description: Authorization expiry in seconds
          default: 3600
        serviceType:
          type: string
        description:
          type: string
    RefundRequest:
      type: object
      required:
      - originalChargeId
      properties:
        originalChargeId:
          type: string
          format: uuid
          description: Identifier of the original charge to refund
        amount:
          $ref: '#/components/schemas/MonetaryAmount'
        reason:
          type: string
          description: Reason for the refund
    ChargingResponse:
      type: object
      properties:
        chargeId:
          type: string
          format: uuid
        accountId:
          type: string
        amount:
          $ref: '#/components/schemas/MonetaryAmount'
        chargeType:
          type: string
          enum:
          - PREPAID
          - POSTPAID
        status:
          type: string
          enum:
          - COMPLETED
          - PENDING
          - FAILED
        remainingBalance:
          $ref: '#/components/schemas/MonetaryAmount'
        chargedAt:
          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
    ChargingRequest:
      type: object
      required:
      - accountId
      - amount
      - chargeType
      properties:
        accountId:
          type: string
          description: Account to charge
        amount:
          $ref: '#/components/schemas/MonetaryAmount'
        chargeType:
          type: string
          enum:
          - PREPAID
          - POSTPAID
          description: Charging model
        serviceType:
          type: string
        description:
          type: string
        externalReference:
          type: string
          description: External transaction reference
        metadata:
          type: object
          additionalProperties:
            type: string
  responses:
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    AuthorizationId:
      name: authorizationId
      in: path
      required: true
      description: Unique identifier of the charge authorization
      schema:
        type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.sap.com/oauth/token
          scopes:
            read: Read access to charging and rating resources
            write: Write access to charging and rating resources
    ApiKeyAuth:
      type: apiKey
      in: header
      name: APIKey