SAP BRIM (Billing and Revenue Innovation Management)

opencollection: 1.0.0
info:
  name: SAP BRIM (Billing and Revenue Innovation Management) SAP BRIM Subscription Billing 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/subscription-billing/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/subscription-billing/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/subscription-billing/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/subscription-billing/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/subscription-billing/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/subscription-billing/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/subscription-billing/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/subscription-billing/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/subscription-billing/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/subscription-billing/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.
- info:
    name: Subscription Items
    type: folder
  items:
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) List subscription items
      type: http
    http:
      method: GET
      url: https://api.sap.com/subscription-billing/v1/subscriptions/:subscriptionId/items
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Unique identifier of the subscription
    docs: Retrieves all items within a subscription, including their quantities, pricing, and status.
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Add an item to a subscription
      type: http
    http:
      method: POST
      url: https://api.sap.com/subscription-billing/v1/subscriptions/:subscriptionId/items
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Unique identifier of the subscription
      body:
        type: json
        data: '{}'
    docs: Adds a new line item to an existing subscription. The item is billed according to the subscription billing cycle.
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Get a subscription item
      type: http
    http:
      method: GET
      url: https://api.sap.com/subscription-billing/v1/subscriptions/:subscriptionId/items/:itemId
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Unique identifier of the subscription
      - name: itemId
        value: ''
        type: path
        description: Unique identifier of the subscription item
    docs: Retrieves details of a specific item within a subscription.
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Update a subscription item
      type: http
    http:
      method: PATCH
      url: https://api.sap.com/subscription-billing/v1/subscriptions/:subscriptionId/items/:itemId
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Unique identifier of the subscription
      - name: itemId
        value: ''
        type: path
        description: Unique identifier of the subscription item
      body:
        type: json
        data: '{}'
    docs: Updates the quantity or configuration of a subscription item.
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Remove a subscription item
      type: http
    http:
      method: DELETE
      url: https://api.sap.com/subscription-billing/v1/subscriptions/:subscriptionId/items/:itemId
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Unique identifier of the subscription
      - name: itemId
        value: ''
        type: path
        description: Unique identifier of the subscription item
    docs: Removes an item from a subscription. Prorated credits may be applied to the next billing cycle.
- info:
    name: Billing
    type: folder
  items:
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Get subscription billing history
      type: http
    http:
      method: GET
      url: https://api.sap.com/subscription-billing/v1/subscriptions/:subscriptionId/billing-history
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Unique identifier of the subscription
      - 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
    docs: Retrieves the billing history for a subscription, including all generated invoices and payment records.
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Generate an invoice for a subscription
      type: http
    http:
      method: POST
      url: https://api.sap.com/subscription-billing/v1/subscriptions/:subscriptionId/generate-invoice
      params:
      - name: subscriptionId
        value: ''
        type: path
        description: Unique identifier of the subscription
      body:
        type: json
        data: '{}'
    docs: Manually triggers invoice generation for a subscription outside of the normal billing cycle. Useful for ad-hoc or
      on-demand billing.
- info:
    name: Plans
    type: folder
  items:
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) List subscription plans
      type: http
    http:
      method: GET
      url: https://api.sap.com/subscription-billing/v1/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: billingFrequency
        value: ''
        type: query
    docs: Retrieves a paginated list of available subscription plans from the product catalog.
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Create a subscription plan
      type: http
    http:
      method: POST
      url: https://api.sap.com/subscription-billing/v1/plans
      body:
        type: json
        data: '{}'
    docs: Creates a new subscription plan in the product catalog with pricing, billing frequency, and included items.
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Get a subscription plan
      type: http
    http:
      method: GET
      url: https://api.sap.com/subscription-billing/v1/plans/:planId
      params:
      - name: planId
        value: ''
        type: path
        description: Unique identifier of the subscription plan
    docs: Retrieves details of a specific subscription plan.
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Update a subscription plan
      type: http
    http:
      method: PUT
      url: https://api.sap.com/subscription-billing/v1/plans/:planId
      params:
      - name: planId
        value: ''
        type: path
        description: Unique identifier of the subscription plan
      body:
        type: json
        data: '{}'
    docs: Updates an existing subscription plan. Changes do not affect existing subscriptions unless explicitly propagated.
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Delete a subscription plan
      type: http
    http:
      method: DELETE
      url: https://api.sap.com/subscription-billing/v1/plans/:planId
      params:
      - name: planId
        value: ''
        type: path
        description: Unique identifier of the subscription plan
    docs: Deletes a subscription plan. Only DRAFT or INACTIVE plans with no active subscriptions can be deleted.
- info:
    name: Customers
    type: folder
  items:
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) List subscriptions for a customer
      type: http
    http:
      method: GET
      url: https://api.sap.com/subscription-billing/v1/customers/:customerId/subscriptions
      params:
      - name: customerId
        value: ''
        type: path
        description: Unique identifier of the customer
      - 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
    docs: Retrieves all subscriptions belonging to a specific customer.
  - info:
      name: SAP BRIM (Billing and Revenue Innovation Management) Get billing summary for a customer
      type: http
    http:
      method: GET
      url: https://api.sap.com/subscription-billing/v1/customers/:customerId/billing-summary
      params:
      - name: customerId
        value: ''
        type: path
        description: Unique identifier of the customer
    docs: Retrieves a billing summary across all of a customer's subscriptions, including outstanding amounts, next billing
      dates, and payment status.
bundled: true