{
  "opencollection": "1.0.0",
  "info": {
    "name": "SAP BRIM (Billing and Revenue Innovation Management) SAP BRIM Convergent Charging API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://auth.sap.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Rating",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Rate a usage event",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/rating/rate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Rates a single usage event against the applicable pricing plan and returns the calculated charge. Supports real-time and batch rating scenarios."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Rate a batch of usage events",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/rating/rate-batch",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Rates multiple usage events in a single request for high-throughput scenarios. Returns individual rating results for each event."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Simulate rating without committing",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/rating/simulate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Simulates the rating of a usage event without persisting the result. Useful for quote generation and what-if analysis."
        }
      ]
    },
    {
      "info": {
        "name": "Charging",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Charge an account",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/charging/charge",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Executes a real-time charge against a subscriber account. Supports prepaid balance deduction and postpaid charge accumulation."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Refund a previous charge",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/charging/refund",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Processes a full or partial refund for a previously executed charge. Restores prepaid balances or creates credit adjustments for postpaid."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Authorize a charge reservation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/charging/authorize",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Reserves an amount against a prepaid balance without executing the final charge. The reservation can later be confirmed or released."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Confirm a charge authorization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/charging/authorize/:authorizationId/confirm",
            "params": [
              {
                "name": "authorizationId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the charge authorization"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Confirms a previously created authorization, converting the reserved amount into a final charge."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Release a charge authorization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/charging/authorize/:authorizationId/release",
            "params": [
              {
                "name": "authorizationId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the charge authorization"
              }
            ]
          },
          "docs": "Releases a previously created authorization, restoring the reserved amount to the available balance."
        }
      ]
    },
    {
      "info": {
        "name": "Pricing",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) List pricing plans",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sap.com/convergent-charging/v1/pricing/plans",
            "params": [
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Number of items to skip for pagination"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return"
              },
              {
                "name": "status",
                "value": "",
                "type": "query"
              },
              {
                "name": "serviceType",
                "value": "",
                "type": "query"
              },
              {
                "name": "effectiveDate",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a paginated list of pricing plans. Supports filtering by status, service type, and effective date."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Create a pricing plan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/pricing/plans",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new pricing plan with associated rate cards and pricing tiers."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Get a pricing plan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sap.com/convergent-charging/v1/pricing/plans/:planId",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the pricing plan"
              }
            ]
          },
          "docs": "Retrieves the details of a specific pricing plan by its identifier."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Update a pricing plan",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sap.com/convergent-charging/v1/pricing/plans/:planId",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the pricing plan"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing pricing plan. Only DRAFT plans can be fully updated; ACTIVE plans support limited modifications."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Delete a pricing plan",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sap.com/convergent-charging/v1/pricing/plans/:planId",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the pricing plan"
              }
            ]
          },
          "docs": "Deletes a pricing plan. Only DRAFT or INACTIVE plans can be deleted."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) List rate cards for a pricing plan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sap.com/convergent-charging/v1/pricing/plans/:planId/rate-cards",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the pricing plan"
              }
            ]
          },
          "docs": "Retrieves all rate cards associated with a pricing plan."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Add a rate card to a pricing plan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/pricing/plans/:planId/rate-cards",
            "params": [
              {
                "name": "planId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the pricing plan"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new rate card and associates it with the specified pricing plan. Rate cards define the unit prices and tier structures."
        }
      ]
    },
    {
      "info": {
        "name": "Balances",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Get account balance",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sap.com/convergent-charging/v1/balances/:accountId",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the subscriber account"
              }
            ]
          },
          "docs": "Retrieves the current balance information for a subscriber account, including available balance, reserved amounts, and credit limits."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Top up account balance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/balances/:accountId/topup",
            "params": [
              {
                "name": "accountId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the subscriber account"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds funds to a prepaid account balance."
        }
      ]
    },
    {
      "info": {
        "name": "Usage Events",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Submit a usage event",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/usage-events",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submits a usage event for rating and charging. The event is processed against the applicable pricing plan."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Get usage event status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sap.com/convergent-charging/v1/usage-events/:eventId",
            "params": [
              {
                "name": "eventId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves the processing status and details of a previously submitted usage event."
        }
      ]
    }
  ],
  "bundled": true
}