REST Services Manager API for Billing and Revenue Management

All REST Endpoints

Account Management/Bill Format

Creates, updates, and retrieves bill format information.

Create a Bill Format: Method: post
Path: /billFormat
Delete a Bill Format: Method: delete
Path: /billFormat/{id}
Get Bill Format by ID: Method: get
Path: /billFormat/{id}
Get Bill Format Entities: Method: get
Path: /billFormat
Partially Update a Bill Format: Method: patch
Path: /billFormat/{id}

Account Management/Bill Presentation Media

Creates, updates, and retrieves bill presentation media entities.

Create a Bill Presentation Media: Method: post
Path: /billPresentationMedia
Delete a Bill Presentation Media: Method: delete
Path: /billPresentationMedia/{id}
Get a Bill Presentation Media by ID: Method: get
Path: /billPresentationMedia/{id}
List or Find Bill Presentation Media: Method: get
Path: /billPresentationMedia
Partially Update a Bill Presentation Media: Method: patch
Path: /billPresentationMedia/{id}

Account Management/Billing Account

Creates, updates, and retrieves billing accounts.

Create a Billing Account: Method: post
Path: /billingAccount
Delete a Billing Account: Method: delete
Path: /billingAccount/{id}
Get a Billing Account by ID: Method: get
Path: /billingAccount/{id}
List or Find Billing Accounts: Method: get
Path: /billingAccount
Partially Update a Billing Account: Method: patch
Path: /billingAccount/{id}

Account Management/Billing Cycle Specification

Creates, updates, and retrieves billing cycle specifications.

Create a Billing Cycle Specification: Method: post
Path: /billingCycleSpecification
Delete a Billing Cycle Specification: Method: delete
Path: /billingCycleSpecification/{id}
Get a Billing Cycle Specification by ID: Method: get
Path: /billingCycleSpecification/{id}
List or Find Billing Cycle Specifications: Method: get
Path: /billingCycleSpecification
Partially Update a Billing Cycle Specification: Method: patch
Path: /billingCycleSpecification/{id}

Customer Bill Management/Applied Customer Billing Rate

Use for managing applied customer billing rates.

Get an Applied Customer Billing Rate by ID: Method: get
Path: /appliedCustomerBillingRate/{id}
Get Applied Customer Billing Rates: Method: get
Path: /appliedCustomerBillingRate

Customer Bill Management/Customer Bill

Use for managing customer bills.

Get a Customer Bill by ID: Method: get
Path: /customerBill/{id}
Get Customer Bills: Method: get
Path: /customerBill
Update a Customer Bill: Method: patch
Path: /customerBill/{id}

Customer Bill Management/Customer Bill Invoice

Use for managing invoices.

Get an Invoice PDF by Bill ID: Method: get
Path: /invoice/{id}

Customer Bill Management/Customer Bill On Demand

Use for managing on-demand customer bills.

Create a Customer Bill On Demand: Method: post
Path: /customerBillOnDemand
Get an On-Demand Customer Bill by ID: Method: get
Path: /customerBillOnDemand/{id}
Get On-Demand Customer Bills: Method: get
Path: /customerBillOnDemand

Notification Listeners

Use for managing notification events sent by external applications.

Client Listener for BillingAccountAttributeValueChangeEvent: Method: post
Path: /listener/billingAccountAttributeValueChangeEvent
Client Listener for BillingAccountCreateEvent: Method: post
Path: /listener/billingAccountCreateEvent
Client Listener for BillingAccountDeleteEvent: Method: post
Path: /listener/billingAccountDeleteEvent
Client Listener for BillingAccountStateChangeEvent: Method: post
Path: /listener/billingAccountStateChangeEvent
Client Listener for PartyAccountAttributeValueChangeEvent: Method: post
Path: /listener/partyAccountAttributeValueChangeEvent
Client Listener for PartyAccountCreateEvent: Method: post
Path: /listener/partyAccountCreateEvent
Client Listener for PartyAccountDeleteEvent: Method: post
Path: /listener/partyAccountDeleteEvent
Client Listener for PartyAccountStateChangeEvent: Method: post
Path: /listener/partyAccountStateChangeEvent
Create Client Listener for ProductAttributeValueChangeEvent: Method: post
Path: /listener/ProductAttributeValueChangeEvent
Create Client Listener for ProductCreateEvent: Method: post
Path: /listener/productCreateEvent
Create Client Listener for ProductDeleteEvent: Method: post
Path: /listener/productDeleteEvent
Create Client Listener for ProductStateChangeEvent: Method: post
Path: /listener/productStateChangeEvent

