OCS.io

OCS.io Documentation

    • Overview
      • Architecture
        • Typical Integration
        • Microservices Deployment
      • Key Entities
      • Fundamentals
        • Account Payable
        • Account Receivable
        • Back Dating
        • Balance Management
        • Bill Cycles
          • Bill Cycle Change
        • Bill Shock Prevention
        • Billing and Invoicing
          • Billing
          • Invoicing
          • Create OCS Invoice
          • Preview of the Invoice
          • Control Groups
          • On-Demand Billing
        • Charging Classes
        • Data Streaming
        • Discounting
        • Event Data Records (EDRs)
        • External Notifications
        • General Ledger
        • Individual Offers
        • Minimal Commitment
        • Multi-Currency
        • Multi-Tenancy
        • Number Portability
        • Pending State Management
        • Pro-Rating
        • Product Catalogue
        • Rating and Charging
        • Segmentation
        • Taxation
        • Time Zones
      • Service Catalogue
        • Fees
          • Activation Fee
          • Suspend Fee
          • Reactivation Fee
          • Deactivation Fee
          • Offer Subscription Fee
          • One-Time Fee
          • Recurrent Fee
        • Balances
          • Balance
          • Recurrent Balance
          • Monetary Balance
          • Recurrent Monetary Balance
          • Cost Control Balance
          • Recurrent Cost Control Balance
          • Tiered Charge
          • Recurrent Tiered Charge
        • Discounts
          • Absolute Discount
          • Absolute Time Discount
          • Percentage Discount
          • Percentage Time Discount
        • Billing
          • Absolute Billing Discount
          • Percentage Billing Discount
          • Minimal Spent
          • Maximal Spent
        • Usage Based
          • Simple Charging
          • Pre-Charged Events
          • Revenue Share
        • Add-Ons
          • Charge Override
          • Unit Charge Override
          • Usage Barring
          • Product / Offer Opt-Out
        • Content
          • Content
        • Licensing
          • Volume License
        • Telco
          • Voice
          • SMS
          • MMS
          • Packet Data
          • Friends & Family
          • VPN
      • Typical Deployments
        • Subscription-Based
        • Telco
        • Content and Media
        • Loyalty Points
        • Shared Economy
        • Transportation Deployment
        • EV Charging
        • Utility
    • Tutorials
      • Getting Started
        • Register to OCS.io
        • Minimal Configuration - OCS.io Core
        • Minimal Configuration - Product Catalogue
        • Minimal Configuration - Billing & Invoicing
        • Minimal Configuration - Customer, Account & Subscription Management
    • Configuration Guide
      • Core Configuration
        • General
        • Rating & Charging
        • Product Catalogue
        • Billing & Invoicing
        • Revenue Management
      • Integration Configuration
        • Platform
        • Customer, Account & Subscription Management
        • Rating and Charging
        • Revenue Management
      • Service Catalogue
        • Fees
          • Activation Fee
          • Suspend Fee
          • Reactivation Fee
          • Deactivation Fee
          • One-Time Fee
          • Recurrent Fee
        • Balances
          • Balance
          • Recurrent Balance
          • Monetary Balance
          • Recurrent Monetary Balance
          • Cost Control Balance
          • Recurrent Cost Control Balance
          • Time Balance
          • Time Monetary Balance
          • Tiered Charge
          • Recurrent Tiered Charge
        • Discounts
          • Absolute Discount
          • Percentage Discount
        • Billing
          • Absolute Billing Discount
          • Percentage Billing Discount
          • Minimal Spent
          • Maximal Spent
        • Usage
          • Simple Charging
          • Pre-Charged Events
          • Revenue Share
        • Add-Ons
          • Charge Override
          • Usage Barring
        • Content Services
          • Content
        • Licensing Services
          • Volume License
        • Telco Services
          • Voice
          • SMS
          • MMS
          • Packet Data
          • Friends & Family
          • VPN
    • Implemented Use-Cases
      • CRM Integration
        • Customer Management
          • Create Customer
          • Update Customer
            • Update Customer’s External ID
            • Update Customer’s Custom Name
            • Update Customer’s Custom Attributes
            • Update Customer’s Segment
          • Create Subscription on Customer
        • Account Management
          • Create Account
          • Update Account
            • Update Account’s External ID
            • Update Account’s Custom Name
            • Update Account’s Custom Attributes
            • Update Account’s Segment
          • Create Subscription on Account
          • Update Account’s Bill Cycle
          • Update Account’s Tax Exemption
        • Subscriber Management
          • Create Subscriber
          • Update Subscriber
            • Update Subscriber’s External ID
            • Update Subscriber’s Custom Name
            • Update Subscriber’s Custom Attributes
            • Update Subscriber’s Segment
          • Create Subscription on Subscriber
          • Create Subscriber Resource
          • SWAP Subscriber Resource
        • Subscription Management
          • Update Subscription
            • Update Subscription’s External ID
            • Update Subscription’s Custom Name
            • Update Subscription’s Custom Attributes
        • Individual Offer Management
          • Create Individual Offer Subscription
          • Create Balance Subscription
          • Create Monetary Balance Subscription
          • Create One-Time Fee Subscription
          • Create Recurrent Fee Subscription
          • Create Absolute Discount Subscription
          • Create Percentage Discount Subscription
          • Create Absolute Billing Discount Subscription
          • Create Percentage Billing Discount Subscription
        • Balance Management
          • Update Subscription Balance
          • Update Subscription Balances
      • Revenue Management Integration
        • Payer Management
          • Update Payer
          • Update Due Date Offset
          • Update Invoicing Flag
          • Read Open Balance
          • Read Collection Balance
          • Read Payment Moral
        • Document Management
          • Create Corrective Tax Document
          • Create Deposit
          • Create Generic Invoice
          • Create Proforma Invoice
          • Create Reciprocal Commitment
          • Create Document of Any Type
          • Create Document With Lines of Any Type
          • Assign Document Credit To Document
          • Cancel Document Credit Assignment
          • Cancel Document
          • Pay Document On-Line
          • Read Document
        • Payment Management
          • Assign Incoming Payment to Document
          • Cancel Incoming Payment Assignment
          • Cancel Incoming Payment Identification
          • Create Outgoing Payment by Incoming Payment
          • Create Outgoing Payment from Document Credit
          • Create Outgoing Payment from Incoming Payment
          • Identify Incoming Payment
          • Register Payment
          • Cancel Payment
        • Control Groups
          • Create/Read/Update/Delete Control Group
          • Manage Control Group
          • Perform Control Group Run
        • Billing and Invoicing
          • Preview OCS Invoice
          • Create OCS Invoice On-Demand
      • Revenue Management Processes
        • Account Balances
          • Calculate Open Balance
          • Calculate Collection Balance
          • Calculate Payment Moral
        • Payments
          • Cancel Promise to Pay
          • Pair Incoming Payment
          • Pair Outgoing Payment
        • Billing and Invoicing
          • Create OCS Invoice
          • Perform Control Group Run
          • Perform Bill Cycle Run
          • Perform Fix Errors
          • Perform On-Demand
      • File-Based Integration
    • Integration Guide
      • CRM Integration
        • Customer Management
          • Create Customer
          • Create Subscription on Customer
          • Update Customer’s External ID
          • Update Customer’s Custom Name
          • Update Customer’s Custom Attributes
          • Update Customer’s Segment
          • Update Customer’s State
          • Read Customer
        • Account Management
          • Create Account
          • Create Subscription on Account
          • Update Account’s External ID
          • Update Account’s Custom Name
          • Update Account’s Custom Attributes
          • Update Account’s Segment
          • Update Account’s State
          • Update Account’s Bill Cycle
          • Cancel Account’s Bill Cycle Change
          • Perform Account’s Bill Cycle Change
          • Update Account’s Tax Exemption
          • Read Account
        • Subscriber Management
          • Create Subscriber
          • Create Subscription on Subscriber
          • Update Subscriber’s External ID
          • Update Subscriber’s Custom Name
          • Update Subscriber’s Custom Attributes
          • Update Subscriber’s Segment
          • Update Subscriber’s State
          • Create Subscriber’s Resource
          • Swap Subscriber’s Resource
          • Read Subscriber’s Resource
          • Read Subscriber
        • Subscription Management
          • Update Subscription’s External ID
          • Update Subscription’s Custom Name
          • Update Subscription’s Custom Attributes
          • Update Subscription’s State
          • Read Subscription
        • Individual Offer Management
          • Create Individual Offer Subscription
          • Create Balance Subscription
          • Create Monetary Balance Subscription
          • Create One-Time Fee Subscription
          • Create Recurrent Fee Subscription
          • Create Absolute Discount Subscription
          • Create Percentage Discount Subscription
          • Create Absolute Billing Discount Subscription
          • Create Percentage Billing Discount Subscription
        • Balance Management
          • Read Subscription’s Balance
          • Read Subscription’s Balances
          • Update Subscription’s Balance
          • Update Subscription’s Balances
      • Revenue Management Integration
        • Payer Management
          • Update Payer
          • Update Payment Method
          • Update Delivery Method
          • Update Due Date Offset
          • Update Invoicing Flag
          • Read Open Balance
          • Read Collection Balance
          • Read Payment Moral
        • Document Management
          • Create Document of Any Type
          • Create Document With Lines of Any Type
          • Create Corrective Tax Document
          • Create Deposit
          • Create Generic Invoice
          • Create Proforma Invoice
          • Create Reciprocal Commitment
          • Assign Document Credit To Document
          • Cancel Document Credit Assignment
          • Cancel Document
          • Pay Document On-Line
          • Read Document
        • Payment Management
          • Assign Incoming Payment to Document
          • Cancel Incoming Payment Assignment
          • Cancel Incoming Payment Identification
          • Create Outgoing Payment by Incoming Payment
          • Create Outgoing Payment from Document Credit
          • Create Outgoing Payment from Incoming Payment
          • Identify Incoming Payment
          • Register Payment
        • Billing and Invoicing
          • Preview OCS Invoice
          • Create OCS Invoice On-Demand
          • Adjust Chargeable Event
        • Control Groups
          • CRUD Control Group
          • Manage Control Group
          • Perform Control Group Run
      • Integrating OCS.io with External Systems via Streaming Platform
        • Business Transactions
          • CASM
            • Customer
            • Account
            • Subscriber
            • Subscriber Resource
            • Offer Subscription
          • Revenue Management
            • Payer
            • Document
            • Payment
            • Payment History
            • Document Documents
            • Payment Documents
            • Document Payments
            • Payment Documents
            • Payment Payments
          • Charging
            • Balance
            • Chargeable Event
        • External Notifications
          • Charging
            • Balance First Event Notification
            • Balance Recurrence Notification
            • Balance Threshold Reached Notification
            • Balance Adjustment Notification
          • Invoicing Notifications Summary
            • Bill Cycle Start
            • Bill Cycle End
            • Account Billing Start
            • Account Billing End
            • Account Billing Failed
          • Revenue Management
            • Document Created
            • Document Open Balance Changed
            • Payment Received
            • Collection Start
            • Payment Moral Calculated
        • Formatter
          • Invoice Layouts
            • Document Layout
            • OCS Bill Run Invoice Layout
            • OCS Control Invoice Layout
            • OCS On-Demand Invoice Layout
    • Deployment Guide
      • Installation
        • Prerequisites
        • Google Cloud
        • Pull Deployment files
        • Environment Variables
        • Prepare Deployment files
          • Infrastructure
          • OCS.io Applications
          • NGINX [Optional]
        • Deploy
      • Logging
    • Operations & Maintenance Guide
      • Administration
        • CASM Configuration
        • RM Configuration
        • Invoicing Configuration
        • Implementation Generic Configuration
    • Logging
      • Customer, Account & Subscription Management
  • OCS.io Documentation
  • Integration Guide
  • CRM Integration
  • Balance Management
  • Read Subscription’s Balance

Read Subscription’s Balance

API Overview

Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when reading a subscription’s balance:

  • Offer Subscription must exist in the system.

Balance Management Read Subscription’s Balances

OCS.io

Copyright ©2025 OCS.io - All rights reserved