{
  "opencollection": "1.0.0",
  "info": {
    "name": "SAP BRIM (Billing and Revenue Innovation Management) SAP BRIM Convergent Charging Balances Subscriptions 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": "Subscriptions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) List subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sap.com/convergent-charging/v1/subscriptions",
            "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": "customerId",
                "value": "",
                "type": "query",
                "description": "Filter by customer identifier"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by subscription status"
              },
              {
                "name": "planId",
                "value": "",
                "type": "query",
                "description": "Filter by subscription plan"
              },
              {
                "name": "createdFrom",
                "value": "",
                "type": "query"
              },
              {
                "name": "createdTo",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a paginated list of subscriptions. Supports filtering by customer, status, plan, and date range."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Create a subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/subscriptions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new subscription for a customer. Associates the subscription with a plan, sets the billing frequency, and initializes the subscription lifecycle."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Get a subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sap.com/convergent-charging/v1/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the subscription"
              }
            ]
          },
          "docs": "Retrieves detailed information about a specific subscription, including its items, billing history, and current status."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Update a subscription",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.sap.com/convergent-charging/v1/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the subscription"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing subscription. Supports modifying billing details, metadata, and other configurable attributes. Plan changes should use the dedicated change-plan endpoint."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Delete a subscription",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sap.com/convergent-charging/v1/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the subscription"
              }
            ]
          },
          "docs": "Permanently removes a subscription. Only PENDING or CANCELLED subscriptions can be deleted. Active subscriptions must be cancelled first."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Activate a subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/subscriptions/:subscriptionId/activate",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the subscription"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Activates a PENDING or SUSPENDED subscription, starting or resuming the billing cycle."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Suspend a subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/subscriptions/:subscriptionId/suspend",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the subscription"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Temporarily suspends an active subscription. Billing is paused during the suspension period. The subscription can be reactivated later."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Cancel a subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/subscriptions/:subscriptionId/cancel",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the subscription"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Cancels an active or suspended subscription. Supports immediate cancellation or end-of-term cancellation."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Renew a subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/subscriptions/:subscriptionId/renew",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the subscription"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Manually triggers the renewal of a subscription. Useful for subscriptions that do not auto-renew or for early renewal requests."
        },
        {
          "info": {
            "name": "SAP BRIM (Billing and Revenue Innovation Management) Change subscription plan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sap.com/convergent-charging/v1/subscriptions/:subscriptionId/change-plan",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier of the subscription"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Changes the plan associated with a subscription. Handles prorating, upgrade/downgrade logic, and billing adjustments automatically."
        }
      ]
    }
  ],
  "bundled": true
}