Order Billing Fulfillment

Perform Billing Fulfillment: Method: post
Path: /createFulfillBilling

Payment Management/Payment

Use to manage payments.

Create a Payment: Method: post
Path: /payment
Create a Payment Allocation for a Bill: Method: post
Path: /paymentAllocation
Get a Payment by ID: Method: get
Path: /payment/{id}
Get Payments: Method: get
Path: /payment

Payment Management/Refund

Use to manage refunds.

Create a Refund: Method: post
Path: /refund
Get a Refund by ID: Method: get
Path: /refund/{id}
Get Refunds: Method: get
Path: /refund

Payment Method Management

Use for managing payment methods.

Create a Payment Method: Method: post
Path: /paymentMethod
Delete a Payment Method: Method: delete
Path: /paymentMethod/{paymentMethodId}
Get a Payment Method by ID: Method: get
Path: /paymentMethod/{paymentMethodId}
Get Payment Methods: Method: get
Path: /paymentMethod
Get Payment Methods for an Account: Method: get
Path: /accounts/{accountId}/paymentMethods

Prepay Balance Management/Accumulated Balances

Use for managing accumulated balances.

Get Accumulated Balances: Method: get
Path: /accumulatedBalance
Get an Accumulated Balance by ID: Method: get
Path: /accumulatedBalance/{id}

Prepay Balance Management/Adjusted Balances

Use for managing adjusted balances.

Create an Adjusted Balance: Method: post
Path: /adjustBalance
Get Adjusted Balances: Method: get
Path: /adjustBalance
Get an Adjusted Balance by ID: Method: get
Path: /adjustBalance/{id}

Prepay Balance Management/Balance Actions

Use for managing balance actions.

Get a Balance Action by ID: Method: get
Path: /balanceAction/{id}
Get Balance Actions: Method: get
Path: /balanceAction

Prepay Balance Management/Bucket Balances

Use for managing bucket balances.

Create a Bucket: Method: post
Path: /bucket
Get Bucket Balances: Method: get
Path: /bucket
Get Bucket Balances by ID: Method: get
Path: /bucket/{id}
Update a Bucket Threshold for an Account: Method: put
Path: /bucket/adjustThreshold/{accountId}

Prepay Balance Management/Disputed Balances

Use for managing disputed balances.

Create a Disputed Balance: Method: post
Path: /disputeBalance
Get a Disputed Balance by ID: Method: get
Path: /disputeBalance/{id}
Get Disputed Balances: Method: get
Path: /disputeBalance

Prepay Balance Management/Top-up Balances

Use for managing top-up balances.

Create a Top-up Balance: Method: post
Path: /topupBalance
Delete a Top-up Balance: Method: delete
Path: /topupBalance/{id}
Get a Top-up Balance by ID: Method: get
Path: /topupBalance/{id}
Get Top-up Balances: Method: get
Path: /topupBalance
Update a Top-up Balance: Method: patch
Path: /topupBalance/{id}

Prepay Balance Management/Transfer Balances

Use for managing transfer balances.

Create a Transfer Balance: Method: post
Path: /transferBalance
Get a Transfer Balance by ID: Method: get
Path: /transferBalance/{id}
Get Transfer Balances: Method: get
Path: /transferBalance

Product Inventory Management

Creates, retrieves, updates, and deletes product inventory information.

Create a Product: Method: post
Path: /product
Delete a Product by ID: Method: delete
Path: /product/{id}
Get a Product by ID: Method: get
Path: /product/{id}
List or Find Products: Method: get
Path: /product
Partially Update a Product by ID: Method: patch
Path: /product/{id}

Usage Management

Use for managing usage.

Get Usage: Method: get
Path: /usage
Get Usage by ID: Method: get
Path: /usage/{id}