• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Use cURL
• Authenticate
• Send Requests
• Extend the BRM REST Services Manager Framework
  • Setting Up Extensions
  • Query Parameter Extensions
  • Request Payload Extensions
  • Response Payload Extensions
• Retrieve Endpoint Metadata
• Reference
  • Status Codes
  • Error Messages

Tasks

• Account Management
  • Get a Billing Cycle Specification by ID
  • Get Billing Cycle Specifications
  • Notification Listeners
    • Create an Account from a PartyAccountCreateEvent Notification
    • Update an Account from a PartyAccountAttributeValueChangeEvent Notification
• Customer Bill Management
  • Applied Customer Billing Rate
    • Get an Applied Customer Billing Rate by ID
    • Get Applied Customer Billing Rates
  • Customer Bill
    • Get a Customer Bill by ID
    • Get Customer Bills
    • Update a Customer Bill
  • Customer Bill On Demand
    • Create a Customer Bill On Demand
    • Get an On-Demand Customer Bill by ID
    • Get On-Demand Customer Bills
  • Invoice
    • Get an Invoice PDF by Bill ID
• Order Billing Fulfillment
  • Perform Billing Fulfillment
• Payment Management
  • Payment
    • Create a Payment
    • Create a Payment Allocation for a Bill
    • Get a Payment by ID
    • Get Payments
  • Refund
    • Create a Refund
    • Get a Refund by ID
    • Get Refunds
• Payment Method Management
  • Create a Payment Method
  • Delete a Payment Method
  • Get a Payment Method by ID
  • Get Payment Methods
  • Get Payment Methods for an Account
• Prepay Balance Management
  • Accumulated Balances
    • Get Accumulated Balances
    • Get an Accumulated Balance by ID
  • Adjusted Balances
    • Create an Adjusted Balance
    • Get Adjusted Balances
    • Get an Adjusted Balance by ID
  • Balance Actions
    • Get a Balance Action by ID
    • Get Balance Actions
  • Bucket Balances
    • Create a Bucket
    • Get Bucket Balances
    • Get Bucket Balances by ID
    • Update a Bucket Threshold for an Account
  • Disputed Balances
    • Create a Disputed Balance
    • Get a Disputed Balance by ID
    • Get Disputed Balances
  • Top-up Balances
    • Create a Top-up Balance
    • Get a Top-up Balance by ID
    • Get Top-up Balances
  • Transfer Balances
    • Create a Transfer Balance
    • Get a Transfer Balance by ID
    • Get Transfer Balances
• Usage Management
  • Get Usage
  • Get Usage by ID