Monetization Web Docs | Tridens Technology –

Docs: Customers

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select Analytics, and click Customers.

The customer analytics section is divided into two subsections:

First subsection
Second subsection

First subsection

The first subsection shows the number of newly activated customers. The information is based on the current month, a month ago, six months ago, and a year ago.

For example, assume the current month is April, and there a no new customers added. Last month in March, two customers were added. Six months ago, in October last year, no new customer was added.

Note:

The red or green arrow shows the percentage decrease or increase respectively in the number of newly activated customers at the moment against the same time a month ago, six months ago, and a year ago.

Second subsection

The second subsection shows a bar chart representing the number of newly activated and deactivated customers from a specific period based on an interval, including the churn rate. You can filter by customer type or/and date-time.

Information:

The churn rate refers to the rate of “leaving” customers.

Note:

The visual representation in the form of a bar chart can be downloaded in various formats. To achieve this, click Chart context menu.

Docs: Diameter

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Diameter Base Protocol
Diameter Gy Protocol
Diameter Gx Protocol

Diameter Base Protocol

This sub-section describes how AAA Gateway maps the messages for Diameter Base Protocol defined in RFC-3588.

Section Compliance

Table 1-1 lists the compliance information for Diameter Base protocol sections.

Table 1-1: Diameter Base Protocol Section Compliance

Section Number	Section	Status	Notes
1	Introduction	Not applicable	-
1.1	Diameter Protocol	Not applicable	-
1.1.1	Description of the document set	Not applicable	-
1.2	Approach to extensibility	Not applicable	-
1.2.1	Defining new attribute-value pairs	Not applicable	-
1.2.2	Creating new AVPs	Not applicable	-
1.2.3	Creating new authentication apps	Not applicable	-
1.2.4	Creating new accounting apps	Not applicable	-
1.2.5	Application authentication	Not applicable	-
1.3	Terminology	Not applicable	-
2	Protocol overview	Not applicable	-
2.1	Transport	Supported	Supports TCP and SCTP
2.1.1	SCTP guidelines	Supported	-
2.2	Securing diameter messages	Not supported	-
2.3	Diameter application compliance	Supported	-
2.4	Application identifiers	Supported	-
2.5	Connections vs Sessions	No requirement	-
2.6	Peer table	Supported	-
2.7	Realm-based routing table	Not applicable	-
2.8	Role of diameter agents	Not applicable	-
2.8.1	Relay agents	Not applicable	-
2.8.2	Proxy agents	Not applicable	-
2.8.3	Redirect agents	Not applicable	-
2.8.4	Translation agents	Not applicable	-
2.9	End-to-end security framework	Not supported	-
2.10	Diameter path authorization	Not supported	-
3	Diameter header	Supported	-
3.1	Command codes	Supported	-
3.2	Command code ABNF specification	No requirement	-
3.3	Diameter command naming conventions	Supported	-
4	Diameter AVPs	Supported	-
4.1	AVP header	Supported	-
4.1.1	Optional header elements	Supported	-
4.2	Basic AVP	Supported	-
4.3	Derived AVP data formats	Supported	-
4.4	Grouped AVP values	Supported	-
4.4.1	Example AVP with grouped data type	No requirement	-
4.5	Diameter base protocol AVPs	Supported	-
5	Diameter peers	No requirement	-
5.1	Peer connections	Supported	-
5.2	Diameter peer discovery	Not supported	Diameter Gateway does not support routing, proxy, or relay
5.3	Capabilities exchange	Supported	-
5.3.1	Capabilities-Exchange-Request	Supported	-
5.3.2	Capabilities-Exchange-Answer	Supported	-
5.3.3	Vendor-Id AVP	Supported	-
5.3.4	Firmware-Revision AVP	Supported	-
5.3.5	Host-IP-Address AVP	Not supported	-
5.3.6	Supported-Vendor-Id AVP	Supported	-
5.3.7	Product-Name AVP	Supported	-
5.4	Disconnecting peer connections	Partially supported	Diameter Gateway only responds to messages, does not generate them
5.4.1	Disconnect-Peer-Request	Partially supported	Diameter Gateway only responds to messages, does not generate them
5.4.2	Disconnect-Peer-Answer	Partially supported	Diameter Gateway only responds to messages, does not generate them
5.4.3	Disconnect-Cause AVP	Partially supported	Diameter Gateway only responds to messages, does not generate them
5.5	Transport failure detection	Supported	-
5.5.1	Device-Watchdog-Request	Supported	-
5.5.2	Device-Watchdog-Answer	Supported	-
5.5.3	Transport failure algorithm	Supported	-
5.5.4	Failover and failback procedures	Partially supported	-
5.6	Peer state machine	Supported	-
5.6.1	Incoming connections	Supported	-
5.6.2	Events	Supported	-
5.6.3	Actions	Supported	-
5.6.4	The election process	Supported	-
6	Diameter message processing	No requirement	-
6.1	Diameter request routing overview	No requirement	-
6.1.1	Originating a request	Supported	-
6.1.2	Sending a request	Supported	-
6.1.3	Receiving requests	Supported	-
6.1.4	Processing local requests	Not supported	-
6.1.5	Request forwarding	Not supported	-
6.1.6	Request routing	Not applicable	-
6.1.7	Redirecting requests	Not applicable	-
6.1.8	Relaying and proxying requests	Not applicable	-
6.2	Diameter answer processing	Supported	-
6.2.1	Processing received answers	Supported	-
6.2.2	Relaying and proxying answers	Not applicable	Configurable per Diameter Gateway instance
6.3	Origin-Host AVP	Supported	Configurable per Diameter Gateway instance
6.4	Origin-Realm AVP	Supported	-
6.5	Destination-Host AVP	Supported	-
6.6	Destination-Realm AVP	Supported	-
6.7	Routing AVPs	Not applicable	-
6.7.1	Route-Record AVP	Not applicable	-
6.7.2	Proxy-Info AVP	Not applicable	-
6.7.3	Proxy-Host AVP	Not applicable	-
6.7.4	Proxy-State AVP	Not applicable	-
6.8	Auth-Application-Id AVP	Supported	-
6.9	Acct-Application-Id AVP	Not applicable	-
6.10	Inband-Security-Id AVP	Supported	Supports only 0, where 0 specifies NO_INBAND_SECURITY
6.11	Vendor-Specific-Application-Id AVP	Supported	-
6.12	Redirect-Host AVP	Not applicable	-
6.13	Redirect-Host-Usage AVP	Not applicable	-
6.14	Redirect-Max-Cache-Time AVP	Not applicable	-
6.15	E2E-Sequence AVP	Not applicable	-
7	Error handling	Supported	-
7.1	Result-Code AVP	Supported	-
7.1.1	Informational	Supported	-
7.1.2	Success	Supported	-
7.1.3	Protocol errors	Supported	-
7.1.4	Transient Failures	Supported	-
7.1.5	Permanent Failures	Supported	-
7.2	Error bit	Supported	-
7.3	Error-Message AVP	Not supported	-
7.4	Error-Reporting-Host AVP	Not supported	-
7.5	Failed-AVP AVP	Supported	-
7.6	Experimental-Result AVP	Supported	-
7.7	Experimental-Result-Code AVP	Supported	-
8	Diameter user sessions	No requirement	-
8.1	Authorization session state machine	Supported	-
8.2	Accounting session state machine	Not applicable	-
8.3	Server-Initiated Re-Auth	Supported	-
8.3.1	Re-Auth-Request	Supported	-
8.3.2	Re-Auth-Answer	Supported	-
8.4	Session termination	Supported	-
8.4.1	Session-Termination-Request	Supported	-
8.4.2	Session-Termination-Answer	Supported	-
8.5	Aborting a session	Not supported	-
8.5.1	Abort-Session-Request	Not supported	-
8.5.2	Abort-Session-Answer	Not supported	-
8.6	Inferring session termination from Origin-State-Id	Not supported	-
8.7	Auth-Request-Type AVP	Not applicable	-
8.8	Session-Id AVP	Supported	-
8.9	Authorization-Lifetime AVP	Not applicable	-
8.10	Auth-Grace-Period AVP	Not applicable	-
8.11	Auth-Session-State AVP	Not applicable	-
8.12	Re-Auth-Request-Type AVP	Not applicable	-
8.13	Session-Timeout AVP	Not applicable	-
8.14	User-Name AVP	Not applicable	-
8.15	Termination-Cause AVP	Supported	-
8.16	Origin-State-Id AVP	Not supported	-
8.17	Session-Binding AVP	Not applicable	-
8.18	Session-Server-Failover AVP	Not applicable	-
8.19	Multi-Round-Time-Out AVP	Not applicable	-
8.20	Class AVP	Not applicable	-
8.21	Event-Timestamp AVP	Supported	-
9	Accounting	Not applicable	-
9.1	Server directed model	Not applicable	-
9.2	Protocol messages	Not applicable	-
9.3	Application document requirements	Not applicable	-
9.4	Fault resilience	Not applicable	-
9.5	Accounting records	Not applicable	-
9.6	Correlation of accounting records	Not applicable	-
9.7	Accounting Command-Codes	Not applicable	-
9.7.1	Accounting-Request	Not applicable	-
9.7.2	Accounting-Answer	Not applicable	-
9.8	Accounting AVPs	Not applicable	-
9.8.1	Accounting-Record-Type AVP	Not applicable	-
9.8.2	Acct-Interim-Interval AVP	Not applicable	-
9.8.3	Accounting-Record-Number AVP	Not applicable	-
9.8.4	Acct-Session-Id AVP	Not applicable	-
9.8.5	Acct-Multi-Session-Id AVP	Not applicable	-
9.8.6	Accounting-Sub-Session-Id AVP	Not applicable	-
9.8.7	Accounting-Realtime-Required AVP	Not applicable	-
10	AVP occurrence table	No requirement	-
10.1	Base protocol command AVP Table	No requirement	-
10.2	Accounting AVP Table	No requirement	-
11	IANA Considerations	No requirement	-
11.1	AVP header	No requirement	-
11.1.1	AVP code	No requirement	-
11.1.2	AVP flags	No requirement	-
11.2	Diameter header	No requirement	-
11.2.1	Command codes	No requirement	-
11.2.2	Command Flags	No requirement	-
11.3	Application identifiers	No requirement	-
11.4	AVP Values	No requirement	-
11.4.1	Result-Code AVP Values	No requirement	-
11.4.2	Accounting-Record-Type AVP Values	No requirement	-
11.4.3	Termination-Cause AVP Values	No requirement	-
11.4.4	Redirect-Host-Usage AVP Values	No requirement	-
11.4.5	Session-Server-Failover AVP Values	No requirement	-
11.4.6	Session-Binding AVP Values	No requirement	-
11.4.7	Disconnect-Cause AVP Values	No requirement	-
11.4.8	Auth-Request-Type AVP Values	No requirement	-
11.4.9	Auth-Session-State AVP Values	No requirement	-
11.4.10	Re-Auth-Request-Type AVP Values	No requirement	-
11.4.11	Accounting-Realtime-Required AVP Values	No requirement	-
11.5	Diameter TCP/SCTP port numbers	No requirement	-
11.6	Naming authority pointer (NAPTR) Service Fields	No requirement	-
12	Diameter Protocol Related Configurable Parameters	Supported	-
13	Security considerations	Not supported	-
13.1	IPsec usage	Not supported	-
13.2	TLS usage	Not supported	-
13.3	Peer-to-Peer Considerations	Not supported	-
14	References	No requirement	-
14.1	Normative References	No requirement	-
14.2	Informative References	No requirement	-
15	Acknowledgements	No requirement	-
Appendix A	Diameter service template	No requirement	-
Appendix B	NAPTR example	No requirement	-
Appendix C	Duplicate detection	Supported	-

Diameter Gy Protocol

This chapter describes how AAA Gateway maps the diameter messages for the Diameter Gy protocol defined in 3GPP TS 32.299 Version 12.0. For more information, see the 3GPP specification detail:

http://www.3gpp.org/ftp/Specs/html-info/32299.htm

Section Compliance

Table 2-1 lists the compliance information for Diameter Gy protocol sections.

Table 2-1: Diameter Gy Section Compliance

Section Number	Section	Status	Notes
1	Scope	Not applicable	-
2	References	Not applicable	-
3	Definitions, symbols and abbreviations	Not applicable	-
3.1	Definitions	Not applicable	-
3.2	Symbols	Not applicable	-
3.3	Abbreviations	Not applicable	-
4	Architecture considerations	Supported	-
4.1	High level architecture	Supported	-
4.1.0	General	Supported	-
4.1.1	Charging related transfer requirements	Supported	-
5	3GPP charging applications requirements	Supported	-
5.1	Offline charging scenarios	Supported	-
5.1.1	Basic principles	Supported	-
5.1.1.0	Introduction	Supported	-
5.1.1.1	Event based charging	Supported	-
5.1.1.2	Session based charging	Supported	-
5.1.2	Basic operation	Supported	-
5.2	Online charging scenarios	Supported	-
5.2.0	Introduction	Supported	-
5.2.1	Basic principles	Supported	-
5.2.2	Charging scenarios	Supported	-
5.2.2.0	Introduction	Supported	-
5.2.2.1	Immediate event charging (IEC)	Supported	-
5.2.2.1.1	Decentralized unit determination and centralized rating	Not supported	-
5.2.2.1.2	Centralized unit determination and centralized rating	Supported	-
5.2.2.1.3	Decentralized unit determination and decentralized rating	Not supported	-
5.2.2.1.4	Further options	Supported	-
5.2.2.2	Event charging with unit reservation (ECUR)	Supported	-
5.2.2.2.1	Decentralized unit determination and centralized rating	Not supported	-
5.2.2.2.2	Centralized unit determination and centralized rating	Supported	-
5.2.2.2.3	Decentralized unit determination and decentralized rating	Not supported	-
5.2.2.3	Session charging with reservation	Supported	-
5.2.2.3.1	Decentralized unit determination and centralized rating	Not supported	-
5.2.2.3.2	Centralized unit determination and centralized rating	Supported	-
5.2.2.3.3	Decentralized unit determination and decentralized rating	Not supported	-
5.2.3	Basic operations	Supported	-
5.3	Other requirements	Supported	-
5.3.1	Re-authorization	Supported	-
5.3.2	Threshold based re-authorization triggers	Supported	-
5.3.3	Termination action	Supported	-
5.3.4	Account expiration	Not supported	-
6	3GPP charging applications – protocol aspects	Supported	-
6.1	Basic principles for diameter offline charging	Supported	-
6.1.0	Introduction	Supported	-
6.1.1	Event based charging	Supported	-
6.1.2	Session based charging	Supported	-
6.1.3	Offline charging error cases - diameter procedures	Supported	-
6.1.3.1	Charging data function (CDF) connection failure	Supported	-
6.1.3.2	No reply from CDF	Supported	-
6.1.3.3	Duplicate detection	Supported	-
6.1.3.4	CDF detected failure	Supported	-
6.2	Message contents for offline charging	Not supported	-
6.2.1	Summary of offline charging message formats	Not supported	-
6.2.1.1	General	Not supported	-
6.2.1.2	Structure for the accounting message formats	Not supported	-
6.2.2	Accounting-Request message	Not supported	-
6.2.3	Accounting-Answer (ACA) message	Not supported	-
6.3	Basic principles for diameter online charging	Supported	-
6.3.1	Online specific Credit-Control application requirements	Supported	-
6.3.2	Diameter description on the Ro reference point	Supported	-
6.3.2.1	Basic principles	Supported	-
6.3.3	Immediate event charging (IEC)	Supported	-
6.3.4	Event charging with unit reservation (ECUR)	Supported	-
6.3.5	Session charging with unit reservation (SCUR)	Supported	-
6.3.6	Error cases and scenarios	Supported	-
6.3.6.0	Introduction	Supported	-
6.3.6.1	Duplicate detection	Supported	-
6.3.6.2	Reserve units/Debit units operation failure	Supported	-
6.3.7	Support of tariff changes during an active user session	Supported	-
6.3.7.1	Support of tariff changes using the tariff switch mechanism	Supported	-
6.3.7.2	Support of tariff changes using Validity-Time attribute-value pair (AVP)	Not supported	-
6.3.8	Support of re-authorization	Supported	-
6.3.9	Support of failure handling	Supported	-
6.3.10	Support of failover	Supported	-
6.3.11	Credit pooling	Not supported	-
6.4	Message formats for online charging	Supported	-
6.4.1	Summary of online charging message formats	Supported	-
6.4.1.1	General	Supported	-
6.4.1.2	Structure for the Credit-Control message formats	Supported	-
6.4.2	Credit-Control-Request message	Supported	-
6.4.3	Credit-Control-Answer message	Supported	-
6.4.4	Re-Auth-Request message	Supported	-
6.4.5	Re-Auth-Answer message	Supported	-
6.4.6	Capabilities-Exchange-Request-message	Supported	-
6.4.7	Capabilities-Exchange-Answer message	Supported	-
6.4.8	Device-Watchdog-Request message	Supported	-
6.4.9	Device-Watchdog-Answer message	Supported	-
6.4.10	Disconnect-Peer-Request message	Partially supported	-
6.4.11	Disconnect-Peer-Answer message	Partially supported	-
6.4.12	Abort-Session-Request message	Not supported	-
6.4.13	Abort-Session-Answer message	Not supported	-
6.5	Other procedural description of the 3GPP charging applications	Supported	-
6.5.1	Re-Authorization	Supported	-
6.5.1.1	Idle timeout	Supported	-
6.5.1.2	Change of charging conditions	Not supported	-
6.5.1.3	Reporting quota usage	Not supported	-
6.5.1.4	Quota consumption	Not supported	-
6.5.2	Threshold based Re-Authorization triggers	Supported	-
6.5.3	Termination action	Supported	-
6.5.4	Quota consumption time	Supported	-
6.5.5	Service termination	Not supported	-
6.5.6	Envelope reporting	Not supported	-
6.5.7	Combinational quota	Not supported	-
6.5.8	Online control of offline charging information	Supported	-
6.5.9	Support of multiple service	Supported	-
6.6	Bindings of the operation to protocol application	Supported	-
6.6.0	General	Supported	-
6.6.1	Bindings of charging data transfer to accounting	Supported	-
6.6.2	Bindings of debit/reserve units to Credit-Control	Supported	-
7	Summary of used attribute-value pairs (AVPs)	Not applicable	-
7.1	Diameter attribute-value pairs (AVPs)	Not applicable	-
7.1.0	General	Not applicable	-
7.1.1	Accounting-Input-Octets AVP	Not supported	-
7.1.2	Void	Not applicable	-
7.1.3	Accounting-Output-Octets AVP	Not supported	-
7.1.4	Void	Not applicable	-
7.1.5	Acct-Application-Id AVP	Supported	-
7.1.6	Auth-Application-Id AVP	Supported	-
7.1.7	Called-Station-Id AVP	Supported	-
7.1.8	Event-Timestamp AVP	Supported	-
7.1.9	Multiple-Services-Credit-Control AVP	Supported	-
7.1.10	Rating-Group AVP	Supported	-
7.1.11	Result-Code AVP	Supported	-
7.1.12	Service-Context-Id AVP	Supported	-
7.1.13	Service-Identifier AVP	Supported	-
7.1.14	Used-Service-Unit AVP	Supported	-
7.1.15	User-Name AVP	Supported	-
7.1.16	Vendor-Id AVP	Supported	-
7.1.17	User-Equipment-Info AVP	Supported	-
7.2	3GPP specific AVPs	Not supported	-
7.2.0	General	Not supported	-
7.2.1	Access-Network-Information AVP	Not supported	-
7.2.1A	Access-Transfer-Information AVP	Not supported	-
7.2.1B	Access-Transfer-Type AVP	Not supported	-
7.2.2	Account-Expiration AVP	Not supported	-
7.2.3	Accumulated-Cost AVP	Not supported	-
7.2.4	Adaptations AVP	Not supported	-
7.2.5	Additional-Content-Information AVP	Not supported	-
7.2.6	Additional-Type-Information AVP	Not supported	-
7.2.7	Address-Data AVP	Not supported	-
7.2.8	Address-Domain AVP	Not supported	-
7.2.9	Address-Type AVP	Not supported	-
7.2.10	Addressee-Type AVP	Not supported	-
7.2.11	AF-Correlation-Information AVP	Supported	-
7.2.12	Alternate-Charged-Party-Address AVP	Not supported	-
7.2.13	AoC-Cost-Information AVP	Not supported	-
7.2.14	AoC-Format AVP	Not supported	-
7.2.15	AoC-Information AVP	Supported	-
7.2.16	AoC-Request-Type AVP	Supported	-
7.2.17	AoC-Service AVP	Not supported	-
7.2.18	AoC-Service-Obligatory-Type AVP	Not supported	-
7.2.19	AoC-Service-Type AVP	Not supported	-
7.2.20	AoC-Subscription-Information AVP	Not supported	-
7.2.21	Applic-ID AVP	Not supported	-
7.2.22	Application-provided-Called-Party-Address AVP	Not supported	-
7.2.23	Application-Server AVP	Not supported	-
7.2.24	Application-Server-Information AVP	Not supported	-
7.2.25	Associated-Party-Address AVP	Not supported	-
7.2.26	Associated-URI AVP	Not supported	-
7.2.27	Authorised-QoS AVP	Not supported	-
7.2.28	Aux-Applic-Info AVP	Not supported	-
7.2.29	Base-Time-Interval AVP	Supported	-
7.2.29A	Basic-Service-Code AVP	Not supported	-
7.2.29B	Bearer-Capability AVP	Not supported	-
7.2.30	Bearer-Service AVP	Not supported	-
7.2.30A	Basic service set identifier (BSSID) AVP	Not supported	-
7.2.31	Called-Asserted-Identity AVP	Not supported	-
7.2.32	Called-Party-Address AVP	Not supported	-
7.2.33	Calling-Party-Address AVP	Not supported	-
7.2.34	Carrier-Select-Routing-Information AVP	Not supported	-
7.2.35	Cause-Code AVP	Not supported	-
7.2.36	CG-Address AVP	Supported	-
7.2.37	Change-Condition AVP	Supported	-
7.2.38	Change-Time AVP	Not supported	-
7.2.38A	Charge-Reason-Code AVP	Not supported	-
7.2.39	Charged-Party AVP	Not supported	-
7.2.39A	Charging-Characteristics-Selection-Mode AVP	Not supported	-
7.2.40	Class-Identifier AVP	Not supported	-
7.2.41	Client-Address AVP	Not supported	-
7.2.41A	CN-Operator-Selection-Entity AVP	Not supported	-
7.2.42	Content-Class AVP	Not supported	-
7.2.43	Content-Disposition AVP	Not supported	-
7.2.44	Content-Length AVP	Not supported	-
7.2.45	Content-Size AVP	Not supported	-
7.2.46	Content-Type AVP	Not supported	-
7.2.46A	CSG-Access-Mode AVP	Supported	-
7.2.46B	CSG-Membership-Indication AVP	Supported	-
7.2.47	Current-Tariff AVP	Not supported	-
7.2.48	CUG-Information AVP	Not supported	-
7.2.49	Data-Coding-Scheme AVP	Not supported	-
7.2.50	DCD-Information AVP	Supported	-
7.2.51	Deferred-Location-Event-Type AVP	Not supported	-
7.2.52	Delivery-Report-Requested AVP	Not supported	-
7.2.53	Destination-Interface AVP	Not supported	-
7.2.54	Diagnostics AVP	Supported	-
7.2.55	Domain-Name AVP	Not supported	-
7.2.56	DRM-Content AVP	Not supported	-
7.2.57	Dynamic-Address-Flag AVP	Supported	-
7.2.57A	Dynamic-Address-Flag-Extension AVP	Not supported	-
7.2.58	Early-Media-Description AVP	Not supported	-
7.2.59	Envelope AVP	Supported	-
7.2.60	Envelope-End-Time AVP	Supported	-
7.2.61	Envelope-Reporting AVP	Supported	-
7.2.62	Envelope-Start-Time AVP	Supported	-
7.2.62A	ePDG-Address AVP	Not supported	-
7.2.63	Event AVP	Not supported	-
7.2.64	Event-Charging-TimeStamp AVP	Supported	-
7.2.65	Event-Type AVP	Not supported	-
7.2.66	Expires AVP	Not supported	-
7.2.67	File-Repair-Supported AVP	Not supported	-
7.2.67A	Forwarding-Pending AVP	Not supported	-
7.2.67B	From-Address AVP	Not supported	-
7.2.68	GGSN-Address AVP	Supported	-
7.2.69	IM-Information AVP	Supported	-
7.2.70	Incremental-Cost AVP	Not supported	-
7.2.70A	Instance-Id AVP	Not supported	-
7.2.71	Interface-Id AVP	Not supported	-
7.2.72	Interface-Port AVP	Not supported	-
7.2.73	Interface-Text AVP	Not supported	-
7.2.74	Interface-Type AVP	Not supported	-
7.2.74A	IMS-Application-Reference-Identifier AVP	Not supported	-
7.2.75	IMS-Charging-Identifier AVP	Not supported	-
7.2.76	IMS-Communication-Service-Identifier AVP	Not supported	-
7.2.76A	IMS-Emergency-Indicator AVP	Not supported	-
7.2.77	IMS-Information AVP	Supported	-
7.2.77A	IMS-Visited-Network-Identifier AVP	Not supported	-
7.2.78	IMSI-Unauthenticated-Flag AVP	Not supported	-
7.2.79	Incoming-Trunk-Group-ID AVP	Not supported	-
7.2.79A	Initial-IMS-Charging-Identifier AVP	Not supported	-
7.2.80	Inter-Operator-Identifier AVP	Not supported	-
7.2.80A	IP-Realm-Default-Indication AVP	Not supported	-
7.2.80B	ISUP-Cause AVP	Not supported	-
7.2.80C	ISUP-Cause-Diagnostics AVP	Not supported	-
7.2.80D	ISUP-Cause-Location AVP	Not supported	-
7.2.80E	ISUP-Cause-Value AVP	Not supported	-
7.2.80F	ISUP-Location-Number AVP	Not supported	-
7.2.81	LCS-APN AVP	Not supported	-
7.2.82	LCS-Client-Dialed-By-MS AVP	Not supported	-
7.2.83	LCS-Client-External-ID AVP	Not supported	-
7.2.84	LCS-Client-ID AVP	Not supported	-
7.2.85	LCS-Client-Name AVP	Not supported	-
7.2.86	LCS-Client-Type AVP	Not supported	-
7.2.87	LCS-Data-Coding-Scheme AVP	Not supported	-
7.2.88	LCS-Format-Indicator AVP	Not supported	-
7.2.89	LCS-Information AVP	Supported	-
7.2.90	LCS-Name-String AVP	Not supported	-
7.2.91	LCS-Requestor-ID AVP	Not supported	-
7.2.92	LCS-Requestor-ID-String AVP	Not supported	-
7.2.92A	Local-GW-Inserted-Indication AVP	Not supported	-
7.2.93	Local-Sequence-Number AVP	Not supported	-
7.2.94	Location-Estimate AVP	Not supported	-
7.2.95	Location-Estimate-Type AVP	Not supported	-
7.2.96	Location-Type AVP	Not supported	-
7.2.97	Low-Balance-Indication AVP	Supported	-
7.2.97A	Low-Priority-Indicator AVP	Not supported	-
7.2.97B	MBMS-Charged-Party AVP	Not supported	-
7.2.98	MBMS-GW-Address AVP	Not supported	-
7.2.99	MBMS-Information AVP	Supported	-
7.2.100	MBMS-User-Service-Type AVP	Not supported	-
7.2.101	Media-Initiator-Flag AVP	Not supported	-
7.2.102	Media-Initiator-Party AVP	Not supported	-
7.2.103	Message-Body AVP	Not supported	-
7.2.104	Message-Class AVP	Not supported	-
7.2.105	Message-ID AVP	Not supported	-
7.2.106	Message-Size AVP	Not supported	-
7.2.107	Message-Type AVP	Not supported	-
7.2.108	MM-Content-Type AVP	Not supported	-
7.2.109	MMBox-Storage-Requested AVP	Not supported	-
7.2.110	MMS-Information AVP	Supported	-
7.2.111	MMTel-Information AVP	Supported	-
7.2.111A	MMTel-Service-Type AVP	Not supported	-
7.2.111B	MSC-Address AVP	Not supported	-
7.2.111C	MTC-IWF-Address AVP	Not supported	-
7.2.111D	Neighbour-Node-Address AVP	Not supported	-
7.2.112	Next-Tariff AVP	Not supported	-
7.2.112A	NNI-Information AVP	Not supported	-
7.2.112B	NNI-Type AVP	Not supported	-
7.2.113	Node-Functionality AVP	Not supported	-
7.2.114	Node-Id AVP	Supported	-
7.2.115	Number-Of-Diversions AVP	Not supported	-
7.2.116	Number-Of-Messages-Sent AVP	Not supported	-
7.2.117	Number-Of-Participants AVP	Not supported	-
7.2.118	Number-Of-Received-Talk-Bursts AVP	Not supported	-
7.2.119	Number-Of-Talk-Bursts AVP	Not supported	-
7.2.120	Number-Portability-Routing-Information AVP	Not supported	-
7.2.121	Offline-Charging AVP	Supported	-
7.2.122	Online-Charging-Flag AVP	Not supported	-
7.2.123	Originating-IOI AVP	Not supported	-
7.2.124	Originator AVP	Not supported	-
7.2.125	Originator-Address AVP	Not supported	-
7.2.126	Originator-Interface AVP	Not supported	-
7.2.127	Originator-Received-Address AVP	Not supported	-
7.2.128	Originator-SCCP-Address	Not supported	-
7.2.128A	Outgoing-Session-Id AVP	Not supported	-
7.2.129	Outgoing-Trunk-Group-ID AVP	Not supported	-
7.2.185	SDP-TimeStamps AVP	Not supported	-
7.2.186	SDP-Type AVP	Not supported	-
7.2.186A	Session-Direction AVP	Not supported	-
7.2.187	Served-Party-IP-Address AVP	Not supported	-
7.2.188	Void	Not applicable	-
7.2.189	Service-Data-Container AVP	Supported	-
7.2.190	Service-ID AVP	Not supported	-
7.2.191	Service-Generic-Information AVP	Supported	-
7.2.192	Service-Information AVP	Supported	-
7.2.193	Service-Mode AVP	Not supported	-
7.2.194	Service-Specific-Data AVP	Not supported	-
7.2.195	Service-Specific-Info AVP	Supported	-
7.2.196	Service-Specific-Type AVP	Not supported	-
7.2.197	Void	Not applicable	-
7.2.198	Serving-Node-Type AVP	Supported	-
7.2.199	SGSN-Address AVP	Supported	-
7.2.199A	SGW-Address AVP	Not applicable	-
7.2.200	SGW-Change AVP	Supported	-
7.2.201	SIP-Method AVP	Not supported	-
7.2.202	SIP-Request-Timestamp AVP	Not supported	-
7.2.203	SIP-Request-Timestamp-Fraction AVP	Not supported	-
7.2.204	SIP-Response-Timestamp AVP	Not supported	-
7.2.205	SIP-Response-Timestamp-Fraction AVP	Not supported	-
7.2.205A	SM-Device-Trigger-Indicator AVP	Not supported	-
7.2.205B	SM-Device-Trigger-Information AVP	Not supported	-
7.2.206	SM-Discharge-Time AVP	Not supported	-
7.2.207	SM-Message-Type AVP	Not supported	-
7.2.208	SM-Protocol-Id AVP	Not supported	-
7.2.208A	SM-Sequence-Number AVP	Not supported	-
7.2.209	SM-Status AVP	Not supported	-
7.2.210	SM-User-Data-Header AVP	Not supported	-
7.2.211	SMS-Information AVP	Supported	-
7.2.212	SMS-Node AVP	Not supported	-
7.2.212A	SMS-Result AVP	Not supported	-
7.2.213	SM-Service-Type AVP	Not supported	-
7.2.214	SMSC-Address AVP	Not supported	-
7.2.214A	Start-of-Charging AVP	Not supported	-
7.2.215	Start-Time AVP	Supported	-
7.2.215A	Status-Code AVP	Not supported	-
7.2.216	Stop-Time AVP	Supported	-
7.2.217	Submission-Time AVP	Not supported	-
7.2.218	Subscriber-Role AVP	Not supported	-
7.2.219	Supplementary-Service AVP	Not supported	-
7.2.219A	TAD-Identifier AVP	Not supported	-
7.2.220	Talk-Burst-Exchange AVP	Not supported	-
7.2.221	Talk-Burst-Time AVP	Not supported	-
7.2.222	Talk-Burst-Volume AVP	Not supported	-
7.2.223	Tariff-Information AVP	Not supported	-
7.2.224	Tariff-XML AVP	Not supported	-
7.2.224A	Teleservice AVP	Not supported	-
7.2.225	Terminating-IOI AVP	Not supported	-
7.2.226	Time-First-Usage AVP	Not supported	-
7.2.227	Time-Last-Usage AVP	Not supported	-
7.2.228	Time-Quota-Mechanism	Supported	-
7.2.229	Time-Quota-Threshold AVP	Supported	-
7.2.230	Time-Quota-Type AVP	Supported	-
7.2.231	Time-Stamps AVP	Not supported	-
7.2.232	Time-Usage AVP	Not supported	-
7.2.233	Traffic-Data-Volumes AVP	Supported	-
7.2.233A	Transcoder-Inserted-Indication AVP	Not supported	-
7.2.233B	Transit-IOI-List AVP	Not supported	-
7.2.234	Token-Text AVP	Not supported	-
7.2.235	Trigger AVP	Supported	-
7.2.236	Trigger-Type AVP	Supported	-
7.2.237	Trunk-Group-ID AVP	Not supported	-
7.2.237A	Void	Not applicable	-
7.2.237B	Void	Not applicable	-
7.2.237C	TWAN-User-Location-Info AVP	Not supported	-
7.2.238	Type-Number AVP	Not supported	-
7.2.239	Unit-Cost AVP	Not supported	-
7.2.240	Unit-Quota-Threshold AVP	Supported	-
7.2.240A	User-CSG-Information AVP	Not supported	-
7.2.241	User-Participating-Type AVP	Not supported	-
7.2.242	User-Session-Id AVP	Not supported	-
7.2.242A	VCS-Information AVP	Not supported	-
7.2.242B	VLR-Number AVP	Not supported	-
7.2.243	Volume-Quota-Threshold AVP	Supported	-
7.2.244	Void	Not applicable	-
7.2.245	Void	Not applicable	-
7.2.246	Void	Not applicable	-
7.2.247	Void	Not applicable	-
7.2.248	Void	Not applicable	-
7.2.249	Void	Not applicable	-
7.2.250	Void	Not applicable	-
7.3	3GPP2 access specific AVPs	Not applicable	-
7.4	Fixed access specific AVPs	Not applicable	-

Diameter Session Commands

Table 2-2 lists the Diameter session commands supported by Diameter Gateway.

Table 2-2: Diameter Session Commands

Diameter Command	Status	Notes
Credit-Control-Request	Supported	-
Credit-Control-Answer	Supported	-

Diameter Credit-Control Request Messages

Table 2-3 lists the Diameter credit-control request messages supported by Diameter Gateway.

Table 2-3: Diameter Credit-Control Request Messages

Diameter Gy Message	Status	Notes
Session Charging	Supported	-
Top-Up	Supported	-
Balance-Query	Supported	Supports both summary and detailed Balance-Query modes
Debit/Refund	Supported	-
Price Enquiry	Supported	-

Gy Session Charging (IUT) Request AVPs

Table 2-4 lists the compliance information for Gy Session Charging attribute-value pairs (AVPs) for the session-based request operations, such as INITIATE, UPDATE, and TERMINATE (IUT).

Table 2-4: Gy Session Charging (IUT) Request AVPs

Diameter AVP	Status	Notes
Session-Id	Supported	-
Service-Context-Id	Supported	-
CC-Request-Type	Supported	1 - INITIATE 2 - UPDATE 3 - TERMINATE
CC-Request-Number	Supported	-
Event-Timestamp	Supported	-
Subscription-Id	Supported	-
– Subscription-Id-Data	Supported	-
– Subscription-Id-Type	Supported	-
Termination-Cause	Supported	-
Service-Information	Supported	-
– PS-Information	Supported	-
– – Called-Station-Id	Supported	-
– – SGSN-Address	Supported	-
– – GGSN-Address	Supported	-
– – MS-TimeZone-3GPP	Supported	-
– – Diagnostics	Supported	-
User-Name	Not supported	Subscription-Id-Data AVP is used instead
Multiple-Services-Credit-Control	Supported	See Table 2-5 for more information.

Multiple-Services-Credit-Control

Table 2-5 lists the compliance information for Multiple-Services-Credit-Control AVPs for the Gy Session Charging request operations.

Table 2-5: Multiple-Services-Credit-Control AVPs for Gy Session Charging Request

Diameter AVP	Status	Notes
Service-Identifier	Supported	-
Rating-Group	Supported	-
Requested-Service-Unit	Supported	-
– CC-Time	Supported	-
– CC-Money	Not supported	-
– CC-Total-Octets	Supported	-
– CC-Input-Octets	Supported	-
– CC-Output-Octets	Supported	-
– CC-Service-Specific-Units	Supported	-
Used-Service-Unit	Supported	-
– CC-Time	Supported	-
– CC-Money	Not supported	-
– CC-Total-Octets	Supported	-
– CC-Input-Octets	Supported	-
– CC-Output-Octets	Supported	-
– CC-Service-Specific-Units	Supported	-

Gy Session Charging (IUT) Response AVPs

Table 2-6 lists the compliance information for Diameter Credit-Control-Answer AVPs for the Gy Session Charging response operations.

Table 2-6: Gy Session Charging (IUT) Response AVPs

Diameter AVP	Status	Notes
Session-Id	Supported	-
Result-Code	Supported	-
CC-Request-Type	Supported	-
CC-Session-Failover	Supported	-
Credit-Control-Failure-Handling	Supported	-
Multiple-Services-Credit-Control	Supported	See Table 2-7 for more info

Multiple-Services-Credit-Control

Table 2-7 lists the Multiple-Services-Credit-Control AVPs for the Gy Session Charging response operations.

Table 2-7: Multiple-Services-Credit-Control AVPs for Gy Session Charging Response

Diameter AVP	Status	Notes
Requested-Service-Unit	Supported	Contains the AVPs submitted in the message request.
Granted-Service-Unit	Supported	-
– CC-Time	Supported	-
– CC-Money	Not supported	-
– CC-Total-Octets	Supported	-
– CC-Input-Octets	Supported	-
– CC-Output-Octets	Supported	-
– CC-Service-Specific-Units	Supported	-
– Cost-Information	Supported	-
– – Unit-Value	Supported	-
– – – Value-Digits	Supported	-
– – – Exponent	Supported	-
– – Currency-Code	Supported	-
ORA-Customer-Cost-Information	Supported	-
– ORA-Subscriber-Id	Supported	-
– ORA-Cost-Information	Supported	-
– – Unit-Value	Supported	-
– – – Value-Digits	Supported	-
– – – Exponent	Supported	-
– – ORA-Balance-Element-Id	Supported	-
ORA-Remaining-Balance	Supported	-
– ORA-Balance-Element	Supported	-
– – ORA-Balance-Element-Id	Supported	-
– – Unit-Value	Supported	-
– – – Value-Digits	Supported	-
– – – Exponent	Supported	-
– – ORA-Balance-Item	Supported	-
– ORA-Subscriber-Id	Supported	-
ORA-Credit-Threshold-Breach	Supported	-
– ORA-Balance-Element-Id	Supported	-
– ORA-Current-Balance	Supported	-
– ORA-Fixed-Threshold-Values	Supported	-
– – ORA-Fixed-Threshold	Supported	-
ORA-Percentage-Threshold-Values	Supported	-
– ORA-Percentage-Threshold	Supported	-
– ORA-Breach-Direction	Supported	0 - THRESHOLD_BREACH_UP
		1 - THRESHOLD_BREACH_DOWN
Final-Unit-Indication	Partially supported	TERMINATE and REDIRECT are supported.
Validity-Time	Supported	-
Result-Code	Supported	-

Gy Top-Up Request AVPs

Table 2-8 lists the compliance information for Gy Top-Up AVPs for the request operations.

Table 2-8: Gy Top-Up Request AVPs

Diameter AVP	Status	Notes
CC-Request-Type	Supported	4 - EVENT_REQUEST
Requested-Action	Supported	4 - TOP-UP
Subscription-Id	Supported	-
– Subscription-Id-Type	Supported	-
– Subscription-Id-Data	Supported	-
Event-Timestamp	Supported	-
Rating-Group	Supported	-
Service-Identifier	Supported	-
ORA-Account-Topup	Supported	-
– ORA-Recharge-Reference	Supported	-
– ORA-Balance	Supported	-
– – ORA-Balance-Element-Id	Supported	-
– – Unit-Value	Supported	-
– – – Value-Digits	Supported	-
– – – Exponent	Supported	-
– – ORA-Validity-Start-Time	Supported	-
– – ORA-Validity-End-Time	Supported	-
– – ORA-Validity-Start-Relative	Supported	-
– – – ORA-Validity-Offset	Supported	-
– – – ORA-Validity-Unit	Supported	0 - SECONDS
		1- MINUTES
		2 - HOURS
		3 - DAYS
		4 - MONTHS
		5 - ACC_CYCLE
		6 - BILL_CYCLE
		7 - ABSOLUTE
		8 - INFINITE
– – ORA-Validity-End-Relative	Supported	-
– – – ORA-Validity-Offset	Supported	-
– – – ORA-Validity-Unit	Supported	0 - SECONDS
		1- MINUTES
		2 - HOURS
		3 - DAYS
		4 - MONTHS
		5 - ACC_CYCLE
		6 - BILL_CYCLE
		7 - ABSOLUTE
		8 - INFINITE
– – ORA-First-Usage-Validity	Supported	-
– – – ORA-Validity-Offset	Supported	-
– – – ORA-Validity-Unit	Supported	0 - SECONDS
		1- MINUTES
		2 - HOURS
		3 - DAYS
		4 - MONTHS
		5 - ACC_CYCLE
		6 - BILL_CYCLE
		7 - ABSOLUTE
		8 - INFINITE
– – ORA-Extend-Bucket-Validity	Supported	0 - FALSE
		1 - TRUE
– – Service-Identifier	Supported	-
– – Rating-Group	Supported	-
Multi-Services-Indicator	Not supported	Does not apply

Gy Top-Up Response AVPs

Table 2-9 lists the compliance information for Gy Top-Up AVPs for the response operations.

Table 2-9: Gy Top-Up Response AVPs

Diameter AVP	Status	Notes
ORA-Remaining-Balance	Supported	-
– ORA-Balance-Element	Supported	-
– ORA-Applicable-Services	Supported	-
– – Service-Identifier	Supported	-
– – Rating-Group	Supported	-
– ORA-Balance-Element	Supported	-
– – Unit-Value	Supported	-
– – – Value-Digits	Supported	-
– – – Exponent	Supported	-
– – ORA-Balance-Item	Supported	-
– – – Unit-Value	Supported	-
– – – – Value-Digits	Supported	-
– – – – Exponent	Supported	-
– – – ORA-Validity-Start-Time	Supported	-
– – – ORA-Validity-End-Time	Supported	-
– – ORA-Earliest-Expiry-Time	Supported	-
CC-Session-Failover	Supported	-
Credit-Control-Failure-Handling	Supported	-

Gy Balance Query Request AVPs

Table 2-10 lists the compliance information for Gy Balance Query AVPs for the request operations.

Table 2-10: Gy Balance Query Request AVPs

Diameter AVP	Status	Notes
CC-Request-Type	Supported	4 - EVENT_REQUEST
Requested-Action	Supported	5 - BALANCE_QUERY
Event-Timestamp	Supported	-
Subscription-Id	Supported	-
– Subscription-Id-Data	Supported	-
– Subscription-Id-Type	Supported	-
Service-Identifier	Supported	-
Rating Group	Supported	-
ORA-Balance-Query-Mode	Supported	1- Summary
		2 - Detailed
Multi-Services-Indicator	Not supported	Does not apply

Gy Balance Query Response AVPs

Table 2-11 lists the compliance information for Gy Balance Query AVPs for the response operations.

Table 2-11 Gy Balance Query Response AVPs

Diameter AVP	Status	Notes
Service-Identifier	Supported	Returned only when it is set in the original request; indicates the corresponding product for which the Balance query is returned.
Rating-Group	Supported	Returned only when it is set in the original request; indicates the corresponding product for which the Balance query is returned.
ORA-Balance-Details	Supported
– ORA-Balance-Element	Supported
—- ORA-Balance-Element-Id	Supported
—- Unit-Value	Supported
—— Value-Digits	Supported
—— Exponent	Supported
—- ORA-Earliest-Expiry-Time	Supported
—- ORA-Balance-Item	Supported
—— Unit-Value	Supported
——– Value-Digits	Supported
——– Exponent	Supported
—— ORA-Validity-Start-Time	Supported
—— ORA-Validity-End-Time	Supported
—— ORA-Consumed-Reservation-Amount	Supported
——– Value-Digits	Supported
——– Exponent	Supported
—— ORA-Active-Reservation-Amount	Supported
——– Value-Digits	Supported
——– Exponent	Supported
—- ORA-Credit-Floor	Supported
—— Value-Digits	Supported
—— Exponent	Supported
—- ORA-Credit-Ceiling	Supported
—— Value-Digits	Supported
—— Exponent	Supported
—- ORA-Percent-Credit-Threshold	Supported
—— ORA-Threshold-Value	Supported
—- ORA-Fixed-Credit-Threshold	Supported
—— ORA-Threshold-Value	Supported
CC-Session-Failover	Supported
Credit-Control-Failure-Handling	Supported

Gy Debit/Refund Request AVPs

Table 2-12 lists the compliance information for Gy Debit/Refund AVPs for the request operations.

Table 2-12: Gy Debit/Refund Request AVPs

Diameter AVP	Status	Notes
Session-Id	Supported	-
Service-Context-Id	Supported	-
CC-Request-Type	Supported	-
CC-Request-Number		-
Refund-Information	Supported	-
CC-Correlation-Id	Supported	-
Destination-Host	Not supported	-
User-Name	Not supported	Subscription-Id-Data AVP is used instead
CC-Sub-Session-Id	Not supported	-
Acct-Multi-Session-Id	Not supported	-
Origin-State-Id	Not supported	-
Event-Timestamp	Supported	-
Subscription-Id	Supported	-
– Subscription-Id-Data	Supported	-
– Subscription-Id-Type	Supported	-
Requested-Action	Supported	0 - DIRECT_DEBITING
		1 - REFUND_ACCOUNT.
		For more information, see: RFC 4006 Section 8.41
Multiple-Services-Indicator	Supported	Always expected to be True
Service-Parameter-Info	Not supported	-
User-Equipment-Info	Not supported	-
Proxy-Info	Not supported	-
Route-Record	Not supported	-
Service-Information	Supported	-
– PS-Information	Supported	-
– – Called-Station-Id	Supported	-
– – MS-TimeZone-3GPP	Supported	-
Multiple-Services-Credit-Control	Supported	See Table 2-13

Multiple-Services-Credit-Control

Table 2-13 lists compliance information for Multiple-Services-Credit-Control AVPs for Gy Debit/Refund request operations.

Table 2-13: Multiple-Services-Credit-Control AVPs for Gy Debit/Refund Request

Diameter AVP	Status	Notes
Service-Identifier	Supported	-
Rating-Group	Supported	-
Requested-Service-Unit	Supported	-
– CC-Time	Supported	-
– CC-Money	Supported	-
– – Unit-Value		-
– – – Value-Digits		-
– – – Exponent	Supported	-
– – Currency-Code	Supported	-
CC-ORA-Balance-Element	Supported	-
– – Unit-Value		-
– – – Value-Digits		-
– – – Exponent	Supported	-
– – ORA-Balance-Element-Id	Supported	-
CC-Total-Octets	Supported	-
CC-Input-Octets	Supported	-
CC-Output-Octets	Supported	-
CC-Service-Specific-Units	Supported	-

Gy Debit/Refund Response AVPs

Table 2-14 lists the compliance information for Gy Debit/Refund AVPs for the response operations.

Table 2-14: Gy Debit/Refund Response AVPs

Diameter AVP	Status	Notes
Session-Id	Supported	-
Result-Code	Supported	-
Remaining-Balance	Supported	-
Cost-Information	Supported	-
ORA-Customer-Cost-Information	Supported	-
CC-Session-Failover	Supported	-
Credit-Control-Failure-Handling	Supported	-
Direct-Debiting-Failure-Handling	Supported	-
Multiple-Services-Credit-Control	Supported	See Table 2-15

Multiple-Services-Credit-Control

Table 2-15 lists the compliance information for Multiple-Services-Credit-Control AVPs for Gy Debit/Refund response operations.

Table 2-15: Multiple-Services-Credit-Control AVPs for Gy Debit/Refund Response

Diameter AVP	Status	Notes
Result-Code	Supported	-
Service-Identifier	Supported	-
Rating-Group	Supported	-
Refund-Information	Supported	Only for refund
Granted-Service-Units	Supported	Supplied only in a debit response
Requested-Service-Unit	Supported	Contains the AVPs submitted in the message request
ORA-Remaining-Balance	Supported	-
ORA-Customer-Cost-Information	Supported	-
ORA-Cost-Information	Supported	-
ORA-Subscriber-Id	Supported	-
ORA-Balance-Element	Supported	-
ORA-Balance-Element-Id	Supported	-
CC-Time	Supported	-
CC-Money	Supported	-
Unit-Value	Supported	-
Value-Digits	Supported	-
Exponent	Supported	-
Currency-Code	Supported	-
CC-Total-Octets	Supported	-
CC-Input-Octets	Supported	-
CC-Output-Octets	Supported	-
CC-Service-Specific-Units	Supported	-

Gy Price Enquiry Request AVPs

Table 2-16 lists the compliance information for Gy Price Enquiry AVPs for the request operations.

Table 2-16: Gy Price Enquiry Request AVPs

Diameter AVP	Status	Notes
Session-Id	Supported	-
Service-Context-Id	Supported	-
CC-Request-Type	Supported	-
CC-Request-Number	Supported	-
Destination-Host	Not supported	-
User-Name	Not supported	Subscription-Id-Data AVP is used instead.
CC-Sub-Session-Id	Not supported	-
Acct-Multi-Session-Id	Not supported	-
Origin-State-Id	Not supported	-
Event-Timestamp	Supported	-
Subscription-Id	Supported	-
– Subscription-Id-Data	Supported	-
– Subscription-Id-Type	Supported	-
Requested-Action	Supported	3 - PRICE_ENQUIRY
Multiple-Services-Indicator	Supported	Always expected to be True
Service-Information	Supported	-
– PS-Information	Supported	-
– – Called-Station-Id	Supported	-
– – SGSN-Address	Supported	-
– – GGSN-Address	Supported	-
– – MS-TimeZone-3GPP	Supported	-
– – Diagnostics	Supported	-
Service-Parameter-Info	Not supported	-
CC-Correlation-Id	Not supported	-
User-Equipment-Info	Not supported	-
Proxy-Info	Not supported	-
Multiple-Services-Credit-Control	Supported	See Table 2-17

Multiple-Services-Credit-Control

Table 2-17 lists the compliance information for Multiple-Services-Credit-Control AVPs for Gy price enquiry request operations.

Table 2-17: Multiple-Services-Credit-Control AVPs for Gy Price Enquiry Request

Diameter AVP	Status	Notes
Multiple-Services-Credit-Control	Supported	-
– Service-Identifier	Supported	-
– Rating-Group	Supported	-
– Requested-Service-Unit	Supported	-
– – CC-Time	Supported	-
– – CC-Input-Octets	Supported	-
– – CC-Output-Octets	Supported	-
– – CC-Total-Octets	Supported	-

Gy Price Enquiry Response AVPs

Table 2-18 lists the compliance information for Gy Price Enquiry AVPs for the response operations.

Table 2-18: Gy Price Enquiry Response AVPs

Diameter AVP	Status	Notes
Session-Id	Supported	-
Result-Code	Supported	-
Multiple-Services-Credit-Control	Supported	See Table 2-19
Cost-Information	Supported	-
– Unit-Value	Supported	-
– – Value-Digits	Supported	-
– – Exponent	Supported	-
– Currency-Code	Supported	-
CC-Session-Failover	Supported	-
Credit-Control-Failure-Handling	Supported	-

Multiple-Services-Credit-Control

Table 2-19 lists the compliance information for Multiple-Services-Credit-Control AVPs for Gy Price Enquiry response operations.

Table 2-19: Multiple-Services-Credit-Control AVPs for Gy Price Enquiry Response

Diameter AVP	Status	Notes
– Service-Identifier	Supported	-
– Rating-Group	Supported	-
– Requested-Service-Unit	Supported	-
– – CC-Time	Supported	-
– – CC-Input-Octets	Supported	-
– – CC-Output-Octets	Supported	-
– – CC-Total-Octets	Supported	-
– ORA-Customer-Cost-Information	Supported	-
– – ORA-Subscriber-Id	Supported	-
– – ORA-Cost-Information	Supported	-
– – – Unit-Value	Supported	-
– – – – Value-Digits	Supported	-
– – – – Exponent	Supported	-
– – – ORA-Balance-Element-Id	Supported	-

Diameter Session Reauthorization Commands

Table 2-20 lists the compliance information for Diameter Session Reauthorization commands.

Table 2-20: Diameter Session Reauthorization Commands

Diameter Command	Status	Notes
Re-Auth-Request (RAR)	Supported	-
Re-Auth-Answer (RAA)	Supported	-

Re-Auth-Request AVPs

Table 2-21 lists the compliance information for Re-Auth-Request (RAR) AVPs.

Table 2-21: Re-Auth-Request AVPs

Diameter AVP	Status	Notes
Session-Id	Supported	-
Origin-Host	Supported	-
Origin-Realm	Supported	-
Destination-Host	Supported	-
Destination-Realm	Supported	-
Origin-State-Id	Supported	-
Service-Identifier	Supported	-
Rating-Group	Supported	-

Re-Auth-Answer AVPs

Table 2-22 lists the compliance information for Re-Auth-Answer (RAA) AVPs.

Table 2-22: Re-Auth-Answer AVPs

Diameter AVP	Status	Notes
Session-Id	Supported	-
Origin-Host	Supported	-
Origin-Realm	Supported	-
Result-Code	Supported	-

Diameter Session Termination Commands

Table 2-23 lists the compliance information for Diameter Session Termination commands.

Table 2-23: Diameter Session Termination Commands

Diameter Command	Status	Notes
Session-Termination-Request	Supported	-
Session-Termination-Answer	Supported	-

Session-Termination-Request AVPs

Table 2-24 lists the compliance information for Session-Termination-Request (STR) AVPs.

Table 2-24: Session-Termination-Request AVPs

Diameter AVP	Status	Notes
Session-Id	Supported	-

Session-Termination-Answer AVPs

Table 2-25 lists the compliance information for Session-Termination-Answer (STA) AVPs.

Table 2-25: Session-Termination-Answer AVPs

Diameter AVP	Status	Notes
Session-Id	Supported	-
Result-Code	Supported	-
Failed-AVP	Supported	-

Diameter Gx Protocol

The Gx application is characterized as a specialized Diameter application for specific vendors. Within the context of the Diameter protocol over the Gx interface, the 7x50 (Policy and Charging Enforcement Function, PCEF) functions as a Diameter Client, whereas the Policy and Charging Rules Function (PCRF) serves as a Diameter Server. The Gx Diameter Application incorporates existing Command Codes from both the Diameter Base Protocol (as per RFC 6733) and the Diameter Credit Control Application (according to RFC 4006).

For its data representation in messaging structures (specifically, command codes), Gx employs Attribute-Value Pairs (AVPs).

The origins of AVPs in Gx are diverse, including:

AVPs unique to Gx, as specified in the 3GPP Gx document TS 29.212.
AVPs borrowed from other Diameter applications (e.g., RFC 4006, RFC 4005), other 3GPP specifications, the European Telecommunications Standards Institute (ETSI), and so forth.
Attributes recycled from RADIUS (with AVP codes 0-255 earmarked for these reused attributes).
AVPs that are vendor-specific.

The process to initiate and sustain the connection between the 7x50 (PCEF) and the PCRF is governed by the foundational Diameter protocol, outlined in RFC 3588/6733.

Gx AVP

This guide offers a summary of the Gx Attribute Value Pairs (AVP) supported by the 7750 SR. The implementation follows the specification on Gx Release v11.12, doc 3GPP 29212-bc0.doc.

Table 1 shows the conventions used in this guide.

Table 1-1: Attribute Conventions

Attribute	Description
0	This attribute must not be present in packet.
0+	Zero or more instances of this attribute may be present in packet.
0-1	Zero or one instance of this attribute may be present in packet.
1	Exactly one instance of this attribute must be present in packet.

AVPs

Certain AVPs are applicable in only one direction, while others are applicable to both directions.

AVPs sent by the 7750 SR are used to:

inform the PCRF of the host creation/termination and the subscriber host identity in the 7750 SR
inform the PCRF of the functionality supported in the 7750 SR
report specific events related to the subscriber-host
report the status of the rules
report usage monitoring
report status of the host (existent/non-existent)

AVPs sent by PCRF toward the 7750 SR are used to:

install or activate policies
request usage monitoring
terminate the subscriber-host
request status of the subscriber-host (existent/non-existent)

AVPs that apply to both directions are used for base Diameter functionality such as peering establishment, routing of the Diameter messages, session identification and reporting of catastrophic failures (OSI change).

Reserved Keywords in the 7750 SR

The reserved keywords used to identify referenced object type within the 7750 SR are listed in Table 1-2. See Table 1-4 for further reference.

Table 1-2: Reserved Keywords in the 7750 SR

Reserved Keywords	Used in AVP	Comments
ingr-v4	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
ingr-v6	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
egr-v4	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
egr-v6	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
in-othr-v4	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
in-othr-v6	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
sub-id	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
sla-profile	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
sub-profile	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
inter-dest	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
cat-map	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
aa-functions	adc-rule-name, charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.
aa-functions:app	charging-rule-name	Used to identify the AA app-profile directly in the charging-rule-name AVP in a charging-rule-install. See Table 1-4 and Table 1-5.
aa-functions:aso	charging-rule-name	Used to identify the AA ASO characteristic and value directly in a charging-rule-name AVP in a charging rule-install. Table 1-4 and Table 1-5.
aa-functions:urlparam	charging-rule-name	Used to identify the AA Sub HTTP URL parameter directly in a charging-rule-name AVP in a charging rule-install. See Table 1-4 and Table 1-5.
aa-functions:subscope	charging-rule-name	Used to identify the AA Sub scope directly in a charging-rule-name AVP in a charging rule-install. See Table 1-4 and Table 1-5.
aa-um	charging-rule-name	Used to identify referenced object type within 7x50. See Table 1-3.

Standard Diameter AVPs

AVPs apply in the following applications:

Gx-PM-ESM — Policy Management for Enhanced Subscriber Management
Gx-UM-ESM — Usage Monitoring for Enhanced Subscriber Management
Gx-PM-AA — Policy Management for Application Assurance
Gx-UM-AA — Usage Monitoring Application Assurance

The AVPs listed in following Table 1-3 that do not have an associated application are AVPs that are used for generic purposes and their use can extend through all applications.

Table 1-3: Description of Standard Diameter AVPs

AVP ID	AVP Name	Section Defined	Application	Description
5	NAS-Port	RFC 2865 / §5.5		See the 7750 SR and VSR RADIUS Attributes Reference Guide.
8	Framed-IP-Address	RFC 4005 / §6.11.1		This AVP specifies the IPv4 address of the subscriber host. The IPv4 address is obtained before Gx session establishment. The IPv4 address cannot be assigned to the subscriber host by PCRF via Gx but is instead used only for reporting.
18	3GPP-SGNS-MCC-MNC	29.061		For GTP S11 Access contains the value configured under configure>subscriber-mgmt>gtp>serving-network.
22	3GPP-User-Location-Info	29.061		In CCR-I, this contains the User Location Information as signaled in the incoming GTP-C message for GTP Access hosts.
				For a CCR-U triggered by either USER_LOCATION_CHANGE (ULC), ECGI_CHANGE, or TAI_CHANGE will include ULI values as follows:
				- If the trigger was ULC and the ULI contains anything other than ECGI or TAI, the ULI is signaled as received in GTP.
				- If the trigger was ULC and either TAI or ECGI changed from its last known value, both TAI and ECGI will be included.
				- If the trigger was ECGI_CHANGE and ECGI changed from its last known value, ECGI is included.
				- If the trigger was TAI_CHANGE and TAI change from its last known value, TAI is included.
25	Class	RFC 2865 / §5.25		This attribute is available to be sent by the PCRF to the 7750 SR and is echoed unmodified by the 7750 SR to the PCRF. The 7750 SR does not interpret this attribute locally.
30	Called-Station-Id	RFC 2865 / §5.30	RFC 4005 / §4.5	See the 7750 SR and VSR RADIUS Attributes Reference Guide.
31	Calling-Station-ID	RFC 4005 / §4.6		See the 7750 SR and VSR RADIUS Attributes Reference Guide.
55	Event-Timestamp	RFC 6733 / §8.21		This AVP records the time that this event occurred on the 7750 SR, in seconds since January 1, 1900 00:00 UTC.
61	NAS-Port-Type	RFC 2865 / §5.41	RFC 4005 / §4.4	RFC 4603
				See the 7750 SR and VSR RADIUS Attributes Reference Guide.
87	NAS-Port-Id	RFC 2869 / §5.17	RFC 4005 / §4.3	See the 7750 SR and VSR RADIUS Attributes Reference Guide.
92	NAS-Filter-Rule	RFC 4849	Gx-PM-ESM	See the 7750 SR and VSR RADIUS Attributes Reference Guide.
				This AVP is nested within the Charging-Rule-Definition AVP.
97	Framed-IPv6-Prefix	RFC 4005 / §6.11.6		This AVP specifies the IPv6-prefix and prefix-length that is assigned to the host via SLAAC (Router Advertisement) to the WAN side of the user.
				The IPv6-prefix and prefix-length is obtained before Gx session establishment.
				The facilities to provide the IPv6-prefix and prefix-length to the subscriber-host are DHCP server/local pools, RADIUS or LUDB.
				The IPv6-prefix/prefix-length cannot be assigned to the subscriber host by PCRF via Gx. Instead the IPv6-prefix and prefix-length is the one being reported to the PCRF during the host instantiation phase.
123	Delegated-IPv6-Prefix	RFC 4818		This attribute carries the Prefix (ipv6-prefix/prefix-length) assigned to the host via DHCPv6 (IA-PD) for the LAN side of the user (IPoE, PPPoE).
				The IPv6-prefix/prefix-length is obtained before Gx session establishment.
				The facilities to provide the IPv6-prefix/prefix-length to the subscriber-host are DHCP server/local pools, RADIUS or LUDB.
				The IPv6-prefix/prefix-length cannot be assigned to the subscriber host by PCRF via Gx. Instead the IPv6-prefix and prefix-length is the one being reported to the PCRF during the host instantiation phase.
257	Host-IP-Address	RFC 6733 / §5.3.5		This AVP is used to inform a Diameter peer of the sender’s IP address.
				The IPv4 address used is the one configured in the diameter-peer-policy. If none is configured, then system-ip address is used.
258	Auth-Application-Id	RFC 6733 / §6.8		This AVP indicates supported Diameter applications.
				The application support is exchanged in CER/CEA when the peering sessions is established.
				The diameter base protocol does not require application ID because its support is mandatory.
				The Gx application ID value is 16777238 and it is advertised in Auth-Application-Id AVP within the grouped Vendor-Specific-Application-Id AVP in CER message.
				In addition, each Gx specific message carries Auth-Application-Id AVP with the value of 16777238.
260	Vendor-Specific-Application-Id	RFC 6733 / §6.11		This is a Grouped AVP that is used to advertise support of a vendor-specific Diameter application in CER/CEA messages. Gx is one such application. This AVP contains the Vendor-Id AVP of the application and the auth-application-id AVP.
263	Session-id	RFC 6733 / §8.8		This AVP must be present in all messages and it is used to identify a specific IP-Can session. IP-Can session corresponds to a subscriber host, which can be DHCPv4/v6, PPPoX or ARP host. Session-id AVP is unique per host.
				Dual stack host (IPoE or PPPoX) share a single session-id.
264	Origin-Host	RFC 6733 / §6.3		This AVP must be present in all messages and it is used to identify the endpoint (Diameter peer) that originated the message.
265	Supported-Vendor-Id	RFC 6733 / §5.3.6		This AVP is used in CER/CEA messages to inform the peer that the sender supports a subset of the vendor-specific AVPs defined by the vendor identified in this AVP.
266	Vendor-Id	RFC 6733 / §5.3.3		The value of this AVP is the IANA assigned code to a specific vendor.
				This AVP may be part of the Vendor-Specific-Application-Id AVP, Failed-AVP AVP, Experimental-Result AVP to identify the vendor associated with the relevant message/AVP.
				In case of a standalone Vendor-Id AVP (outside of any grouped AVP) that is conveyed in CER/CEA messages, it is envisioned that this AVP along with the Product-Name AVP and the Firmware-Revision AVP may provide useful debugging information.
267	Firmware-Revision	RFC 6733 / §5.3.4		The SR OS version is reported.
268	Result-Code	RFC 6733 / §7.1		This AVP indicates whether a particular request was completed successfully or an error occurred.
				All answer messages in Diameter/Gx must include one Result-Code AVP or Experimental-Result AVP.
269	Product-Name	RFC 6733 / §5.3.7		This AVP specifies the vendor-assigned name.
278	Origin-State-Id	RFC 6733 / §8.16		This AVP is used to inform the PCRF of the loss of the state on the 7750 SR side. Its value monotonically increases each time the PCRF is rebooted with the loss of the previous state.
				Because Gx sessions are not persistent in the 7750 SR, Origin-State-Id increases each time the 7750 SR is rebooted.
279	Failed-AVP	RFC 6733 / §7.5		This is a Grouped AVP that provides debugging information in cases where a request is rejected or not fully processed because of the erroneous information in specific AVP. The value of the Result-Code AVP will provide information about the reason for the Failed-AVP AVP. The Failed-AVP AVP contains the entire AVP that could not be processed successfully.
281	Error-Message	RFC 6733 / §7.3		This AVP provides more information of the failure that is indicated in the Result-Code AVP.
282	Route Record	RFC 6733 / §6.7.1		This AVP identifies the peer from which the request is received and is used for routing loop detection. An SR node inserts the origin-host of the peer in the Route-Record AVP of all transit request messages.
283	Destination-Realm	RFC 6733 / §6.6		This AVP represents the realm to which this message is to be routed.
285	Re-Auth-Request-Type	RFC 6733 / §8.12		This AVP is mandatory in RAR requests. The content of this AVP is ignored by the 7750 SR.
293	Destination-Host	RFC 6733 / §6.5		This AVP represents the host to which this message is to be sent.
				The value of this AVP can be explicitly configured.
				In case that it is omitted, the DRA (Diameter relay-agent) that receives the message selects the destination host to which the message is sent.
295	Termination-Cause	RFC 6733 / §8.15		This AVP is used to indicate the reason why a session was terminated on the 7750 SR.
296	Origin-Realm	RFC 6733 / §6.4		This AVP contains the realm of the originator of message. In the 7750 SR, the Origin-Realm is explicitly configured per Diameter peer.
297	Experimental-Result	RFC 6733 / §7.6		This is a Grouped AVP that indicates whether a particular vendor-specific request completed successfully or whether an error occurred. It contains a vendor-assigned value representing the result of processing a request.
				The result-code AVP values defined in Diameter Base RFC (6733, §7.1) are also applicable to Experimental-Result AVP.
				For a list of Gx-specific Experimental-Result-Code values supported in the 7750 SR, see Table 10. For Gx application, the Vendor-Id AVP is set to 10415 (3GPP).
				All answer messages defined in vendor-specific application must include either one Result-Code AVP or one Experimental-Result AVP.
298	Experimental-Result-Code	RFC 6733 / §7.7	29.214 / §5.5	This AVP specifies vendor-assigned (3GPP — Gx) values representing the result of processing the request.
				For a list of the 7750 SR supported values for Gx see Table 1-10.
302	Logical-Access-Id	ETSI TS 283 034 / §7.3.3	BBF TR-134 (§7.1.4.1)	This AVP contains information describing the subscriber agent circuit identifier corresponding to the logical access loop port of the Access Node from which the subscriber’s requests are initiated, namely: circuit-id from DHCPv4 Option (82,1) circuit-id from PPPoE tag (0x105, 0x00000de9 [dsl forum], 0x01 — DSL Forum TR-101) interface-id from DHCPv6 option 18. The Vendor-Id in CER is set to ETSI (13019).
313	Physical-Access-Id	ETSI TS283 034 / §7.3.14	BBF TR-134 (§7.1.4.1)	This AVP contains information about the identity of the physical access to which the user device is connected, namely: remote-id from DHCPv4 Option (82,2) remote-id from PPPoE tag (0x105, 0x00000de9 [dsl forum], 0x02 — DSL Forum TR-101) remote-id from DHCPv6 option 37. The Vendor-Id in CER is set to ETSI (13019).
412	CC-Input-Octets	RFC 4006 / §8.24	Gx-UM-ESM Gx-UM-AA	This AVP contains the number of requested, granted or used octets from the user.
414	CC-Output-Octets	RFC 4006 / §8.25	Gx-UM-ESM Gx-UM-AA	This AVP contains the number of requested, granted or used octets toward the user.
415	CC-Request-Number	RFC 4006 / §8.2		This AVP identifies each request within one session. Each request within a session has a unique CC-Request-Number that is used for matching requests with answers.
416	CC-Request-Type	RFC 4006 / §8.3		This AVP identifies the request type: INITIAL_REQUEST (CCR-I) UPDATE_REQUEST (CCR-U) TERMINATION_REQUEST (CCR-T)
418	CC-Session-Failover	RFC 4006 / §8.4		This AVP controls whether the secondary peer will be used in case that the primary peer is unresponsive (peer failover behavior). The unresponsiveness is determined by the timeout of the previously sent message. If this AVP is not supplied via PCRF, the locally configured options in the 7750 SR will determine the peer failover behavior. For further details on the peer failover behavior, see “Gx Fallback Function” section in the Gx Configuration Guide.
421	CC-Total-Octets	RFC 4006 / §8.23	Gx-UM-ESM Gx-UM-AA	This AVP contains the number of requested, granted or used octets regardless of the direction (sent or received).
427	Credit-Control-Failure-Handling	RFC 4006 / §8.14		This AVP controls whether the subscriber is terminated or instantiated with default parameters in case that the PCRF is unresponsive. The unresponsiveness is determined by the timeout of the previously sent message. If this AVP is not supplied via PCRF, the locally configured options in the 7750 SR determines the behavior. For further details, see the “Gx Fallback Function” section in the Gx Configuration Guide.
431	Granted-Service-Unit	RFC 4006 / §8.17	Gx-UM-ESM Gx-UM-AA	This grouped AVP is sent by PCRF to the 7750 SR for usage monitoring purposes. When the granted amount of units is consumed by the user, a report is sent from the 7750 SR to the PCRF. The amount of consumed units can be measured on three different levels: Session level (host level) PCC rule level (credit category in the 7750 SR) ADC rule level (AA level in the 7750 SR)
433	Redirect-Address-Type	RFC 4006 / §8.38	Gx-PM-ESM	This AVP specifies the address type of the HTTP redirect server. URL (2) type is the only address type supported in the 7750 SR.
435	Redirect-Server-Address	RFC 4006 / §8.39	Gx-PM-ESM	This AVP specifies the URL string of the redirect server.
443	Subscription-Id	RFC 4006 / §8.46		This AVP is of type Grouped and is used to identify the subscriber host in the 7750 SR. The nested AVPs are subscription-id-data and subscription-id-type.
444	Subscription-Id-Data	RFC 4006 / §8.48		This AVP is part of the subscription-id AVP and is used to identify the host by: Circuit-id Dual-stack-remote-id Imei Imsi Mac of the host Msisdn Subscriber-id Username (ppp-username or a string returned in the Username attribute via RADIUS or NASREQ) Subscription type (subscription-id-type AVP) has to be explicitly set via CLI. The data will be formatted according to the type set. For GTP S11 access, the value under configure>subscriber-mgmt>diameter-application-policyapplication-policy-name>gxavp-subscription-id is ignored and the session always includes two subscription-Id AVPs for both IMSI and MSISDN.
446	Used-Service-Unit	RFC 4006 / §8.19	Gx-UM-ESM Gx-UM-AA	This AVP is of type Grouped and it represents the measured volume threshold for usage monitoring control purposes. It is sent in the Usage-Monitoring-Report AVP from the 7750 SR to the PCRF when the granted unit threshold is reached or in response to a usage-report request from the PCRF.
450	Subscription-Id-Type	RFC 4006 / §8.47		This AVP is used to determine which type of identifier is carried by the subscription-id AVP. The following formats (types) are supported in the 7750 SR: E.164 format (ITU-T E.164) IMSI format (ITU-T E.212) NAI format (RFC 2486) Private format
458	User-Equipment-Info	RFC 4006 / §8.49		This is a Grouped AVP that carries information about the identity and the capabilities of the host.
459	User-Equipment-Info-Type	RFC 4006 / §8.50		This AVP is nested within the User-Equipment-Info AVP. The following types are supported in the 7750 SR: IMEISV – contains the IMEI and software version according to 3GPP TS 23.003 document. MAC address Eui64 based on 48-bit MAC address with 0xfffe inserted in the middle. Modified_eui64 — similar to eui64 but with inverted ‛u’ bit as defined in: http://standards.ieee.org/develop/regauth/tut/eui64.pdf and RFC 4291. The equipment type must be explicitly set through the CLI. For GTP S11 access, the configuration is ignored and always uses IMEISV.
460	User-Equipment-Info-Value	RFC 4006 / §8.51		This AVP carries the value that is defined by the User-Equipment-Info-Type AVP.
507	Flow-Description	29.214 / §5.3.8	Gx-PM-ESM	This AVP is nested within Flow-Information AVP. It identifies traffic within the PCC rule based on the 5 tuple.
511	Flow-Status	29.214 / §5.3.11	Gx-PM-ESM	This AVP is used to set the service gating action for the service represented by the PCC rule. It is nested inside of Charging-Rule-Definition AVP. Supported values are: ENABLED (2) DISABLED (3) The service identified by PCC rule is by default enabled (Flow-Status = ENABLED). If explicitly configured within the PCC rule, it must be accompanied with one or more additional actions. Otherwise, the entire PCC rule instantiation fails. Flow-Status = DISABLED can be the sole action within the PCC rule. Traffic associated with this action, is dropped.
515	Max-Requested-Bandwidth-DL	29.214 / §5.3.14	Gx-PM-ESM	Depending on the context in which it is configured (nested), this AVP represents the egress PIR of a queue or a policer.
516	Max-Requested-Bandwidth-UL	29.214 / §5.3.15	Gx-PM-ESM	Depending on the context in which it is configured (nested), this AVP represents the ingress PIR of a queue or a policer.
554	Extended-Max-Requested-BW-DL	29.214 / §5.3.52	Gx-PM-ESM	For higher rate requirements, this AVP can be used in place of the Max-Requested-Bandwidth-DL AVP.
555	Extended-Max-Requested-BW-UL	29.214 / §5.3.52	Gx-PM-ESM	For higher rate requirements, this AVP can be used in place of the Max-Requested-Bandwidth-UL AVP.
628	Supported-Features	29.229 / §6.3.29	29.212 / §5.4.1	This is a Grouped AVP that is used during Gx session establishment to inform the destination host about the required and optional features that the origin-host supports. One instance of Supported-Features AVP is needed per Feature-List-id.
629	Feature-List-Id	29.229 / §6.3.30		This AVP contains the identity of a feature list. This AVP allows differentiation between multiple feature lists in case that an application has multiple feature lists defined.
630	Feature-List	29.229 / §6.3.31		This AVP contains a bitmask indicating the supported feature in Gx. The Gx features in the Feature-List AVP are defined in 3GPP TS 29.212, §5.4.1.
909	RAI	29.061		For GTP S11 access, this contains the RAI if it was signaled in GTP.
1001	Charging-Rule-Install	29.212 / §5.3.2		This AVP is of type Grouped and is used to enforce overrides, install NAS filter inserts and install or modify PCC rules in the node as instructed by PCRF.
1002	Charging-Rule-Remove	29.212 / §5.3.3		This AVP is of type Grouped and is used to remove PCC rules from an IP CAN session.
1003	Charging-Rule-Definition	29.212 / §5.3.4		This AVP is of type Grouped and is used for rule overrides, NAS filter inserts or PCC rules installation. It contains nested AVPs that define the overrides (rate changes of a subscriber, a queue or a policer, and so on), NAS filter insert or a completely new PCC rule definition.
1005	Charging-Rule-Name	29.212 / §5.3.6		This AVP is used to reference a predefined rule in the node, name the PCC rule which is defined through Charging-Rule-Definition AVP, and report rule/override status in case of a rule/override activation failure.
1006	Event-Trigger	29.212 / §5.3.7		This AVP can be sent from the PCRF to subscribe to a particular event in the 7750 SR.
1010	Precedence	29.212 / §5.3.11	Gx-PM-ESM	This AVP is carried within a PCC rule definition (Charging-Rule-Definition) and it determines the order in which PCC rules are installed for the subscriber-host.
1014	ToS-Traffic-Class	29.214 / §5.3.15	Gx-PM-ESM	This AVP is nested within Flow-Information AVP. It identifies traffic within the PCC rule based on DSCP bits.
1016	QoS-Information	29.212 / §5.3.16	Gx-PM-ESM	This AVP has a multi-faceted function: As part of PCC rule definition in CCA or RAR, this AVP is used to rate-limit a flow. The AVP defines QoS overrides that can be submitted from PCRF to the SR OS router in a CCA or RAR message. The AVP defines APN Uplink and Downlink Aggregate Maximum Bitrate (AMBR) in a CCA or RAR message.
1018	Charging-Rule-Report	29.212 / §5.3.18		This AVP is of type Grouped and is used to report the status of PCC rules in the 7750 SR.
1019	PCC-Rule-Status	29.212 / §5.3.19		This AVP describes the status of the rules as active or inactive and is nested within the Charging-Rule-Report AVP.
1025	Guaranteed-Bitrate-DL	29.212 / §5.3.25	Gx-PM-ESM	Depending on the context in which it is configured (nested), this AVP represents the egress CIR of a queue or a policer.
1026	Guaranteed-Bitrate-UL	29.212 / §5.3.26	Gx-PM-ESM	Depending on the context in which it is configured (nested), this AVP represents the ingress CIR of a queue or a policer.
1027	IP-CAN-Type	29.212 / §5.3.27		This AVP indicates the type of Connectivity Access Network in which the user is connected.
1028	QoS-Class-Identifier	29.212 / §5.3.17		This AVP identifies a QoS forwarding class within the router.
1031	Rule-Failure-Code	29.212 / §5.3.38		This AVP is sent from the router to the PCRF within a Charging-Rule-Report or ADC-Rule-Report AVP to identify the reason a rule is being reported.
1032	RAT-Type	29.212 / §5.3.31		This AVP identifies the radio access technology used for this connection.
1040	APN-Aggregate-Max-Bitrate-DL	29.212		When received in an RAR or CCA, this value can be mapped to a local egress QoS override.
1045	Session-Release-Cause	29.212 / §5.3.33	Gx-PM-ESM	Gx-PM-AA
1050	AN-GW-Address	29.212 / §5.3.49		This AVP is the system IPv4 address of the 7750 SR.
1058	Flow-Information	29.212 / §5.3.53	Gm-PM-ESM	This is a Grouped AVP carrying information about traffic identification with the PCC rule. This AVP is nested within Charging-Rule-Definition AVP.
1065	PDN-Connection-ID	29.212		For GTP S11, the access value contains the APN as received in GTP.
1066	Monitoring-Key	29.212 / §5.3.59	Gx-UM-ESM	Gx-UM-AA
1067	Usage-Monitoring-Information	29.212 / §5.3.60	Gx-UM-ESM	Gx-UM-AA
1068	Usage-Monitoring-Level	29.212 / §5.3.61	Gx-UM-ESM	Gx-UM-AA
1069	Usage-Monitoring-Report	29.212 / §5.3.62	Gx-UM-ESM	Gx-UM-AA
1070	Usage-Monitoring-Support	29.212 / §5.3.63	Gx-UM-ESM	Gx-UM-AA
1080	Flow-Direction	29.212 / §5.3.65	Gx-PM-ESM	This AVP is nested within the Flow-Information AVP. It identifies the direction in which the PCC rule is applied (ingress or egress).
1085	Redirect-Information	29.212 / §5.3.82	Gx-PM-ESM	This is a Grouped AVP that contains HTTP redirect information.
1086	Redirect-Support	29.212 / §5.3.83	Gx-PM-ESM	This AVP is nested inside of Redirect-Information AVP.
1088	TDF-Application-Identifier	29.212 / §5.3.77	Gx-UM-AA	This AVP is of type OctetString.
1092	ADC-Rule-Install	29.212 / §5.3.85	Gx-PM-AA	Gx-UM-AA
1093	ADC-Rule-Remove	29.212 / §5.3.86	Gx-PM-AA	Gx-UM-AA
1094	ADC-Rule-Definition	29.212 / §5.3.87	Gx-PM-AA	Gx-UM-AA
1096	ADC-Rule-Name	29.212 / §5.3.89	Gx-PM-AA	Gx-UM-AA
1097	ADC-Rule-Report	29.212 / §5.3.90	Gx-PM-AA	Gx-UM-AA
2848	Extended-APN-AMBR-DL	29.212 / §5.3.134		For higher rate requirements, this AVP can be used in place of the APN-Aggregate-Max-Bitrate-DL AVP.
2849	Extended-APN-AMBR-UL	29.212 / §5.3.135		For higher rate requirements, this AVP can be used in place of the APN-Aggregate-Max-Bitrate-UL AVP.
2850	Extended-GBR-DL	29.212 / §5.3.136	Gx-PM-ESM	For higher rate requirements, this AVP can be used in place of the Guaranteed-Bitrate-DL AVP.
2851	Extended-GBR-UL	29.212 / §5.3.137	Gx-PM-ESM	For higher rate requirements, this AVP can be used in place of the Guaranteed-Bitrate-UL AVP.

Standard Diameter AVPs (format)

Table 1-4 lists standard diameter AVPs.

Incl/Excl – The attribute can be suppressed via CLI.

Flags (as set by the 7750 SR when the AVP is constructed):

V — Vendor specific bit
M — Mandatory bit
P — This bit is always set to 0

UTF8String is a human-readable string using UTF-8 transformation format (which is for 7-bit encoding the same as US-ASCII).

OctetString is a basic data type which contains an arbitrary data. For example, Charging-Rule-Name AVP is OctetString according to RFC 6733 but in the 7750 SR it is displayed as readable string (UTF8String).

Flags for Gx specific AVPs are defined in RFC 6733, §4.5; 29.212, §5.3.

Flags for the Gx re-used AVPs are set as described in RFC 6733, §4.5 and in 3GPP 29.219, §5.4 — ‟The AVPs from Diameter base protocol are not included in Table 5.4, but they are re-used for the Gx reference point. Unless otherwise stated, re-used AVPs shall maintain their ‘M’, ‘P’ and ‘V’ flag settings. Where 3GPP RADIUS AVPs are re-used, unless otherwise stated, they shall be translated to Diameter AVPs as described in RFC 4005 [12] with the exception that the ‘M’ flag shall be set and the ‘P’ flag may be set”.

NA — This keyword (Not Advertised) denotes that the AVP is not originated by the 7750 SR and therefore the 7750 SR does not set the flag bits. However, the 7750 SR recognizes the AVPs and corresponding values listed in the table, regardless of the M-bit flags set by PCRF. However, if the V-bit is present in the received AVP, then the Vendor-Id filed in the AVP layout also must be present and set to the correct value because the AVP with V-bit set is identified by the <avp-id, vendor-id> pair.

Table 1-4: Standard Diameter AVPs (format)

AVP ID	AVP Name	Incl/ Excl	Type	Flags	Limits	Format
5	NAS-Port	Yes	Unsigned32	M	4 octets	See the 7750 SR and VSR RADIUS Attributes Reference Guide.
8	Framed-IP-Address	No	OctetString	M	4 octets	Example: ip-address 10.11.12.13 Framed-IP-Address = 0a0b0c0d As defined in RFC 4005, §6.11.1.
22	3GPP-User-Location-Info	Yes	OctetString	V	—	Vendor-Id = 10415 (3GPP) See 3GPP TS 29.061 for encoding details.
30	Called-Station-Id	Yes	UTF8String	M	64 chars	Example: Called-Station-Id = mac:ssid or mac only if ssid is not available.
31	Calling-Station-ID	Yes	UTF8String	M	64 chars	Example: llid
55	Event-Time stamp	No	Time	M	4 octets	See the 7750 SR and VSR RADIUS Attributes Reference Guide.
61	NAS-Port-Type	Yes	Enumerated	M	4 octets	The values for this attribute are defined in the RFC 2865, 4005 and 4603. See the 7750 SR and VSR RADIUS Attributes Reference Guide.
87	NAS-Port-Id	Yes	UTF8String	M	253 octets	See the 7750 SR and VSR RADIUS Attributes Reference Guide.
92	NAS-Filter-Rule	NA	UTF8String	NA	Max 10 attributes per message or max 10 filter entries per message.	See the 7750 SR and VSR RADIUS Attributes Reference Guide.
97	Framed-IPv6-Prefix	No	OctetString	M	—	SLAAC wan-host <ipv6-prefix/prefix-length> with prefix-length 64 The AVP layout is: <1 octet Reserved> <1 octet Length> <max 16 octets for Prefix>
123	Delegated-IPv6-Prefix	No	OctetString	M	—	<ipv6-prefix/prefix-length> with prefix-length [48 to 64] The AVP layout is: <1 octet Reserved> <1 octet Length> <max 16 octets for Prefix>
257	Host-IP-Address	No	Address	M	—	IPv4 Address
258	Auth-Application-Id	No	Unsigned32	M	—	Example: Gx Auth-Application-Id = 16777238
260	Vendor-Specific-Application-Id	No	Grouped	M	—	This AVP contains the Vendor-Id AVP and Auth-Application-Id AVP. For Gx, the Vendor-Id = 10415 (3GPP) and the Auth-Application-Id = 16777238.
263	Session-id	No	UTF8String	M	102 bytes	The session-id must be globally and eternally unique. The format of the session-id is the following: ;<high 32 bits>;<low 32 bits> In the 7750 SR the session-id is defined as: diameter-identity;boxuptime; seq-number Example: router.workstation.be;1391362206;1
264	Origin-Host	No	DiameterIdentity	M	80 bytes	Example: Origin-Host = host-name-1@domain-name-1
265	Supported-Vendor-Id	No	Unsigned32	M	—	IANA assigned vendor number: 3GPP — 10415 ETSI — 13019 Tridens — 6527
266	Vendor-Id	No	Unsigned32	M	—	IANA assigned vendor number: 3GPP — 10415 ETSI — 13019 Tridens — 6527 BBF — 3561
267	Firmware-Revision	No	Unsigned32	—	—	Reference to the major/minor release version. Example: 805 — Release 8R5
268	Result-Code	No	Unsigned32	M	—	See Table 10 for Error Codes.
269	Product-Name	No	UTF8String	—	—	Vendor-assigned name for the product. Example: ‟SR OS”
278	Origin-State-Id	No	Unsigned32	M	—	Example: Origin-State-Id = 10
279	Failed-AVP	No	Grouped	M	—	This AVP contains the AVP that could not be processed successfully.
281	Error-Message	No	UTF8String	—	—	String describing the cause of the failure.
282	Route-Record	No	DiameterIdentity	M	80 bytes	Example: Route-Record: host-1
283	Destination-Realm	No	DiameterIdentity	M	80 bytes	Example: Destination-Realm = domain.com
285	Re-Auth-Request-Type	No	Enumerated	NA	—	This AVP is always received in RAR message and it is never sent by the 7750 SR.
293	Destination-Host	No	DiameterIdentity	M	80 bytes	Operator configurable.
295	Termination-Cause	No	Enumerated	M	—	For a list of the 7750 SR supported values for Gx see Table 1-13.
296	Origin-Realm	No	DiameterIdentity	M	80 bytes	Example: Origin-Realm = origin-domain.com
297	Experimental-Result	No	Grouped	M	—	A grouped AVP containing: Vendor-Id AVP Experimental-Result-Code AVP Example: Experimental-Result = {Vendor-Id = 10415 (3GPP) Experimental-Result-Code = DIAMETER_PCC_RULE_EVENT (5142)}
298	Experimental-Result-Code	No	Unsigned32	M	—	For a list of the 7750 SR supported values for Gx see Table 1-10.
302	Logical-Access-Id	Yes	OctetString	V	—	Vendor ID = 13019 (ETSI)
313	Physical-Access-Id	Yes	UTF8String	V	—	Vendor ID = 13019 (ETSI)
412	CC-Input-Octets	No	Unsigned64	M	—	Example: CC-Input-Octets = 1000000
414	CC-Output-Octets	No	Unsigned64	M	—	Example: CC-Output-Octets = 1000000
415	CC-Request-Number	No	Unsigned32	M	—	Monotonically increasing from 0 for all requests within one session.
416	CC-Request-Type	No	Enumerated	M	—	Example: CC-Request-Type = 1 (CCR-i) 3. CC-Request-Type = 2 (CCR-u) CC-Request-Type = 3 (CCR-t)
418	CC-Session-Failover	No	Enumerated	M	—	FAILOVER_NOT_SUPPORTED (0) FAILOVER_SUPPORTED (1) Example: CC-Session-Failover = 1
421	CC-Total-Octets	No	Unsigned64	M	—	Example: CC-Total-Octets = 2000000
427	Credit-Control-Failure-Handling	No	Enumerated	M	—	TERMINATE (0) CONTINUE (1) RETRY_AND_TERMINATE (2) Example: Credit-Control-Failure-Handling = 1
431	Granted-Service-Unit	No	Grouped	M	—	This AVP can contain the following AVPs: CC-Total-Octets CC-Input-Octets CC-Output-Octets
433	Redirect-Address-Type	No	Enumerated	M	—	Example: Redirect-Address-Type = 2 (URL type)
435	Redirect-Server-Address	No	UTF8String	M	255 chars	Example: Redirect-Server-Address = http://www.operator.com/portal.php&
443	Subscription-Id	Yes	Grouped	M	—	This AVP contains the following AVPs: Subscription-Id-Type Subscription-Id-Data
444	Subscription-Id-Data	Yes	UTF8String	M	—	Example: Username — Subscription-Id-Data = user1@domain.com







446	Used-Service-Unit	No	Grouped	M	—	This AVP contains the following AVPs: CC-Total-Octets CC-Input-Octets CC-Output-Octets
450	Subscription-Id-Type	Yes	Enumerated	M	—	Example: Subscription-Id-Type = 0 (end_user_e164) Subscription-Id-Type = 1 (end_user_imsi)

458	User-Equipment-Info	Yes	Grouped	M	—	This AVP contains the following AVPs: User-Equipment-Info-Type User-Equipment-Info-Value
459	User-Equipment-Info-Type	Yes	Enumerated	—	—	Example: User-Equipment-Info-Type = 0 (emissive) User-Equipment-Info-Type =1 (mac)

460	User-Equipment-Info-Value	Yes	OctetString	—	—	—
507	Flow-Description	No	IPFilterRule (RFC6733, §4.3.1)	NA,M	—	The IPFilterRule format within PCC rule in the 7750 SR has the following syntax: action dir proto from src to dst Example: Flow-Description = allow in 6 from 192.168.7.0/24 3000-40000 to 172.16.10.0/26 10000-20000
511	Flow-Status	No	Enumerated	NA,M	—	Example: Flow-Status = 3 — matched traffic inside of the PCC rule is dropped.
515	Max-Requested-Bandwidth-DL	No	Unsigned32	NA, V	—	Vendor-Id = 10415 (3GPP) Example: Max-Requested-Bandwidth-DL = 1000 — 1 Mb/s in overrides
516	Max-Requested-Bandwidth-UL	No	Unsigned32	NA, V	—	Vendor-Id = 10415 (3GPP) Example: Max-Requested-Bandwidth-UL = 1000 — 1 Mb/s for overrides
554	Extended-Max-Requested-BW-DL	NA	Unsigned32	NA, V	—	Vendor-Id = 10415 (3GPP) Example: Extended-Max-Requested-BW-DL = 1000 — 1 Mb/s
555	Extended-Max-Requested-BW-UL	NA	Unsigned32	NA, V	—	Vendor-Id = 10415 (3GPP) Example: Extended-Max-Requested-BW-UL = 1000 — 1 Mb/s
628	Supported-Features	No	Grouped	V	—	This AVP contains the following AVPs: Vendor-Id Feature-List-Id Feature-List
629	Feature-List-Id	No	Unsigned32	V	—	Vendor-Id = 10415 (3GPP) Example: Feature-List-Id = 2
630	Feature-List	No	Unsigned32	V	—	Vendor-Id = 10415 (3GPP) Example: Feature-List = 128
909	RAI	Yes	Octetstring	V	12 octets	Vendor-Id = 10415 (3GPP) See 3GPP TS 29.061 for encoding details.
1001	Charging-Rule-Install	No	Grouped	NA, V	—	Vendor-Id = 10415 (3GPP) This AVP contains the following AVPs: Charging-Rule-Definition Charging-Rule-Name
1002	Charging-Rule-Remove	No	Grouped	NA, V	—	Vendor-Id = 10415 (3GPP) This AVP contains the following AVP: Charging-Rule-Name
1003	Charging-Rule-Definition	No	Grouped	NA, V	—	Vendor-Id = 10415 (3GPP) This AVP contains the following nested AVPs: Charging-Rule-Name, QoS-Information, NAS-Filter-Rule, Alc-NAS-Filter-Rule-Shared, AA-Functions
1005	Charging-Rule-Name	No	OctetString	V,M	100 chars for PCC rules (defined via Charging-Rule-Definition AVP) 128 chars for overrides. Vendor-Id = 10415 (3GPP)
1006	Event-Trigger	No	Enumerated	V	—	Vendor-Id = 10415 (3GPP)
1010	Precedence	No	Unsigned32	NA, M	0 to 65535	Vendor-Id = 10415 (3GPP) Example: Precedence = 100
1014	Tos-Traffic-Class	No	OctetString	NA, M	—	Encoded as two octets. The first octet contains the IPv4 Type-of-Service or the IPv6 Traffic-Class field and the second octet contains the ToS/Traffic Class mask field. The only supported mask is 11111100 (6 bits denoting DSCP support). Example: ToS-Traffic-Class = 00101000 11111100 — DSCP AF11
1016	QoS-Information	NA	Grouped	NA, V	—	Vendor-Id 10415 (3GPP) When used to signal a flow rate limiter in a PCC rule, this AVP contains the following nested AVPs: Max-Requested-Bandwidth-UL, Max-Requested-Bandwidth-DL, Guaranteed-Bitrate-UL, Guaranteed-Bitrate-DL
1018	Charging-Rule-Report	No	Grouped	V,M	—	Vendor-Id = 10415 (3GPP) This AVP contains the following nested AVPs: Charging-Rule-Name, PCC-Rule-Status, Rule-Failure-Code
1019	PCC-Rule-Status	No	Enumerated	V,M	—	Vendor-Id = 10415 (3GPP) Supported values in the 7750 SR: 1 – inactive Example: PCC-Rule-Status = 0 — rule is active
1025	Guaranteed-Bitrate-DL	NA	Unsigned32	NA,V	—	The units of this parameter are kb/s for overrides and b/s when used within PCC rules. The rate accounts for the IP header and above (no Layer 2 header). Vendor-Id = 10415 (3GPP) Example: Guaranteed-Bandwidth-DL = 1000 — 1 Mb/s in overrides Guaranteed-Bandwidth-DL = 1000000 — 1 Mb/s in PCC rules
1026	Guaranteed-Bitrate-UL	NA	Unsigned32	V	—	The units of this parameter are kb/s for overrides and b/s when used within PCC rules. The rate accounts for the IP header and above (no Layer 2 header). Vendor-Id = 10415 (3GPP) Example: Guaranteed-Bandwidth-UL = 1000 — 1 Mb/s in overrides Guaranteed-Bandwidth-UL = 1000000 — 1 Mb/s in PCC rules
1027	IP-CAN-Type	Yes	Enumerated	V	—	Vendor-Id = 10415 (3GPP) Example: IP-CAN-Type = 2 — xDSL IP-CAN-Type = 5 — 3GPP-EPS
1028	QoS-Class-Identifier	NA	Enumerated	NA,M	—	Vendor-Id = 10415 (3GPP) Example: QoS-Class-Identifier = 3 — maps to FC EF.
1031	Rule-Failure-Code	No	Enumerated	V,M	—	Vendor-Id = 10415 (3GPP) Example: Rule-Failure-Code = 1 — UNKNOWN_RULE_NAME
1032	RAT-Type	Yes	Enumerated	V	—	Vendor-Id = 10415 (3GPP) Example: RAT-Type = 0 — WLAN RAT-Type = 1004 — EUTRAN
1040	APN-Aggregate-Max-Bitrate-DL	Yes	Unsigned32	V	2^32-1 b/s	Vendor-Id = 10415 (3GPP) Rate in bits per second (b/s) Example: APN-Aggregate-Max-Bitrate-DL = 100000000 (100 Mb/s)
1041	APN-Aggregate-Max-Bitrate-UL	Yes	Unsigned32	V	2^32-1 b/s	Vendor-Id = 10415 (3GPP) Rate in bits per second (b/s) Example: APN-Aggregate-Max-Bitrate-UL = 10000000 (10 Mb/s)
1045	Session-Release-Cause	NA	Enumerated	V,M	—	Vendor-Id = 10415 (3GPP) This AVP is only received by the 7750 SR and it is never sent by the 7750 SR. 0 — UNSPECIFIED-REASON 1 — UE_SUBSCRIPTION_REASON This value is used to indicate that the subscription of UE has changed (for example, removed) and the session needs to be terminated. 2 — INSUFFICIENT_SERVER_ RESOURCES This value is used to indicate that the server is overloaded and needs to abort the session. Example: Session-Release-Cause = 0
1050	AN-GW-Address	Yes	IPv4Address	V	—	Vendor-Id = 10415 (3GPP) Example: AN-GW-Address = 10.10.10.10
1058	Flow-Information	No	Grouped	V	—	Vendor-Id = 10415 (3GPP) The following AVPs can be nested inside: Flow-Description, ToS-Traffic-Class, Flow-Direction
1065	PDN-Connection-ID	Yes	UTF8String	V	100 chars	Vendor-Id = 10415 (3GPP) For example: PDN-Connection-ID = example-apn.mnc001.mcc001.gprs
1066	Monitoring-Key	No	OctetString	NA,V	32 bytes	Vendor-Id = 10415 (3GPP) Category name configured in the 7750 SR, a string used for session monitoring or a Monitoring-Key AVP set in PCC rule definition with the Charging-Rule-Definition AVP. Example: Monitoring-Key = monitor-pcc-rule-1
1067	Usage-Monitoring-Information	No	Grouped	V	—	Vendor-Id = 10415 (3GPP) This AVP contains the following nested AVPs: Monitoring-Key, Granted-Service-Unit, Used-Service-Unit, Usage-Monitoring-Level, Usage-Monitoring-Report, Usage-Monitoring-Support
1068	Usage-Monitoring-Level	No	Enumerated	V	—	Vendor-Id = 10415 (3GPP) The following values are defined: 0 – session_level 1 – pcc_rule_level 2 – adc_rule_level Example: Usage-Monitoring-Level = 0 — usage monitoring is performed based on sla-profile (IP-CAN session level) of the host.
1069	Usage-Monitoring-Report	No	Enumerated	V	—	Vendor-Id = 10415 (3GPP) Example: Usage-Monitoring-Report = 0 (usage_monitoring_report_required)
1070	Usage-Monitoring-Support	No	Enumerated	NA,V	—	Vendor-Id = 10415 (3GPP) Example: Usage-Monitoring-Support = 0 — usage_ monitoring_disabled
1080	Flow-Direction	No	Enumerated	NA,M	—	Vendor-Id = 10415 (3GPP) Example: Flow-Direction = 1 — egress Flow-Direction = 2 — ingress
1085	Redirect-Information	No	Grouped	NA,V	—	Vendor-Id = 10415 (3GPP) This AVP can contain the flowing AVPs: Redirect-Support, Redirect-Address-Type, Redirect-Server-Address
1086	Redirect-Support	No	Enumerated	NA,V	—	Vendor-Id = 10415 (3GPP) Example: Redirect-Support = 1 — redirection is enabled
1088	TDF-Application-Identifier	OctetString	NA,V	32 chars	Vendor-Id = 10415 (3GPP) Example: 0_rated, BitTorrent
1092	ADC-Rule-Install	No	Grouped	NA,V	—	Vendor-Id = 10415 (3GPP) This AVP contains the following nested AVPs: ADC-Rule-Definition
1093	ADC-Rule-Remove	Grouped	NA,V	—	Vendor-Id = 10415 (3GPP) This AVP contains the following nested AVPs: ADC-Rule-Name
1094	ADC-Rule-Definition	No	Grouped	NA,V	—	Vendor-Id = 10415 (3GPP) This AVP contains the following nested AVPs: ADC-Rule-Name, MonitoringKey, TDF-Application-Id, AA-Functions
1096	ADC-Rule-Name	No	OctetString	V	17 chars for prefix/separator (optional) plus 32 chars for name	Vendor-Id = 10415 (3GPP) Example: For app-profile and ASO changes: ADC-Rule-Name = ‟AA-Functions: AdcRuleWithAAFtn”
1097	ADC-Rule-Report	No	Grouped	V	—	Vendor-Id = 10415 (3GPP) This AVP contains the following nested AVPs: ADC-Rule-Name, PCC-Rule-Status, Rule-Failure-Code
2848	Extended-APN-AMBR-DL	NA	Unsigned32	NA, V	—	The units of this parameter are kb/s. Vendor-Id = 10415 (3GPP) Example: Extended-APN-AMBR-DL = 1000 — 1 Mb/s
2849	Extended-APN-AMBR-UL	NA	Unsigned32	NA, V	—	The units of this parameter are kb/s. Vendor-Id = 10415 (3GPP) Example: Extended-APN-AMBR-UL = 1000 — 1 Mb/s
2850	Extended-GBR-DL	NA	Unsigned32	NA, V	—	The units of this parameter are kb/s. Vendor-Id = 10415 (3GPP) Example: Extended-GBR-DL = 1000 — 1 Mb/s
2851	Extended-GBR-UL	NA	Unsigned32	NA, V	—	The units of this parameter are kb/s. Vendor-Id = 10415 (3GPP) Example: Extended-GBR-UL = 1000 — 1 Mb/s

Diameter-Based AVP Applicability

The following tables use the following symbols:

0 — The AVP must not be present in the message.
0+ — Zero or more instances of the AVP may be present in the message.
0-1 — Zero or one instance of the AVP may be present in the message. It is considered an error if there is more than one instance of the AVP.
1 — One instance of the AVP must be present in the message.
1+ — At least one instance of the AVP must be present in the message.
N — The AVP is nested inside of a grouped AVP that is present in this message.

Table 7: Diameter-Based AVP Applicability

AVP ID	AVP Name	CER	CEA	DPR	DPA	DWR	DWA	ASR	ASA
257	Host-IP-Address	1	1+	0	0	0	0	0	0
258	Auth-Application-Id	1	0+	0	0	0	0	1	0
260	Vendor-Specific-Application-Id	0+	0+	0	0	0	0	0	0
263	Session-id	0	0	0	0	0	0	1	1
264	Origin-Host	1	1	1	1	1	1	1	1
265	Supported-Vendor-Id	1+	0+	0	0	0	0	0	0
266	Vendor-Id	1	1	0	0	0	0	0	0
267	Firmware-Revision	1	0-1	0	0	0	0	0	0
268	Result-Code	0	1	0	1	0	1	0	1
269	Product-Name	1	1	0	0	0	0	0	0
273	Disconnect-Cause	0	0	1	0	0	0	0	0
278	Origin-State-Id	1	0-1	0	0	0	0-1	0-1	0-1
279	Failed-AVP	0	0-1	0	0-1	0	0-1	0	0-1
281	Error-Message	0	0	0	0	0	0	0	0
283	Destination-Realm	0	0	0	0	0	0	1	0
293	Destination-Host	0	0	0	0	0	0	1	0
294	Error-Reporting-Host	0	0	0	0	0	0	0	0-1
296	Origin-Realm	1	1	1	1	1	1	1	1

Gx AVP Applicability

Table 8: Gx AVP Applicability

AVP ID	AVP Name	CCR	CCA	RAR	RAA
5	NAS-Port	0-1	0	0	0
8	Framed-IP-Address	0-1	0	0	0-1
18	3GPP-SGNS-MCC-MNC	0-1	0	0	0-1
22	3GPP-User-Location-Info	0-1	0	0	0
30	Called-Station-Id	0-1	0	0	0
31	Calling-Station-ID	0-1	0	0	0
55	Event-Timestamp	0-1	0-1	0-1	1
61	NAS-Port-Type	0-1	0	0	0
87	NAS-Port-Id	0-1	0	0	0
92	NAS-Filter-Rule	0	0+	0+	0
97	Framed-IPv6-Prefix	0-1	0	0	0-1
123	Delegated-IPv6-Prefix	0-1	0	0	0-1
258	Auth-Application-Id	1	1	1	0
263	Session-id	1	1	1	1
264	Origin-Host	1	1	1	1
266	Vendor-Id	0	N	0	0
268	Result-Code	0	1	0	0-1
278	Origin-State-Id	1	0-1	0-1	1
279	Failed-AVP	0-1	0+	0	0-1
281	Error-Message	0-1	0-1	0	0-1
282	Route-Record	0+	0	0+	0
283	Destination-Realm	1	0	1	0
285	Re-Auth-Request-Type	0	0	1	0
293	Destination-Host	0-1	0	1	0
295	Termination-Cause	0-1	0	0	0
296	Origin-Realm	1	1	1	1
297	Experimental-Result	0	0-1	0	0-1
298	Experimental-Result-Code	0	N	0	N
302	Logical-Access-Id	0-1	0	0	0
313	Physical-Access-Id	0-1	0	0	0
412	CC-Input-Octets	N	N	N	0
414	CC-Output-Octets	N	N	N	0
415	CC-Request-Number	1	1	0	0
416	CC-Request-Type	1	1	0	0
418	CC-Session-Failover	0	0-1	0	0
421	CC-Total-Octets	N	N	N	0
427	Credit-Control-Failure-Handling	0	0-1	0	0
431	Granted-Service-Unit	0	0-1	N	0
433	Redirect-Address-Type	0	N	N	0
433	Redirect-Server-Address	0	N	N	0
443	Subscription-Id	1-2	0	0	0
444	Subscription-Id-Data	N	0	0	0
446	Used-Service-Unit	N	0	0	0
450	Subscription-Id-Type	N	0	0	0
458	User-Equipment-Info	0-1	0	0	0
459	User-Equipment-Info-Type	N	0	0	0
460	User-Equipment-Info-Value	N	0	0	0
507	Flow-Description	0	N	N	0
511	Flow-Status	0	N	N	0
515	Max-Requested-Bandwidth-DL	0	N	N	0
516	Max-Requested-Bandwidth-UL	0	N	N	0
554	Extended-Max-Requested-BW-DL	0	N	N	0
555	Extended-Max-Requested-BW-UL	0	N	N	0
628	Supported-Features	0-1	0+	0	0
629	Feature-List-Id	N	N	0	0
630	Feature-List	N	N	0	0
909	RAI	0-1	0	0	0
1001	Charging-Rule-Install	0	0+	0+	0
1002	Charging-Rule-Remove	0	0+	0+	0
1003	Charging-Rule-Definition	0	N	N	0
1005	Charging-Rule-Name	N	N	N	N
1006	Event-Trigger	0+	0+	0+	0
1010	Precedence	0	N	N	0
1014	ToS-Traffic-Class	0	N	N	0
1016	QoS-Information	0-1	0-1, N	0-1, N	0
1018	Charging-Rule-Report	0+	0	0	0+
1019	PCC-Rule-Status	N	0	0	N
1025	Guaranteed-Bitrate-DL	0	N	N	0
1026	Guaranteed-Bitrate-UL	0	N	N	0
1027	IP-CAN-Type	0-1	0	0	0-1
1028	QoS-Class-Identifier	0	N	N	0
1031	Rule-Failure-Code	N	0	0	N
1032	RAT-Type	0-1	0	0	0-1
1033	Event-Report-Indication	0	0	0-1	0
1040	APN-Aggregate-Max-Bitrate-DL	N	N	N	0
1041	APN-Aggregate-Max-Bitrate-UL	N	N	N	0
1045	Session-Release-Cause	0	0	0-1	0
1050	AN-GW-Address	0-1	0	0	0-1
1058	Flow-Information	0	0+	0+	0
1065	PDN-Connection-ID	0-1	0	0	0
1066	Monitoring-Key	N	N	N	0
1067	Usage-Monitoring-Information	0+	0+	0+	0
1068	Usage-Monitoring-Level	0	N	N	0
1069	Usage-Monitoring-Report	0	N	N	0
1070	Usage-Monitoring-Support	0	N	N	0
1080	Flow-Direction	0	N	N	0
1085	Redirect-Information	0	0-1	0-1	0
1086	Redirect-Support	0	N	N	0
1088	TDF-Application-Identifier	0	N	N	0
1092	ADC-Rule-Install	0	0+	0+	0
1093	ADC-Rule-Remove	0	0	0	0
1094	ADC-Rule-Definition	0	0	0	0
1096	ADC-Rule-Name	N	N	N	N
1097	ADC-Rule-Report	0+	0+	0	0+
2848	Extended-APN-AMBR-DL	0	N	N	0
2849	Extended-APN-AMBR-UL	0	N	N	0
2850	Extended-GBR-DL	0	N	N	0
2850	Extended-GBR-UL	0	N	N	0

Result Codes (Result-Code AVP)

Table 10: Result Codes (Result-Code AVP)

Result Code Id	Result Code Name	Description
Success
2001	DIAMETER_SUCCESS	The request was successfully completed.
Protocol Errors
3001	DIAMETER_COMMAND_UNSUPPORTED	Rx: treated as an error. Tx: not supported.
3002	DIAMETER_UNABLE_TO_DELIVER	Rx: peer failover procedure on the Diameter base level is invoked. After the same response (3002) is received from all eligible peers, the application level (NASREQ/Gx/Gy) is notified. The message can then be retransmitted one last time with the destination-host AVP cleared. For a message to be retransmitted on the application level, server failover procedure must be enabled. Tx: diameter base replies with 3002 if it cannot route the received request message to its destination (this applies to Diameter multi-chassis configuration).
3003	DIAMETER_REALM_NOT_SERVED	Rx: treated as an error. Tx: not supported.
3004	DIAMETER_TOO_BUSY	Rx - The peer failover procedure on the Diameter base level is invoked. After the same response (3004) is received from all eligible peers, the application level (NASREQ, Gx, Gy) is notified. The message can then be retransmitted one last time with the destination-host AVP cleared. For a message to be retransmitted on the application level, server failover procedure must be enabled. Tx: not supported.
3005	DIAMETER_LOOP_DETECTED	Rx: treated as an error. Tx: not supported.
3006	DIAMETER_REDIRECT_INDICATION	Rx: treated as an error. Tx: not supported.
3007	DIAMETER_APPLICATION_UNSUPPORTED	Rx: treated as an error. Tx: not supported.
3008	DIAMETER_INVALID_HDR_BITS	Rx: treated as an error. Tx: not supported.
3009	DIAMETER_INVALID_AVP_BITS	Rx: treated as an error. Tx: not supported.
3010	DIAMETER_UNKNOWN_PEER	Rx: treated as an error. Tx: not supported.
Permanent Failures
5001	DIAMETER_AVP_UNSUPPORTED	Rx: treated as an error. Tx: Reception of an unrecognized AVP with M-bit set triggers a response (RAA) message that contains the Result-Code AVP whose value is set to DIAMETER_AVP_UNSUPORTED, and the Failed-AVP AVP containing the offending AVP.
5002	DIAMETER_UNKNOWN_SESSION	Rx: treated as an error. Tx: In case that a message from PCRF is received for a non-existing session, the 7750 SR replies with this value.
5004	DIAMETER_INVALID_AVP_VALUE	Rx: treated as an error. Tx: Reception of an AVP with invalid value triggers a response message (RAA) that contains the Result-Code AVP whose value is set to DIAMETER_INVALID_AVP_VALUE, and the Failed-AVP containing the AVP that caused the error.
5005	DIAMETER_MISSING_AVP	Rx: treated as an error. Tx: not supported.
5007	DIAMETER_CONTRADICTING_AVPS	Rx: treated as an error. Tx: not supported.
5008	DIAMETER_AVP_NOT_ALLOWED	Rx: treated as an error. Tx: not supported.
5009	DIAMETER_AVP_OCCURS_TOO_MANY_TIMES	Rx: treated as an error. Tx: not supported.
5010	DIAMETER_NO_COMMON_APPLICATION	Rx: treated as an error. Tx: not supported.
5011	DIAMETER_UNSUPPORTED_VERSION	Rx: treated as an error. Tx: As an example, a RAA message carries this AVP as a response to a RAR message that was received by a SR OS node while the Gx session was in a session terminating state. A session terminating state is considered a state where the SR OS node is waiting for a CCA-T message as a response to a previously initiated CCR-T message by the SR OS node.
5012	DIAMETER_UNABLE_TO_COMPLY	Rx: treated as an error. Tx: For example, a RAA message carries this AVP as a response to a RAR message that was received by a SR OS node while the Gx session was in a session terminating state. A session terminating state is considered a state where the SR OS node is waiting for a CCA-T message as a response to a previously initiated CCR-T message by the SR OS node.
5013	DIAMETER_INVALID_BIT_IN_HEADER	Rx: treated as an error. Tx: not supported.
5014	DIAMETER_INVALID_AVP_LENGTH	Rx: treated as an error. Tx: not supported.
5015	DIAMETER_INVALID_MESSAGE_LENGTH	Rx: treated as an error. Tx: not supported.
5016	DIAMETER_INVALID_AVP_BIT_COMBO	Rx: treated as an error. Tx: not supported.
5017	DIAMETER_NO_COMMON_SECURITY	Rx: treated as an error. Tx: not supported.
Gx Specific Permanent Failures
5140	DIAMETER_ERROR_INITIAL_PARAMETERS	Rx: treated as an error. Tx: not supported.
5141	DIAMETER_ERROR_TRIGGER_EVENT	Rx: treated as an error. Tx: not supported.
5142	DIAMETER_PCC_RULE_EVENT	Rx: treated as an error. Tx: not supported.
5148	DIAMETER_ADC_RULE_EVENT	Rx: treated as an error. Tx: not supported.

Rule Failure Codes (Rule-Failure-Code AVP)

Table 11: Rule Failure Codes (Rule-Failure-Code AVP)

Rule Failure Code Id	Rule Failure Name	Description
1	UNKNOWN_RULE_NAME	Rx: treated as an error. Tx: not supported.
4	GW/7750 SR_MALFUNCTION	This value indicates the problem related to the value carried in the AVP. For example, the value references a non-existing object (rule), the value is out of bounds or any other unexpected error. The error-message AVP in CCR/RAA carried on the top level or Failed-AVP provides more information about the event for debugging purposes.
5	RESOURCE_LIMITATION	Rx: treated as an error. Tx: not supported.
14	TDF_APPLICATION_IDENTIFIER_ERROR	Rx: treated as an error. Tx: not supported.

Event Triggers (Event-Trigger AVP)

Table 12: Event Triggers (Event-Trigger AVP)

Event Trigger Id	Event Trigger Name	Description
2	RAT_CHANGE	For GTP S11 access, this is triggered if a new RAT Type is received in GTP.
13	USER_LOCATION_CHANGE	For WLAN-GW, this is triggered for any UE location change. For GTP S11 access, this is triggered if a ULI was received in GTP with either non-ECGI/TAI values or a ECGI/TAI value that changed.
14	NO_EVENT_TRIGGERS	Sent in CCA and RAR by the PCRF to indicate that PCRF does not require any Event Trigger notification except for those events that do not require subscription and are always provisioned.
18	UE_IP_ADDRESS_ALLOCATE	When used in a CCR command, this value indicates that the 7750 SR generated the request because a client’s IPv4 address is allocated. The Framed-IP-Address, Framed-IPv6-Prefix, Delegated-IPv6-Prefix or Alc-IPv6-Address AVPs is provided in the same request. This event trigger is reported when the corresponding event occurs, even if the event trigger is not provisioned by the PCRF.
19	UE_IP_ADDRESS_RELEASE	When used in a CCR command, this value indicates that the 7750 SR generated the request because a client’s IP address/prefix is released. The Framed-IP-Address, Framed-IPv6-Prefix, Delegated-IPv6-Prefix or Alc-IPv6-Address AVPs is provided in the same request. This event trigger shall be reported when the corresponding event occurs, even if the event trigger is not provisioned by the PCRF.
21	AN_GW_CHANGE	This value is sent by the PCRF to inform the Diameter client in the SR to trigger a notification for every subscriber during a switchover in a multi-chassis configuration. This notification contains the IP address of the newly active BNG (AN_GW_ADDRESS) sent in a CCR-U message. If the Diameter client in the SR OS node is not armed with this event-trigger, the subscriber switchover is not reported to the PCRF.
22	SUCCESSFUL_RESOURCE_ALLOCATION	Not supported.
26	TAI_CHANGE	For GTP S11 access, this is triggered if a ULI is signaled in GTP with a TAI that changed from the last value received.
27	ECGI_CHANGE	For GTP S11 access, this is triggered if a ULI is signaled in GTP with a ECGI that changed from the last value received.
33	USAGE_REPORT	This value is used in a CCA and RAR commands by the PCRF when requesting usage monitoring on the 7750 SR. The PCRF also provides in the CCA or RAR command the Usage-Monitoring-Information AVPs including the Monitoring-Key AVP and the Granted-Service-Unit AVP. When used in a CCR command, this value indicates that the 7750 SR generated the request to report the accumulated usage for one or more monitoring keys. The 7750 SR provides the accumulated usage volume using the Usage-Monitoring-Information AVPs including the Monitoring-Key AVP and the Used-Service-Unit AVP.

Termination Causes (Termination-Cause AVP)

Table 13: Termination Causes (Termination-Cause AVP)

Termination Cause Id	Termination Cause Name	Description	Reference
1	DIAMETER_LOGOUT	Example reasons: Clear subscriber via CLI, PADT Received	[RFC 3588][RFC 6733]
2	DIAMETER_SERVICE_NOT_PROVIDED	Example reason: Subscriber-host is terminated via force-NACK received via RADIUS CoA	[RFC 3588][RFC 6733]
3	DIAMETER_BAD_ANSWER	Example reason: Problem with initial parameters during sub-host instantiation while Gx fallback is disabled or default subscriber parameters are not available.	[RFC 3588][RFC 6733]
4	DIAMETER_ADMINISTRATIVE	Example reasons: Host deleted via RADIUS DISCONNECT, Service shutdown for PPPoE subscriber	[RFC 3588][RFC 6733]
5	DIAMETER_LINK_BROKEN	Example reasons: SAP is deleted, SHCV check fails	[RFC 3588][RFC 6733]
8	DIAMETER_SESSION_TIMEOUT	Example reason: When idle timeout for the subscriber-host is enabled and its value is reached.	[RFC 3588][RFC 6733]

Standards and Protocol Support

Access Node Control Protocol (ANCP)

draft-ietf-ancp-protocol-02, Protocol for Access Node Control Mechanism in Broadband Networks

RFC 5851, Framework and Requirements for an Access Node Control Mechanism in Broadband Multi-Service Networks

Application Assurance (AA)

3GPP Release 12, ADC rules over Gx interfaces

RFC 3507, Internet Content Adaptation Protocol (ICAP)

Asynchronous Transfer Mode (ATM)

AF-ILMI-0065.000 Version 4.0, Integrated Local Management Interface (ILMI)

AF-PHY-0086.001 Version 1.1, Inverse Multiplexing for ATM (IMA) Specification

AF-TM-0121.000 Version 4.1, Traffic Management Specification

GR-1113-CORE Issue 1, Asynchronous Transfer Mode (ATM) and ATM Adaptation Layer (AAL) Protocols Generic Requirements

GR-1248-CORE Issue 3, Generic Requirements for Operations of ATM Network Elements (NEs)

RFC 1626, Default IP MTU for use over ATM AAL5

RFC 2684, Multiprotocol Encapsulation over ATM Adaptation Layer 5

Bidirectional Forwarding Detection (BFD)

draft-ietf-idr-bgp-ls-sbfd-extensions-01, BGP Link-State Extensions for Seamless BFD

RFC 5880, Bidirectional Forwarding Detection (BFD)

RFC 5881, Bidirectional Forwarding Detection (BFD) IPv4 and IPv6 (Single Hop)

RFC 5882, Generic Application of Bidirectional Forwarding Detection (BFD)

RFC 5883, Bidirectional Forwarding Detection (BFD) for Multihop Paths

RFC 7130, Bidirectional Forwarding Detection (BFD) on Link Aggregation Group (LAG) Interfaces

RFC 7880, Seamless Bidirectional Forwarding Detection (S-BFD)

RFC 7881, Seamless Bidirectional Forwarding Detection (S-BFD) for IPv4, IPv6, and MPLS

RFC 7883, Advertising Seamless Bidirectional Forwarding Detection (S-BFD) Discriminators in IS-IS

RFC 7884, OSPF Extensions to Advertise Seamless Bidirectional Forwarding Detection (S-BFD) Target Discriminators

Border Gateway Protocol (BGP)

draft-hares-idr-update-attrib-low-bits-fix-01, Update Attribute Flag Low Bits Clarification

draft-ietf-idr-add-paths-guidelines-08, Best Practices for Advertisement of Multiple Paths in IBGP

draft-ietf-idr-best-external-03, Advertisement of the best external route in BGP

draft-ietf-idr-bgp-flowspec-oid-03, Revised Validation Procedure for BGP Flow Specifications

draft-ietf-idr-bgp-gr-notification-01, Notification Message support for BGP Graceful Restart

draft-ietf-idr-bgp-ls-app-specific-attr-01, Application Specific Attributes Advertisement with BGP Link-State

draft-ietf-idr-bgp-optimal-route-reflection-10, BGP Optimal Route Reflection (BGP-ORR)

draft-ietf-idr-error-handling-03, Revised Error Handling for BGP UPDATE Messages

draft-ietf-idr-flowspec-interfaceset-03, Applying BGP flowspec rules on a specific interface set

draft-ietf-idr-flowspec-path-redirect-05, Flowspec Indirection-id Redirect - localised ID

draft-ietf-idr-flowspec-redirect-ip-02, BGP Flow-Spec Redirect to IP Action

draft-ietf-idr-link-bandwidth-03, BGP Link Bandwidth Extended Community

draft-ietf-idr-long-lived-gr-00, Support for Long-lived BGP Graceful Restart

draft-ietf-sidr-origin-validation-signaling-04, BGP Prefix Origin Validation State Extended Community

RFC 1772, Application of the Border Gateway Protocol in the Internet

RFC 1997, BGP Communities Attribute

RFC 2385, Protection of BGP Sessions via the TCP MD5 Signature Option

RFC 2439, BGP Route Flap Damping

RFC 2545, Use of BGP-4 Multiprotocol Extensions for IPv6 Inter-Domain Routing

RFC 2858, Multiprotocol Extensions for BGP-4

RFC 2918, Route Refresh Capability for BGP-4

RFC 3107, Carrying Label Information in BGP-4

RFC 4271, A Border Gateway Protocol 4 (BGP-4)

RFC 4360, BGP Extended Communities Attribute

RFC 4364, BGP/MPLS IP Virtual Private Networks (VPNs)

RFC 4456, BGP Route Reflection: An Alternative to Full Mesh Internal BGP (IBGP)

RFC 4486, Subcodes for BGP Cease Notification Message

RFC 4659, BGP-MPLS IP Virtual Private Network (VPN) Extension for IPv6 VPN

RFC 4684, Constrained Route Distribution for Border Gateway Protocol/MultiProtocol Label Switching (BGP/MPLS) Internet Protocol (IP) Virtual Private Networks (VPNs)

RFC 4724, Graceful Restart Mechanism for BGP - helper mode

RFC 4760, Multiprotocol Extensions for BGP-4

RFC 4798, Connecting IPv6 Islands over IPv4 MPLS Using IPv6 Provider Edge Routers (6PE)

RFC 5004, Avoid BGP Best Path Transitions from One External to Another

RFC 5065, Autonomous System Confederations for BGP

RFC 5291, Outbound Route Filtering Capability for BGP-4

RFC 5396, Textual Representation of Autonomous System (AS) Numbers - asplain

RFC 5492, Capabilities Advertisement with BGP-4

RFC 5549, Advertising IPv4 Network Layer Reachability Information with an IPv6 Next Hop

RFC 5575, Dissemination of Flow Specification Rules

RFC 5668, 4-Octet AS Specific BGP Extended Community

RFC 6286, Autonomous-System-Wide Unique BGP Identifier for BGP-4

RFC 6793, BGP Support for Four-Octet Autonomous System (AS) Number Space

RFC 6810, The Resource Public Key Infrastructure (RPKI) to Router Protocol

RFC 6811, Prefix Origin Validation

RFC 6996, Autonomous System (AS) Reservation for Private Use

RFC 7311, The Accumulated IGP Metric Attribute for BGP

RFC 7607, Codification of AS 0 Processing

RFC 7674, Clarification of the Flowspec Redirect Extended Community

RFC 7752, North-Bound Distribution of Link-State and Traffic Engineering (TE) Information Using BGP

RFC 7854, BGP Monitoring Protocol (BMP)

RFC 7911, Advertisement of Multiple Paths in BGP

RFC 7999, BLACKHOLE Community

RFC 8092, BGP Large Communities Attribute

RFC 8212, Default External BGP (EBGP) Route Propagation Behavior without Policies

RFC 8571, BGP - Link State (BGP-LS) Advertisement of IGP Traffic Engineering Performance Metric Extensions

Broadband Network Gateway (BNG) - Control and User Plane Separation (CUPS)

3GPP 23.007, Restoration procedures

3GPP 29.244, Interface between the Control Plane and the User Plane nodes

3GPP 29.281, General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U)

BBF TR-459, Control and User Plane Separation for a Disaggregated BNG

RFC 8300, Network Service Header (NSH)

Circuit Emulation

RFC 4553, Structure-Agnostic Time Division Multiplexing (TDM) over Packet (SAToP)

RFC 5086, Structure-Aware Time Division Multiplexed (TDM) Circuit Emulation Service over Packet Switched Network (CESoPSN)

RFC 5287, Control Protocol Extensions for the Setup of Time-Division Multiplexing (TDM) Pseudowires in MPLS Networks

Ethernet

IEEE 802.1AB, Station and Media Access Control Connectivity Discovery

IEEE 802.1ad, Provider Bridges

IEEE 802.1ag, Connectivity Fault Management

IEEE 802.1ah, Provider Backbone Bridges

IEEE 802.1ak, Multiple Registration Protocol

IEEE 802.1aq, Shortest Path Bridging

IEEE 802.1ax, Link Aggregation

IEEE 802.1D, MAC Bridges

IEEE 802.1p, Traffic Class Expediting

IEEE 802.1Q, Virtual LANs

IEEE 802.1s, Multiple Spanning Trees

IEEE 802.1w, Rapid Reconfiguration of Spanning Tree

IEEE 802.1X, Port Based Network Access Control

IEEE 802.3ac, VLAN Tag

IEEE 802.3ad, Link Aggregation

IEEE 802.3ah, Ethernet in the First Mile

IEEE 802.3x, Ethernet Flow Control

ITU-T G.8031/Y.1342, Ethernet Linear Protection Switching

ITU-T G.8032/Y.1344, Ethernet Ring Protection Switching

ITU-T Y.1731, OAM functions and mechanisms for Ethernet based networks

Ethernet VPN (EVPN)

draft-ietf-bess-evpn-igmp-mld-proxy-05, IGMP and MLD Proxy for EVPN

draft-ietf-bess-evpn-irb-mcast-04, EVPN Optimized Inter-Subnet Multicast (OISM) Forwarding - ingress replication

draft-ietf-bess-evpn-pref-df-06, Preference-based EVPN DF Election

draft-ietf-bess-evpn-prefix-advertisement-11, IP Prefix Advertisement in EVPN

draft-ietf-bess-evpn-proxy-arp-nd-08, Operational Aspects of Proxy-ARP/ND in EVPN Networks

draft-ietf-bess-pbb-evpn-isid-cmacflush-00, PBB-EVPN ISID-based CMAC-Flush

RFC 7432, BGP MPLS-Based Ethernet VPN

RFC 7623, Provider Backbone Bridging Combined with Ethernet VPN (PBB-EVPN)

RFC 8214, Virtual Private Wire Service Support in Ethernet VPN

RFC 8317, Ethernet-Tree (E-Tree) Support in Ethernet VPN (EVPN) an Provider Backbone Bridging EVPN (PBB-EVPN)

RFC 8365, A Network Virtualization Overlay Solution Using Ethernet VPN (EVPN)

RFC 8560, Seamless Integration of Ethernet VPN (EVPN) with Virtual Private LAN Service (VPLS) and Their Provider Backbone Bridge (PBB) Equivalents

RFC 8584, DF Election and AC-influenced DF Election

Frame Relay

ANSI T1.617 Annex D, DSS1 - Signalling Specification For Frame Relay Bearer Service

FRF.1.2, PVC User-to-Network Interface (UNI) Implementation Agreement

FRF.12, Frame Relay Fragmentation Implementation Agreement

FRF.16.1, Multilink Frame Relay UNI/NNI Implementation Agreement

FRF.5, Frame Relay/ATM PVC Network Interworking Implementation

FRF2.2, PVC Network-to-Network Interface (NNI) Implementation Agreement

ITU-T Q.933 Annex A, Additional procedures for Permanent Virtual Connection (PVC) status management

Generalized Multiprotocol Label Switching (GMPLS)

draft-ietf-ccamp-rsvp-te-srlg-collect-04, RSVP-TE Extensions for Collecting SRLG Information

RFC 3471, Generalized Multi-Protocol Label Switching (GMPLS) Signaling Functional Description

RFC 3473, Generalized Multi-Protocol Label Switching (GMPLS) Signaling Resource ReserVation Protocol-Traffic Engineering (RSVP-TE) Extensions

RFC 4204, Link Management Protocol (LMP)

RFC 4208, Generalized Multiprotocol Label Switching (GMPLS) User-Network Interface (UNI): Resource ReserVation Protocol-Traffic Engineering (RSVP-TE) Support for the Overlay Model

RFC 4872, RSVP-TE Extensions in Support of End-to-End Generalized Multi-Protocol Label Switching (GMPLS) Recovery

RFC 5063, Extensions to GMPLS Resource Reservation Protocol (RSVP) Graceful Restart - helper mode

gRPC Remote Procedure Calls (gRPC)

cert.proto Version 0.1.0, gRPC Network Operations Interface (gNOI) Certificate Management Service

file.proto Version 0.1.0, gRPC Network Operations Interface (gNOI) File Service

gnmi.proto Version 0.7.0, gRPC Network Management Interface (gNMI) Service Specification

PROTOCOL-HTTP2, gRPC over HTTP2

system.proto Version 1.0.0, gRPC Network Operations Interface (gNOI) System Service

Intermediate System to Intermediate System (IS-IS)

draft-ietf-isis-mi-02, IS-IS Multi-Instance

draft-kaplan-isis-ext-eth-02, Extended Ethernet Frame Size Support

ISO/IEC 10589:2002 Second Edition, Intermediate system to Intermediate system intra-domain routeing information exchange protocol for use in conjunction with the protocol for providing the connectionless-mode Network Service (ISO 8473)

RFC 1195, Use of OSI IS-IS for Routing in TCP/IP and Dual Environments

RFC 2973, IS-IS Mesh Groups

RFC 3359, *Reserved Type, Length and Value (TLV) Codepoints in Intermediate System to Intermediate System

RFC 3719, Recommendations for Interoperable Networks using Intermediate System to Intermediate System (IS-IS)

RFC 3787, Recommendations for Interoperable IP Networks using Intermediate System to Intermediate System (IS-IS)

RFC 4971, Intermediate System to Intermediate System (IS-IS) Extensions for Advertising Router Information

RFC 5120, M-ISIS: Multi Topology (MT) Routing in IS-IS

RFC 5130, A Policy Control Mechanism in IS-IS Using Administrative Tags

RFC 5301, Dynamic Hostname Exchange Mechanism for IS-IS

RFC 5302, Domain-wide Prefix Distribution with Two-Level IS-IS

RFC 5303, Three-Way Handshake for IS-IS Point-to-Point Adjacencies

RFC 5304, IS-IS Cryptographic Authentication

RFC 5305, IS-IS Extensions for Traffic Engineering TE

RFC 5306, Restart Signaling for IS-IS - helper mode

RFC 5307, IS-IS Extensions in Support of Generalized Multi-Protocol Label Switching (GMPLS)

RFC 5308, Routing IPv6 with IS-IS

RFC 5309, Point-to-Point Operation over LAN in Link State Routing Protocols

RFC 5310, IS-IS Generic Cryptographic Authentication

RFC 6119, IPv6 Traffic Engineering in IS-IS

RFC 6213, IS-IS BFD-Enabled TLV

RFC 6232, Purge Originator Identification TLV for IS-IS

RFC 6233, IS-IS Registry Extension for Purges

RFC 6329, IS-IS Extensions Supporting IEEE 802.1aq Shortest Path Bridging

RFC 7775, IS-IS Route Preference for Extended IP and IPv6 Reachability

RFC 7794, IS-IS Prefix Attributes for Extended IPv4 and IPv6 Reachability

RFC 7987, IS-IS Minimum Remaining Lifetime

RFC 8202, IS-IS Multi-Instance - single topology

RFC 8570, IS-IS Traffic Engineering (TE) Metric Extensions - delay metric

RFC 8919, IS-IS Application-Specific Link Attributes

Internet Protocol (IP) — Fast Reroute

draft-ietf-rtgwg-lfa-manageability-08, Operational management of Loop Free Alternates

RFC 5286, Basic Specification for IP Fast Reroute: Loop-Free Alternates

RFC 7431, Multicast-Only Fast Reroute

RFC 7490, Remote Loop-Free Alternate (LFA) Fast Reroute (FRR)

Internet Protocol (IP) — General

draft-grant-tacacs-02, The TACACS+ Protocol

RFC 768, User Datagram Protocol

RFC 793, Transmission Control Protocol

RFC 854, Telnet Protocol Specifications

RFC 1350, The TFTP Protocol (revision 2)

RFC 2347, TFTP Option Extension

RFC 2348, TFTP Blocksize Option

RFC 2349, TFTP Timeout Interval and Transfer Size Options

RFC 2428, FTP Extensions for IPv6 and NATs

RFC 2784, Generic Routing Encapsulation (GRE)

RFC 2818, HTTP Over TLS

RFC 2890, Key and Sequence Number Extensions to GRE

RFC 3164, The BSD syslog Protocol

RFC 4250, The Secure Shell (SSH) Protocol Assigned Numbers

RFC 4251, The Secure Shell (SSH) Protocol Architecture

RFC 4252, The Secure Shell (SSH) Authentication Protocol - publickey, password

RFC 4253, The Secure Shell (SSH) Transport Layer Protocol

RFC 4254, The Secure Shell (SSH) Connection Protocol

RFC 4511, Lightweight Directory Access Protocol (LDAP): The Protocol

RFC 4513, Lightweight Directory Access Protocol (LDAP): Authentication Methods and Security Mechanisms - TLS

RFC 4632, Classless Inter-domain Routing (CIDR): The Internet Address Assignment and Aggregation Plan

RFC 5082, The Generalized TTL Security Mechanism (GTSM)

RFC 5246, The Transport Layer Security (TLS) Protocol Version 1.2 - TLS client, RSA public key

RFC 5656, Elliptic Curve Algorithm Integration in the Secure Shell Transport Layer - ECDSA

RFC 5925, The TCP Authentication Option

RFC 5926, Cryptographic Algorithms for the TCP Authentication Option (TCP-AO)

RFC 6398, IP Router Alert Considerations and Usage - MLD

RFC 6528, Defending against Sequence Number Attacks

RFC 7011, Specification of the IP Flow Information Export (IPFIX) Protocol for the Exchange of Flow Information

RFC 7012, Information Model for IP Flow Information Export

RFC 7230, Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing

RFC 7231, Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content

RFC 7232, Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests

RFC 7301, Transport Layer Security (TLS) Application Layer Protocol Negotiation Extension

Internet Protocol (IP) — Multicast

cisco-ipmulticast/pim-autorp-spec01, Auto-RP: Automatic discovery of Group-to-RP mappings for IP multicast - version 1

draft-ietf-bier-pim-signaling-08, PIM Signaling Through BIER Core

draft-ietf-idmr-traceroute-ipm-07, A “traceroute” facility for IP Multicast

draft-ietf-l2vpn-vpls-pim-snooping-07, Protocol Independent Multicast (PIM) over Virtual Private LAN Service (VPLS)

RFC 1112, Host Extensions for IP Multicasting

RFC 2236, Internet Group Management Protocol, Version 2

RFC 2365, Administratively Scoped IP Multicast

RFC 2375, IPv6 Multicast Address Assignments

RFC 2710, Multicast Listener Discovery (MLD) for IPv6

RFC 3306, Unicast-Prefix-based IPv6 Multicast Addresses

RFC 3376, Internet Group Management Protocol, Version 3

RFC 3446, Anycast Rendevous Point (RP) mechanism using Protocol Independent Multicast (PIM) and Multicast Source Discovery Protocol (MSDP)

RFC 3590, Source Address Selection for the Multicast Listener Discovery (MLD) Protocol

RFC 3618, Multicast Source Discovery Protocol (MSDP)

RFC 3810, Multicast Listener Discovery Version 2 (MLDv2) for IPv6

RFC 3956, Embedding the Rendezvous Point (RP) Address in an IPv6 Multicast Address

RFC 3973, Protocol Independent Multicast - Dense Mode (PIM-DM): Protocol Specification (Revised) - auto-RP groups

RFC 4541, Considerations for Internet Group Management Protocol (IGMP) and Multicast Listener Discovery (MLD) Snooping Switches

RFC 4604, Using Internet Group Management Protocol Version 3 (IGMPv3) and Multicast Listener Discovery Protocol Version 2 (MLDv2) for Source-Specific Multicast

RFC 4607, Source-Specific Multicast for IP

RFC 4608, Source-Specific Protocol Independent Multicast in 232/8

RFC 4610, Anycast-RP Using Protocol Independent Multicast (PIM)

RFC 4611, Multicast Source Discovery Protocol (MSDP) Deployment Scenarios

RFC 5059, Bootstrap Router (BSR) Mechanism for Protocol Independent Multicast (PIM)

RFC 5186, Internet Group Management Protocol Version 3 (IGMPv3) / Multicast Listener Discovery Version 2 (MLDv2) and Multicast Routing Protocol Interaction

RFC 5384, The Protocol Independent Multicast (PIM) Join Attribute Format

RFC 5496, The Reverse Path Forwarding (RPF) Vector TLV

RFC 6037, Cisco Systems’ Solution for Multicast in MPLS/BGP IP VPNs

RFC 6512, Using Multipoint LDP When the Backbone Has No Route to the Root

RFC 6513, Multicast in MPLS/BGP IP VPNs

RFC 6514, BGP Encodings and Procedures for Multicast in MPLS/IP VPNs

RFC 6515, IPv4 and IPv6 Infrastructure Addresses in BGP Updates for Multicast VPNs

RFC 6516, IPv6 Multicast VPN (MVPN) Support Using PIM Control Plane and Selective Provider Multicast Service Interface (S-PMSI) Join Messages

RFC 6625, Wildcards in Multicast VPN Auto-Discover Routes

RFC 6826, Multipoint LDP In-Band Signaling for Point-to-Multipoint and Multipoint-to-Multipoint Label Switched Path

RFC 7246, Multipoint Label Distribution Protocol In-Band Signaling in a Virtual Routing and Forwarding (VRF) Table Context

RFC 7385, IANA Registry for P-Multicast Service Interface (PMSI) Tunnel Type Code Points

RFC 7716, Global Table Multicast with BGP Multicast VPN (BGP-MVPN) Procedures

RFC 7761, Protocol Independent Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised)

RFC 8279, Multicast Using Bit Index Explicit Replication (BIER)

RFC 8296, Encapsulation for Bit Index Explicit Replication (BIER) in MPLS and Non-MPLS Networks - MPLS encapsulation

RFC 8401, Bit Index Explicit Replication (BIER) Support via IS-IS

RFC 8444, OSPFv2 Extensions for Bit Index Explicit Replication (BIER)

RFC 8487, Mtrace Version 2: Traceroute Facility for IP Multicast

RFC 8534, Explicit Tracking with Wildcard Routes in Multicast VPN - (C-,C-) wildcard

RFC 8556, Multicast VPN Using Bit Index Explicit Replication (BIER)

Internet Protocol (IP) — Version 4

RFC 791, Internet Protocol

RFC 792, Internet Control Message Protocol

RFC 826, An Ethernet Address Resolution Protocol

RFC 951, Bootstrap Protocol (BOOTP) - relay

RFC 1034, Domain Names - Concepts and Facilities

RFC 1035, Domain Names - Implementation and Specification

RFC 1191, Path MTU Discovery - router specification

RFC 1519, Classless Inter-Domain Routing (CIDR): an Address Assignment and Aggregation Strategy

RFC 1534, Interoperation between DHCP and BOOTP

RFC 1542, Clarifications and Extensions for the Bootstrap Protocol

RFC 1812, Requirements for IPv4 Routers

RFC 1918, Address Allocation for Private Internets

RFC 2003, IP Encapsulation within IP

RFC 2131, Dynamic Host Configuration Protocol

RFC 2132, DHCP Options and BOOTP Vendor Extensions

RFC 2401, Security Architecture for Internet Protocol

RFC 3021, Using 31-Bit Prefixes on IPv4 Point-to-Point Links

RFC 3046, DHCP Relay Agent Information Option (Option 82)

RFC 3768, Virtual Router Redundancy Protocol (VRRP)

RFC 4884, Extended ICMP to Support Multi-Part Messages - ICMPv4 and ICMPv6 Time Exceeded

Internet Protocol (IP) — Version 6

RFC 2464, Transmission of IPv6 Packets over Ethernet Networks

RFC 2529, Transmission of IPv6 over IPv4 Domains without Explicit Tunnels

RFC 3122, Extensions to IPv6 Neighbor Discovery for Inverse Discovery Specification

RFC 3315, Dynamic Host Configuration Protocol for IPv6 (DHCPv6)

RFC 3587, IPv6 Global Unicast Address Format

RFC 3596, DNS Extensions to Support IP version 6

RFC 3633, IPv6 Prefix Options for Dynamic Host Configuration Protocol (DHCP) version 6

RFC 3646, DNS Configuration options for Dynamic Host Configuration Protocol for IPv6 (DHCPv6)

RFC 3736, Stateless Dynamic Host Configuration Protocol (DHCP) Service for IPv6

RFC 3971, SEcure Neighbor Discovery (SEND)

RFC 3972, Cryptographically Generated Addresses (CGA)

RFC 4007, IPv6 Scoped Address Architecture

RFC 4193, Unique Local IPv6 Unicast Addresses

RFC 4291, Internet Protocol Version 6 (IPv6) Addressing Architecture

RFC 4443, Internet Control Message Protocol (ICMPv6) for the Internet Protocol Version 6 (IPv6) Specification

RFC 4861, Neighbor Discovery for IP version 6 (IPv6)

RFC 4862, IPv6 Stateless Address Autoconfiguration - router functions

RFC 4890, Recommendations for Filtering ICMPv6 Messages in Firewalls

RFC 4941, Privacy Extensions for Stateless Address Autoconfiguration in IPv6

RFC 5007, DHCPv6 Leasequery

RFC 5095, Deprecation of Type 0 Routing Headers in IPv6

RFC 5722, Handling of Overlapping IPv6 Fragments

RFC 5798, Virtual Router Redundancy Protocol (VRRP) Version 3 for IPv4 and IPv6 - IPv6

RFC 5952, A Recommendation for IPv6 Address Text Representation

RFC 6092, Recommended Simple Security Capabilities in Customer Premises Equipment (CPE) for Providing Residential IPv6 Internet Service - Internet Control and Management, Upper-Layer Transport Protocols, UDP Filters, IPsec and Internet Key Exchange (IKE), TCP Filters

RFC 6106, IPv6 Router Advertisement Options for DNS Configuration

RFC 6164, Using 127-Bit IPv6 Prefixes on Inter-Router Links

RFC 8021, Generation of IPv6 Atomic Fragments Considered Harmful

RFC 8200, Internet Protocol, Version 6 (IPv6) Specification

RFC 8201, Path MTU Discovery for IP version 6

Internet Protocol Security (IPsec)

draft-ietf-ipsec-isakmp-mode-cfg-05, The ISAKMP Configuration Method

draft-ietf-ipsec-isakmp-xauth-06, Extended Authentication within ISAKMP/Oakley (XAUTH)

RFC 2401, Security Architecture for the Internet Protocol

RFC 2403, The Use of HMAC-MD5-96 within ESP and AH

RFC 2404, The Use of HMAC-SHA-1-96 within ESP and AH

RFC 2405, The ESP DES-CBC Cipher Algorithm With Explicit IV

RFC 2406, IP Encapsulating Security Payload (ESP)

RFC 2407, IPsec Domain of Interpretation for ISAKMP (IPsec DoI)

RFC 2408, Internet Security Association and Key Management Protocol (ISAKMP)

RFC 2409, The Internet Key Exchange (IKE)

RFC 2410, The NULL Encryption Algorithm and Its Use With IPsec

RFC 3526, More Modular Exponential (MODP) Diffie-Hellman group for Internet Key Exchange (IKE)

RFC 3566, The AES-XCBC-MAC-96 Algorithm and Its Use With IPsec

RFC 3602, The AES-CBC Cipher Algorithm and Its Use with IPsec

RFC 3706, A Traffic-Based Method of Detecting Dead Internet Key Exchange (IKE) Peers

RFC 3947, Negotiation of NAT-Traversal in the IKE

RFC 3948, UDP Encapsulation of IPsec ESP Packets

RFC 4106, The Use of Galois/Counter Mode (GCM) in IPsec ESP

RFC 4210, Internet X.509 Public Key Infrastructure Certificate Management Protocol (CMP)

RFC 4211, Internet X.509 Public Key Infrastructure Certificate Request Message Format (CRMF)

RFC 4301, Security Architecture for the Internet Protocol

RFC 4303, IP Encapsulating Security Payload

RFC 4307, Cryptographic Algorithms for Use in the Internet Key Exchange Version 2 (IKEv2)

RFC 4308, Cryptographic Suites for IPsec

RFC 4434, The AES-XCBC-PRF-128 Algorithm for the Internet Key Exchange Protocol (IKE)

RFC 4543, The Use of Galois Message Authentication Code (GMAC) in IPsec ESP and AH

RFC 4868, Using HMAC-SHA-256, HMAC-SHA-384, and HMAC-SHA-512 with IPSec

RFC 4945, The Internet IP Security PKI Profile of IKEv1/ISAKMP, IKEv2 and PKIX

RFC 5019, The Lightweight Online Certificate Status Protocol (OCSP) Profile for High-Volume Environments

RFC 5280, Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile

RFC 5282, Using Authenticated Encryption Algorithms with the Encrypted Payload of the IKEv2 Protocol

RFC 5903, ECP Groups for IKE and IKEv2

RFC 5998, An Extension for EAP-Only Authentication in IKEv2

RFC 6379, Suite B Cryptographic Suites for IPsec

RFC 6380, Suite B Profile for Internet Protocol Security (IPsec)

RFC 6712, Internet X.509 Public Key Infrastructure – HTTP Transfer for the Certificate Management Protocol (CMP)

RFC 6960, X.509 Internet Public Key Infrastructure Online Certificate Status Protocol - OCSP

RFC 7296, Internet Key Exchange Protocol Version 2 (IKEv2)

RFC 7321, Cryptographic Algorithm Implementation Requirements and Usage Guidance for Encapsulating Security Payload (ESP) and Authentication Header (AH)

RFC 7383, Internet Key Exchange Protocol Version 2 (IKEv2) Message Fragmentation

RFC 7427, Signature Authentication in the Internet Key Exchange Version 2 (IKEv2)

RFC 7468, Textual Encodings of PKIX, PKCS, and CMS Structures

Label Distribution Protocol (LDP)

draft-pdutta-mpls-ldp-adj-capability-00, LDP Adjacency Capabilities

draft-pdutta-mpls-ldp-v2-00, LDP Version 2

draft-pdutta-mpls-mldp-up-redundancy-00, Upstream LSR Redundancy for Multi-point LDP Tunnels

draft-pdutta-mpls-multi-ldp-instance-00, Multiple LDP Instances

draft-pdutta-mpls-tldp-hello-reduce-04, Targeted LDP Hello Reduction

RFC 3037, LDP Applicability

RFC 3478, Graceful Restart Mechanism for Label Distribution Protocol - helper mode

RFC 5036, LDP Specification

RFC 5283, LDP Extension for Inter-Area Label Switched Paths (LSPs)

RFC 5443, LDP IGP Synchronization

RFC 5561, LDP Capabilities

RFC 5919, Signaling LDP Label Advertisement Completion

RFC 6388, Label Distribution Protocol Extensions for Point-to-Multipoint and Multipoint-to-Multipoint Label Switched Paths

RFC 6512, Using Multipoint LDP When the Backbone Has No Route to the Root

RFC 6826, Multipoint LDP in-band signaling for Point-to-Multipoint and Multipoint-to-Multipoint Label Switched Paths

RFC 7032, LDP Downstream-on-Demand in Seamless MPLS

RFC 7473, Controlling State Advertisements of Non-negotiated LDP Applications

RFC 7552, Updates to LDP for IPv6

Layer Two Tunneling Protocol (L2TP) Network Server (LNS)

draft-mammoliti-l2tp-accessline-avp-04, Layer 2 Tunneling Protocol (L2TP) Access Line Information Attribute Value Pair (AVP) Extensions

RFC 2661, Layer Two Tunneling Protocol “L2TP”

RFC 2809, Implementation of L2TP Compulsory Tunneling via RADIUS

RFC 3438, Layer Two Tunneling Protocol (L2TP) Internet Assigned Numbers: Internet Assigned Numbers Authority (IANA) Considerations Update

RFC 3931, Layer Two Tunneling Protocol - Version 3 (L2TPv3)

RFC 4719, Transport of Ethernet Frames over Layer 2 Tunneling Protocol Version 3 (L2TPv3)

RFC 4951, Fail Over Extensions for Layer 2 Tunneling Protocol (L2TP) “failover”

Multiprotocol Label Switching (MPLS)

draft-ietf-mpls-lsp-ping-ospfv3-codepoint-02, OSPFv3 CodePoint for MPLS LSP Ping

RFC 3031, Multiprotocol Label Switching Architecture

RFC 3032, MPLS Label Stack Encoding

RFC 3270, Multi-Protocol Label Switching (MPLS) Support of Differentiated Services - E-LSP

RFC 3443, Time To Live (TTL) Processing in Multi-Protocol Label Switching (MPLS) Networks

RFC 4023, Encapsulating MPLS in IP or Generic Routing Encapsulation (GRE)

RFC 4182, Removing a Restriction on the use of MPLS Explicit NULL

RFC 5332, MPLS Multicast Encapsulations

RFC 5884, Bidirectional Forwarding Detection (BFD) for MPLS Label Switched Paths (LSPs)

RFC 6374, Packet Loss and Delay Measurement for MPLS Networks - Delay Measurement, Channel Type 0x000C

RFC 6424, Mechanism for Performing Label Switched Path Ping (LSP Ping) over MPLS Tunnels

RFC 6425, Detecting Data Plane Failures in Point-to-Multipoint Multiprotocol Label Switching (MPLS) - Extensions to LSP Ping

RFC 6790, The Use of Entropy Labels in MPLS Forwarding

RFC 7510, Encapsulating MPLS in UDP

RFC 7746, Label Switched Path (LSP) Self-Ping

RFC 7876, UDP Return Path for Packet Loss and Delay Measurement for MPLS Networks - Delay Measurement

RFC 8029, Detecting Multiprotocol Label Switched (MPLS) Data-Plane Failures

Multiprotocol Label Switching — Transport Profile (MPLS-TP)

RFC 5586, MPLS Generic Associated Channel

RFC 5921, A Framework for MPLS in Transport Networks

RFC 5960, MPLS Transport Profile Data Plane Architecture

RFC 6370, MPLS Transport Profile (MPLS-TP) Identifiers

RFC 6378, MPLS Transport Profile (MPLS-TP) Linear Protection

RFC 6426, MPLS On-Demand Connectivity and Route Tracing

RFC 6427, MPLS Fault Management Operations, Administration, and Maintenance (OAM)

RFC 6428, Proactive Connectivity Verification, Continuity Check and Remote Defect indication for MPLS Transport Profile

RFC 6478, Pseudowire Status for Static Pseudowires

RFC 7213, MPLS Transport Profile (MPLS-TP) Next-Hop Ethernet Addressing

Network Address Translation (NAT)

draft-ietf-behave-address-format-10, IPv6 Addressing of IPv4/IPv6 Translators

draft-ietf-behave-v6v4-xlate-23, IP/ICMP Translation Algorithm

draft-miles-behave-l2nat-00, Layer2-Aware NAT

draft-nishitani-cgn-02, Common Functions of Large Scale NAT (LSN)

RFC 4787, Network Address Translation (NAT) Behavioral Requirements for Unicast UDP

RFC 5382, NAT Behavioral Requirements for TCP

RFC 5508, NAT Behavioral Requirements for ICMP

RFC 6146, Stateful NAT64: Network Address and Protocol Translation from IPv6 Clients to IPv4 Servers

RFC 6333, Dual-Stack Lite Broadband Deployments Following IPv4 Exhaustion

RFC 6334, Dynamic Host Configuration Protocol for IPv6 (DHCPv6) Option for Dual-Stack Lite

RFC 6887, Port Control Protocol (PCP)

RFC 6888, Common Requirements For Carrier-Grade NATs (CGNs)

RFC 7753, Port Control Protocol (PCP) Extension for Port-Set Allocation

RFC 7915, IP/ICMP Translation Algorithm

Network Configuration Protocol (NETCONF)

RFC 5277, NETCONF Event Notifications

RFC 6020, YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)

RFC 6022, YANG Module for NETCONF Monitoring

RFC 6241, Network Configuration Protocol (NETCONF)

RFC 6242, Using the NETCONF Protocol over Secure Shell (SSH)

RFC 6243, With-defaults Capability for NETCONF

RFC 8342, Network Management Datastore Architecture (NMDA) - Startup, Candidate, Running and Intended datastores

RFC 8525, YANG Library

RFC 8526, NETCONF Extensions to Support the Network Management Datastore Architecture - operation

Open Shortest Path First (OSPF)

RFC 1586, Guidelines for Running OSPF Over Frame Relay Networks

RFC 1765, OSPF Database Overflow

RFC 2328, OSPF Version 2

RFC 3101, The OSPF Not-So-Stubby Area (NSSA) Option

RFC 3509, Alternative Implementations of OSPF Area Border Routers

RFC 3623, Graceful OSPF Restart Graceful OSPF Restart - helper mode

RFC 3630, Traffic Engineering (TE) Extensions to OSPF Version 2

RFC 4203, OSPF Extensions in Support of Generalized Multi-Protocol Label Switching (GMPLS)

RFC 4222, Prioritized Treatment of Specific OSPF Version 2 Packets and Congestion Avoidance

RFC 4552, Authentication/Confidentiality for OSPFv3

RFC 4576, Using a Link State Advertisement (LSA) Options Bit to Prevent Looping in BGP/MPLS IP Virtual Private Networks (VPNs)

RFC 4577, OSPF as the Provider/Customer Edge Protocol for BGP/MPLS IP Virtual Private Networks (VPNs)

RFC 5185, OSPF Multi-Area Adjacency

RFC 5187, OSPFv3 Graceful Restart - helper mode

RFC 5243, OSPF Database Exchange Summary List Optimization

RFC 5250, The OSPF Opaque LSA Option

RFC 5309, Point-to-Point Operation over LAN in Link State Routing Protocols

RFC 5340, OSPF for IPv6

RFC 5642, Dynamic Hostname Exchange Mechanism for OSPF

RFC 5709, OSPFv2 HMAC-SHA Cryptographic Authentication

RFC 5838, Support of Address Families in OSPFv3

RFC 6549, OSPFv2 Multi-Instance Extensions

RFC 6987, OSPF Stub Router Advertisement

RFC 7684, OSPFv2 Prefix/Link Attribute Advertisement

RFC 7770, Extensions to OSPF for Advertising Optional Router Capabilities

RFC 8362, OSPFv3 Link State Advertisement (LSA) Extensibility

RFC 8920, OSPF Application-Specific Link Attributes

OpenFlow

TS-007 Version 1.3.1, OpenFlow Switch Specification - OpenFlow-hybrid switches

Path Computation Element Protocol (PCEP)

draft-alvarez-pce-path-profiles-04, PCE Path Profiles

draft-dhs-spring-pce-sr-p2mp-policy-00, PCEP extensions for p2mp sr policy

draft-ietf-pce-segment-routing-08, PCEP Extensions for Segment Routing

RFC 5440, Path Computation Element (PCE) Communication Protocol (PCEP)

RFC 8281, PCEP Extensions for PCE-initiated LSP Setup in a Stateful PCE Model

RFC 8321, Path Computation Element Communication Protocol (PCEP) Extensions for Stateful PCE

Point-to-Point Protocol (PPP)

RFC 1332, The PPP Internet Protocol Control Protocol (IPCP)

RFC 1377, The PPP OSI Network Layer Control Protocol (OSINLCP)

RFC 1661, The Point-to-Point Protocol (PPP)

RFC 1662, PPP in HDLC-like Framing

RFC 1877, PPP Internet Protocol Control Protocol Extensions for Name Server Addresses

RFC 1989, PPP Link Quality Monitoring

RFC 1990, The PPP Multilink Protocol (MP)

RFC 1994, PPP Challenge Handshake Authentication Protocol (CHAP)

RFC 2153, PPP Vendor Extensions

RFC 2516, A Method for Transmitting PPP Over Ethernet (PPPoE)

RFC 2615, PPP over SONET/SDH

RFC 2686, The Multi-Class Extension to Multi-Link PPP

RFC 2878, PPP Bridging Control Protocol (BCP)

RFC 4638, Accommodating a Maximum Transit Unit/Maximum Receive Unit (MTU/MRU) Greater Than 1492 in the Point-to-Point Protocol over Ethernet (PPPoE)

RFC 5072, IP Version 6 over PPP

Policy Management and Credit Control

3GPP TS 29.212 Release 11, Policy and Charging Control (PCC); Reference points - Gx support as it applies to wireline environment (BNG)

RFC 4006, Diameter Credit-Control Application

RFC 6733, Diameter Base Protocol

Pseudowire

draft-ietf-l2vpn-vpws-iw-oam-04, OAM Procedures for VPWS Interworking

MFA Forum 9.0.0, The Use of Virtual trunks for ATM/MPLS Control Plane Interworking

MFA Forum 12.0.0, Multiservice Interworking - Ethernet over MPLS

MFA Forum 13.0.0, Fault Management for Multiservice Interworking v1.0

MFA Forum 16.0.0, Multiservice Interworking - IP over MPLS

RFC 3916, Requirements for Pseudo-Wire Emulation Edge-to-Edge (PWE3)

RFC 3985, Pseudo Wire Emulation Edge-to-Edge (PWE3)

RFC 4385, Pseudo Wire Emulation Edge-to-Edge (PWE3) Control Word for Use over an MPLS PSN

RFC 4446, IANA Allocations for Pseudowire Edge to Edge Emulation (PWE3)

RFC 4447, Pseudowire Setup and Maintenance Using the Label Distribution Protocol (LDP)

RFC 4448, Encapsulation Methods for Transport of Ethernet over MPLS Networks

RFC 4619, Encapsulation Methods for Transport of Frame Relay over Multiprotocol Label Switching (MPLS) Networks

RFC 4717, Encapsulation Methods for Transport Asynchronous Transfer Mode (ATM) over MPLS Networks

RFC 4816, Pseudowire Emulation Edge-to-Edge (PWE3) Asynchronous Transfer Mode (ATM) Transparent Cell Transport Service

RFC 5085, Pseudowire Virtual Circuit Connectivity Verification (VCCV): A Control Channel for Pseudowires

RFC 5659, An Architecture for Multi-Segment Pseudowire Emulation Edge-to-Edge

RFC 5885, Bidirectional Forwarding Detection (BFD) for the Pseudowire Virtual Circuit Connectivity Verification (VCCV)

RFC 6073, Segmented Pseudowire

RFC 6310, Pseudowire (PW) Operations, Administration, and Maintenance (OAM) Message Mapping

RFC 6391, Flow-Aware Transport of Pseudowires over an MPLS Packet Switched Network

RFC 6575, Address Resolution Protocol (ARP) Mediation for IP Interworking of Layer 2 VPNs

RFC 6718, Pseudowire Redundancy

RFC 6829, Label Switched Path (LSP) Ping for Pseudowire Forwarding Equivalence Classes (FECs) Advertised over IPv6

RFC 6870, Pseudowire Preferential Forwarding Status bit

RFC 7023, MPLS and Ethernet Operations, Administration, and Maintenance (OAM) Interworking

RFC 7267, Dynamic Placement of Multi-Segment Pseudowires

RFC 7392, Explicit Path Routing for Dynamic Multi-Segment Pseudowires - ER-TLV and ER-HOP IPv4 Prefix

Quality of Service (QoS)

RFC 2430, A Provider Architecture for Differentiated Services and Traffic Engineering (PASTE)

RFC 2474, Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers

RFC 2597, Assured Forwarding PHB Group

RFC 3140, Per Hop Behavior Identification Codes

RFC 3246, An Expedited Forwarding PHB (Per-Hop Behavior)

Remote Authentication Dial In User Service (RADIUS)

RFC 2865, Remote Authentication Dial In User Service (RADIUS)

RFC 2866, RADIUS Accounting

RFC 2867, RADIUS Accounting Modifications for Tunnel Protocol Support

RFC 2868, RADIUS Attributes for Tunnel Protocol Support

RFC 2869, RADIUS Extensions

RFC 3162, RADIUS and IPv6

RFC 4818, RADIUS Delegated-IPv6-Prefix Attribute

RFC 5176, Dynamic Authorization Extensions to RADIUS

RFC 6911, RADIUS attributes for IPv6 Access Networks

RFC 6929, Remote Authentication Dial-In User Service (RADIUS) Protocol Extensions

Resource Reservation Protocol — Traffic Engineering (RSVP-TE)

draft-newton-mpls-te-dynamic-overbooking-00, A Diffserv-TE Implementation Model to dynamically change booking factors during failure events

RFC 2702, Requirements for Traffic Engineering over MPLS

RFC 2747, RSVP Cryptographic Authentication

RFC 2961, RSVP Refresh Overhead Reduction Extensions

RFC 3097, RSVP Cryptographic Authentication – Updated Message Type Value

RFC 3209, RSVP-TE: Extensions to RSVP for LSP Tunnels

RFC 3473, Generalized Multi-Protocol Label Switching (GMPLS) Signaling Resource ReserVation Protocol-Traffic Engineering (RSVP-TE) Extensions - IF_ID RSVP_HOP object with unnumbered interfaces and RSVP-TE graceful restart helper procedures

RFC 3477, Signalling Unnumbered Links in Resource ReSerVation Protocol - Traffic Engineering (RSVP-TE)

RFC 3564, Requirements for Support of Differentiated Services-aware MPLS Traffic Engineering

RFC 3906, Calculating Interior Gateway Protocol (IGP) Routes Over Traffic Engineering Tunnels

RFC 4090, Fast Reroute Extensions to RSVP-TE for LSP Tunnels

RFC 4124, Protocol Extensions for Support of Diffserv-aware MPLS Traffic Engineering

RFC 4125, Maximum Allocation Bandwidth Constraints Model for Diffserv-aware MPLS Traffic Engineering

RFC 4127, Russian Dolls Bandwidth Constraints Model for Diffserv-aware MPLS Traffic Engineering

RFC 4561, Definition of a Record Route Object (RRO) Node-Id Sub-Object

RFC 4875, Extensions to Resource Reservation Protocol - Traffic Engineering (RSVP-TE) for Point-to-Multipoint TE Label Switched Paths (LSPs)

RFC 4950, ICMP Extensions for Multiprotocol Label Switching

RFC 5151, Inter-Domain MPLS and GMPLS Traffic Engineering – Resource Reservation Protocol-Traffic Engineering (RSVP-TE) Extensions

RFC 5712, MPLS Traffic Engineering Soft Preemption

RFC 5817, Graceful Shutdown in MPLS and Generalized MPLS Traffic Engineering Networks

Routing Information Protocol (RIP)

RFC 1058, Routing Information Protocol

RFC 2080, RIPng for IPv6

RFC 2082, RIP-2 MD5 Authentication

RFC 2453, RIP Version 2

Segment Routing (SR)

draft-bashandy-rtgwg-segment-routing-uloop-06, Loop avoidance using Segment Routing

draft-ietf-idr-bgp-ls-segment-routing-ext-16, BGP Link-State extensions for Segment Routing

draft-ietf-idr-bgp-ls-segment-routing-msd-09, Signaling MSD (Maximum SID Depth) using Border Gateway Protocol Link-State

draft-ietf-idr-segment-routing-te-policy-09, Advertising Segment Routing Policies in BGP

draft-ietf-isis-mpls-elc-10, Signaling Entropy Label Capability and Entropy Readable Label Depth Using IS-IS - advertising ELC

draft-ietf-lsr-flex-algo-08, IGP Flexible Algorithm

draft-ietf-ospf-mpls-elc-12, Signaling Entropy Label Capability and Entropy Readable Label-stack Depth Using OSPF - advertising ELC

draft-ietf-rtgwg-segment-routing-ti-lfa-01, Topology Independent Fast Reroute using Segment Routing

draft-ietf-spring-conflict-resolution-05, Segment Routing MPLS Conflict Resolution

draft-ietf-spring-segment-routing-policy-08, Segment Routing Policy Architecture

draft-ietf-teas-sr-rsvp-coexistence-rec-02, Recommendations for RSVP-TE and Segment Routing LSP co-existence

draft-voyer-pim-sr-p2mp-policy-02, Segment Routing Point-to-Multipoint Policy

draft-voyer-spring-sr-p2mp-policy-03, SR Replication Policy for P2MP Service Delivery

RFC 8287, Label Switched Path (LSP) Ping/Traceroute for Segment Routing (SR) IGP-Prefix and IGP-Adjacency Segment Identifiers (SIDs) with MPLS Data Planes

RFC 8476, Signaling Maximum SID Depth (MSD) Using OSPF - node MSD

RFC 8491, Signaling Maximum SID Depth (MSD) Using IS-IS - node MSD

RFC 8660, Segment Routing with the MPLS Data Plane

RFC 8661, Segment Routing MPLS Interworking with LDP

RFC 8663, MPLS Segment Routing over IP - BGP SR with SR-MPLS-over-UDP/IP

RFC 8665, OSPF Extensions for Segment Routing

RFC 8666, OSPFv3 Extensions for Segment Routing

RFC 8667, IS-IS Extensions for Segment Routing

RFC 8669, Segment Routing Prefix Segment Identifier Extensions for BGP

Simple Network Management Protocol (SNMP)

RFC 1157, A Simple Network Management Protocol (SNMP)

RFC 1215, A Convention for Defining Traps for use with the SNMP

RFC 1901, Introduction to Community-based SNMPv2

RFC 3410, Introduction and Applicability Statements for Internet Standard Management Framework

RFC 3411, An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks

RFC 3412, Message Processing and Dispatching for the Simple Network Management Protocol (SNMP)

RFC 3413, Simple Network Management Protocol (SNMP) Applications

RFC 3414, User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)

RFC 3415, View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)

RFC 3416, Version 2 of the Protocol Operations for the Simple Network Management Protocol (SNMP)

RFC 3417, Transport Mappings for the Simple Network Management Protocol (SNMP) - SNMP over UDP over IPv4

RFC 3584, Coexistence between Version 1, Version 2, and Version 3 of the Internet-standard Network Management Framework

RFC 3826, The Advanced Encryption Standard (AES) Cipher Algorithm in the SNMP User-based Security Model

Simple Network Management Protocol (SNMP) - Management Information Base (MIB)

draft-ietf-snmpv3-update-mib-05, Management Information Base (MIB) for the Simple Network Management Protocol (SNMP)

draft-ietf-isis-wg-mib-06, Management Information Base for Intermediate System to Intermediate System (IS-IS)

draft-ietf-mboned-msdp-mib-01, Multicast Source Discovery protocol MIB

draft-ietf-mpls-ldp-mib-07, *Definitions of Managed Objects for the Multiprotocol Label Switching, Label Distribution Protocol (LDP)

draft-ietf-mpls-lsr-mib-06, Multiprotocol Label Switching (MPLS) Label Switching Router (LSR) Management Information Base Using SMIv2

draft-ietf-mpls-te-mib-04, Multiprotocol Label Switching (MPLS) Traffic Engineering Management Information Base

draft-ietf-ospf-mib-update-08, OSPF Version 2 Management Information Base

draft-ietf-vrrp-unified-mib-06, Definitions of Managed Objects for the VRRP over IPv4 and IPv6 - IPv6

ianaaddressfamilynumbers-mib, IANA-ADDRESS-FAMILY-NUMBERS-MIB

ianagmplstc-mib, IANA-GMPLS-TC-MIB

ianaiftype-mib, IANAifType-MIB

ianaiprouteprotocol-mib, IANA-RTPROTO-MIB

IEEE8021-CFM-MIB, IEEE P802.1ag(TM) CFM MIB

IEEE8021-PAE-MIB, IEEE 802.1X MIB

IEEE8023-LAG-MIB, IEEE 802.3ad MIB

LLDP-MIB, IEEE P802.1AB(TM) LLDP MIB

RFC 1212, Concise MIB Definitions

RFC 1213, Management Information Base for Network Management of TCP/IP-based Internets: MIB-II

RFC 1724, RIP Version 2 MIB Extension

RFC 2021, Remote Network Monitoring Management Information Base Version 2 using SMIv2

RFC 2115, Management Information Base for Frame Relay DTEs Using SMIv2

RFC 2206, RSVP Management Information Base using SMIv2

RFC 2213, Integrated Services Management Information Base using SMIv2

RFC 2494, Definitions of Managed Objects for the DS0 and DS0 Bundle Interface Type

RFC 2514, Definitions of Textual Conventions and OBJECT-IDENTITIES for ATM Management

RFC 2515, Definitions of Managed Objects for ATM Management

RFC 2578, Structure of Management Information Version 2 (SMIv2)

RFC 2579, Textual Conventions for SMIv2

RFC 2580, Conformance Statements for SMIv2

RFC 2787, Definitions of Managed Objects for the Virtual Router Redundancy Protocol

RFC 2819, Remote Network Monitoring Management Information Base

RFC 2856, Textual Conventions for Additional High Capacity Data Types

RFC 2863, The Interfaces Group MIB

RFC 2864, The Inverted Stack Table Extension to the Interfaces Group MIB

RFC 2933, Internet Group Management Protocol MIB

RFC 3014, Notification Log MIB

RFC 3165, Definitions of Managed Objects for the Delegation of Management Scripts

RFC 3231, Definitions of Managed Objects for Scheduling Management Operations

RFC 3273, Remote Network Monitoring Management Information Base for High Capacity Networks

RFC 3419, Textual Conventions for Transport Addresses

RFC 3498, Definitions of Managed Objects for Synchronous Optical Network (SONET) Linear Automatic Protection Switching (APS) Architectures

RFC 3592, Definitions of Managed Objects for the Synchronous Optical Network/Synchronous Digital Hierarchy (SONET/SDH) Interface Type

RFC 3593, Textual Conventions for MIB Modules Using Performance History Based on 15 Minute Intervals

RFC 3635, Definitions of Managed Objects for the Ethernet-like Interface Types

RFC 3637, Definitions of Managed Objects for the Ethernet WAN Interface Sublayer

RFC 3877, Alarm Management Information Base (MIB)

RFC 3895, Definitions of Managed Objects for the DS1, E1, DS2, and E2 Interface Types

RFC 3896, Definitions of Managed Objects for the DS3/E3 Interface Type

RFC 4001, Textual Conventions for Internet Network Addresses

RFC 4022, Management Information Base for the Transmission Control Protocol (TCP)

RFC 4113, Management Information Base for the User Datagram Protocol (UDP)

RFC 4220, Traffic Engineering Link Management Information Base

RFC 4273, Definitions of Managed Objects for BGP-4

RFC 4292, IP Forwarding Table MIB

RFC 4293, Management Information Base for the Internet Protocol (IP)

RFC 4631, Link Management Protocol (LMP) Management Information Base (MIB)

RFC 4878, Definitions and Managed Objects for Operations, Administration, and Maintenance (OAM) Functions on Ethernet-Like Interfaces

RFC 7420, Path Computation Element Communication Protocol (PCEP) Management Information Base (MIB) Module

SFLOW-MIB Version 1.3 (Draft 5), sFlow MIB

Timing

GR-1244-CORE Issue 3, Clocks for the Synchronized Network: Common Generic Criteria

GR-253-CORE Issue 3, SONET Transport Systems: Common Generic Criteria

IEEE 1588-2008, IEEE Standard for a Precision Clock Synchronization Protocol for Networked Measurement and Control Systems

ITU-T G.781, Synchronization layer functions

ITU-T G.813, Timing characteristics of SDH equipment slave clocks (SEC)

ITU-T G.8261, Timing and synchronization aspects in packet networks

ITU-T G.8262, Timing characteristics of synchronous Ethernet equipment slave clock (EEC)

ITU-T G.8264, Distribution of timing information through packet networks

ITU-T G.8265.1, Precision time protocol telecom profile for frequency synchronization

ITU-T G.8275.1, Precision time protocol telecom profile for phase/time synchronization with full timing support from the network

RFC 3339, Date and Time on the Internet: Timestamps

RFC 5905, Network Time Protocol Version 4: Protocol and Algorithms Specification

Two-Way Active Measurement Protocol (TWAMP)

RFC 5357, A Two-Way Active Measurement Protocol (TWAMP) - server, unauthenticated mode

RFC 5938, Individual Session Control Feature for the Two-Way Active Measurement Protocol (TWAMP)

RFC 6038, Two-Way Active Measurement Protocol (TWAMP) Reflect Octets and Symmetrical Size Features

RFC 8545, Well-Known Port Assignments for the One-Way Active Measurement Protocol (OWAMP) and the Two-Way Active Measurement Protocol (TWAMP) - TWAMP

RFC 8762, Simple Two-Way Active Measurement Protocol - Unauthenticated

Virtual Private LAN Service (VPLS)

RFC 4761, Virtual Private LAN Service (VPLS) Using BGP for Auto-Discovery and Signaling

RFC 4762, Virtual Private LAN Service (VPLS) Using Label Distribution Protocol (LDP) Signaling

RFC 5501, Requirements for Multicast Support in Virtual Private LAN Services

RFC 6074, Provisioning, Auto-Discovery, and Signaling in Layer 2 Virtual Private Networks (L2VPNs)

RFC 7041, Extensions to the Virtual Private LAN Service (VPLS) Provider Edge (PE) Model for Provider Backbone Bridging

RFC 7117, Multicast in Virtual Private LAN Service (VPLS)

Voice and Video

DVB BlueBook A86, Transport of MPEG-2 TS Based DVB Services over IP Based Networks

ETSI TS 101 329-5 Annex E, QoS Measurement for VoIP - Method for determining an Equipment Impairment Factor using Passive Monitoring

ITU-T G.1020 Appendix I, Performance Parameter Definitions for Quality of Speech and other Voiceband Applications Utilizing IP Networks - Mean Absolute Packet Delay Variation & Markov Models

ITU-T G.107, The E Model - A computational model for use in planning

ITU-T P.564, Conformance testing for voice over IP transmission quality assessment models

RFC 3550, RTP: A Transport Protocol for Real-Time Applications - Appendix A.8

RFC 4585, Extended RTP Profile for Real-time Transport Control Protocol (RTCP)-Based Feedback (RTP/AVPF)

RFC 4588, RTP Retransmission Payload Format

Wireless Local Area Network (WLAN) Gateway

3GPP TS 23.402, Architecture enhancements for non-3GPP accesses - S2a roaming based on GPRS

Yet Another Next Generation (YANG)

RFC 6991, Common YANG Data Types

RFC 7950, The YANG 1.1 Data Modeling Language

RFC 7951, JSON Encoding of Data Modeled with YANG

Yet Another Next Generation (YANG) - OpenConfig Modules

openconfig-aaa.yang version 0.4.0, OpenConfig AAA Module

openconfig-aaa-radius.yang version 0.3.0, OpenConfig AAA RADIUS Module

openconfig-aaa-tacacs.yang version 0.3.0, OpenConfig AAA TACACS+ Module

openconfig-acl.yang version 1.0.0, OpenConfig ACL Module

openconfig-bfd.yang version 0.1.0, OpenConfig BFD Module

openconfig-bgp.yang version 3.0.1, OpenConfig BGP Module

openconfig-bgp-common.yang version 3.0.1, OpenConfig BGP Common Module

openconfig-bgp-common-multiprotocol.yang version 3.0.1, OpenConfig BGP Common Multiprotocol Module

openconfig-bgp-common-structure.yang version 3.0.1, OpenConfig BGP Common Structure Module

openconfig-bgp-global.yang version 3.0.1, OpenConfig BGP Global Module

openconfig-bgp-neighbor.yang version 3.0.1, OpenConfig BGP Neighbor Module

openconfig-bgp-peer-group.yang version 3.0.1, OpenConfig BGP Peer Group Module

openconfig-bgp-policy.yang version 4.0.1, OpenConfig BGP Policy Module

openconfig-if-aggregate.yang version 2.0.0, OpenConfig Interfaces Aggregated Module

openconfig-if-ethernet.yang version 2.0.0, OpenConfig Interfaces Ethernet Module

openconfig-if-ip.yang version 2.0.0, OpenConfig Interfaces IP Module

openconfig-if-ip-ext.yang version 2.0.0, OpenConfig Interfaces IP Extensions Module

openconfig-interfaces.yang version 2.0.0, OpenConfig Interfaces Module

openconfig-isis.yang version 0.3.0, OpenConfig IS-IS Module

openconfig-isis-policy.yang version 0.3.0, OpenConfig IS-IS Policy Module

openconfig-isis-routing.yang version 0.3.0, OpenConfig IS-IS Routing Module

openconfig-lacp.yang version 1.1.0, OpenConfig LACP Module

openconfig-lldp.yang version 0.1.0, OpenConfig LLDP Module

openconfig-local-routing.yang version 1.0.1, OpenConfig Local Routing Module

openconfig-network-instance.yang version 0.8.0, OpenConfig Network Instance Module

openconfig-mpls.yang version 2.3.0, OpenConfig MPLS Module

openconfig-mpls-rsvp.yang version 2.3.0, OpenConfig MPLS RSVP Module

openconfig-mpls-te.yang version 2.3.0, OpenConfig MPLS TE Module

openconfig-packet-match.yang version 1.0.0, OpenConfig Packet Match Module

openconfig-platform.yang version 0.12.2, OpenConfig Platform Module

openconfig-platform-fan.yang version 0.1.1, OpenConfig Platform Fan Module

openconfig-platform-linecard.yang version 0.1.2, OpenConfig Platform Linecard Module

openconfig-relay-agent.yang version 0.1.0, OpenConfig Relay Agent Module

openconfig-routing-policy.yang version 3.0.0, OpenConfig Routing Policy Module

openconfig-system-logging.yang version 0.3.1, OpenConfig System Logging Module

openconfig-system-terminal.yang version 0.3.0, OpenConfig System Terminal Module

openconfig-telemetry.yang version 0.5.0, OpenConfig Telemetry Module

openconfig-vlan.yang version 2.0.0, OpenConfig VLAN Module

Docs: Finance

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Accounts
General ledger groups
General ledgers
Taxes
Tax suppliers
Customer types
Bill Items

To access this section in Monetization, from the Menu, select Business configuration, and click Finance.

Accounts

To access this section, click Accounts. A paginated list of all accounts is shown in a tabular format.

An account is used for general ledger mappings and financial bookkeeping.

Three actions/subpages can be performed/viewed under this section, namely:

Create account
Details account page
Update account

Create account

Under accounts, to create an account, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

In addition, choose the type of account; they refer directly to accounting types. They are as follows:

Asset
Expense
Equity
Liability
Revenue

Details account page

Under accounts, to see the full details of a particular account, click Details. It contains the following:

Name
Code
Description
Type

Update account

Under accounts, to update an account, first, click Details; it shows the details of the account. Then to update, click Update.

Information:

All information filled out under the create account section can be updated except for the Code.

General ledger groups

To access this section, click General ledger groups. A paginated list of all general ledger groups is shown in a tabular format.

A general ledger group can be used to group multiple general ledgers. Groups of general ledgers can be targeted for financial reports.

Four actions/subpages can be performed/viewed under this section, namely:

Create a general ledger group
Details general ledger group page
Update general ledger group
Delete general ledger group

Create a general ledger group

Under general ledger groups, to create a general ledger group, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Details general ledger group page

Under general ledger groups, to see the full details of a particular general ledger group, click Details. It contains the following:

Name
Code
Description

Update general ledger group

Under general ledger groups, to update a general ledger group, first, click Details; it shows the details of the general ledger group. Then to update, click Update.

Information:

All information filled out under the create a general ledger group section can be updated except for the Code.

Delete general ledger group

Under general ledger groups, to delete a general ledger group, click Delete.

Note:

Deleting a general ledger group already used in a general ledger cannot be done. Every particular reference to the general ledger group first has to be deleted.

General ledgers

To access this section, click General ledgers. A paginated list of all general ledgers is shown in a tabular format.

A general ledger can have account mappings, which are used to keep track of financial journals.

Four actions/subpages can be performed/viewed under this section, namely:

Create a general ledger
Details general ledger page
Update general ledger
Delete general ledger

Create a general ledger

Under general ledgers, to create a general ledger, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

To include a general ledger as part of a group of general ledgers, select the general ledger group.

To add an account mapping, under Account mappings, click Add mapping. Choose the condition, amount type, debit account, and credit account.

Information:

The debit/credit account is created under accounts. For more information, see Accounts.

Example of an account mapping

Condition	Amount type	Debit Account	Credit Account
billed	tax	Subscriptions: Tax	Accounts Receivable
billed	net	Subscriptions	Accounts Receivable
billed	discount	Accounts Receivable	Subscriptions: Discount
unbilled	net	Subscriptions	Accounts Receivable
unbilled	discount	Accounts Receivable	Subscriptions: Discount
unbilled	tax	Subscriptions: Tax	Accounts Receivable

Details general ledger page

Under general ledgers, to see the full details of a particular general ledger, click Details. It contains the following:

Name
Code
Description
Account mappings (if any)

Update general ledger

Under general ledgers, to update a general ledger, first, click Details; it shows the details of the general ledger. Then to update, click Update.

Information:

All information filled out under the create a general ledger section can be updated except for the Code.

Delete general ledger

Under general ledgers, to delete a general ledger, click Delete.

Note:

Deleting a general ledger already used in other parts of Monetization cannot be done. Every particular reference to the general ledger first has to be deleted.

Taxes

To access this section, click Taxes. A paginated list of all taxes is shown in a tabular format.

A tax is an object that can be added to a price to calculate a tax, such as VAT.

Four actions/subpages can be performed/viewed under this section, namely:

Create tax
Details tax page
Update tax
Delete tax

Create tax

Under taxes, to create a tax, click Create new. Provide a name, code, description, and validity period.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Information:

The provider is only applicable in the case of a third-party taxation gateway provider that Monetization provides. Otherwise, the tax is percentage based.

Details tax page

Under taxes, to see the full details of a particular tax, click Details. It contains the following:

Name
Code
Description
Validity
Provider
Value
Type

Update tax

Under taxes, to update a tax, first, click Details; it shows the details of the tax. Then to update, click Update.

Information:

All information filled out under the create tax section can be updated except for the Code.

Delete tax

Under taxes, to delete a tax, click Delete.

Note:

Deleting a tax already used in other parts of Monetization cannot be done. Every particular reference to the tax first has to be deleted.

Tax suppliers

To access this section, click Tax suppliers. A paginated list of all tax suppliers is shown in a tabular format.

A tax supplier refers to your company and includes any information relevant to reporting to the tax authorities.

Four actions/subpages can be performed/viewed under this section, namely:

Create tax supplier
Details tax supplier page
Update tax supplier
Delete tax supplier

Create tax supplier

Under tax suppliers, to create a tax supplier, click Create new. Provide a name, code, description, address, country, city, and zip code.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Other configurations, which include whether your company is facilities-based, is a franchise and is regulated, can impact how taxes are treated when working with third-party integration.

Furthermore, choose the service class, which can be local or primary long distance, and the business class, which can be ILEC or CLEC.

Details tax supplier page

Under tax suppliers, to see the full details of a particular tax supplier, click Details. It contains the following:

Name
Code
Description
Address
Country
State
City
ZIP
Facilities based
Franchise
Regulated
Service class
Business class

Update tax supplier

Under tax suppliers, to update a tax supplier, first, click Details; it shows the details of the tax. Then to update, click Update.

Information:

All information filled out under the create tax supplier section can be updated except for the Code.

Delete tax supplier

Under tax suppliers, to delete a tax supplier, click Delete.

Note:

Deleting a tax supplier already used in other parts of Monetization cannot be done. Every particular reference to the tax supplier first has to be deleted.

Customer types

To access this section, click Customer types. A paginated list of all customer types is shown in a tabular format.

The customer type in Monetization is used to segregate customers or to create different customer categories, which can be helpful for statistics and analytics purposes.

Examples of a customer type

Vendor
Reseller
Company
Supplier
Partner
Agent
Person
Operator

Note:

During the onboarding process of a customer, you must insert a customer type.

Information:

Under analytics in Monetization, you can filter by customer types for usage.

Four actions/subpages can be performed/viewed under this section, namely:

Create customer type
Details customer type page
Update customer type
Delete customer type

Create customer type

Under customer types, to create a customer type, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

A customer type can be marked as sensitive data; use the Sensitive data toggle switch to enable/disable. If enabled, any customer object of this type represents a person or legal entity in Monetization.

Note:

Sensitive customer types cannot be accessed from the onboarding process of the self-care portal. By default, all customer types are sensitive.

Non-sensitive customer types are meant to represent customer objects which do not contain sensitive (personal) data and are only used for tracking relationships between different customer objects in special use cases such as utilities (Customer – Apartment).

Details customer type page

Under customer types, to see the full details of a particular customer type, click Details. It contains the following:

Name
Code
Description
Sensitive data

Update customer type

Under customer types, to update a customer type, first, click Details; it shows the details of the customer type. Then to update, click Update.

Information:

All information filled out under the create customer type section can be updated except for the Code.

Delete customer type

Under customer types, to delete a customer type, click Delete.

Note:

Deleting a customer type already used in other parts of Monetization cannot be done. Every particular reference to the customer type first has to be deleted.

Bill Items

To access this section, click Bill Items. A paginated list of all bill items is shown in a tabular format.

A bill item is in charge of how Monetization represents charges on the bill/invoice. When a product is created, or when any impact occurs that affects the monetary resource, the bill item must be provided for Monetization to know how to represent the charge(s) on the bill/invoice.

Example of bill item

The bill item Subscription Monthly Fee can be used for three different products:

Monthly Package Gold @ $30
Monthly Package Silver @ $25
Monthly Package Bronze @ $20

Even though the products are different with different prices, on the invoice, it will be displayed as Subscription Monthly Fee with their specific price due to the common bill item.

Four actions/subpages can be performed/viewed under this section, namely:

Create bill item
Details bill item page
Update bill item
Delete bill item

Create bill item

Under bill items, to create a bill item, click Create new. Provide a name, code, and type (Cumulative or Individual). Optionally, add a description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Information:

A bill item either has a cumulative/individual type. Setting the bill item to have an individual type means if there are multiple items with the same bill item on the same invoice, they would be presented on separate lines.

However, setting the bill item to have a cumulative type means if there are multiple items with the same bill item on the same invoice, they would be grouped together.

To include the bill item on the invoice, use the Included on invoice toggle switch to enable/disable. Enabling this feature means that Monetization will pull this data on the JSON object generated for one invoice.

Note:

Only include the information needed on the invoice for performance optimization.

Details bill item page

Under bill items, to see the full details of a particular bill item, click Details. It contains the following information:

Name
Code
Description
Type
Included on invoice?

Update bill item

Under bill items, to update the bill item, first, click Details; it shows the details of the bill item. Then to update, click Update.

Information:

All information filled out under the create bill item section can be updated except for the Code.

Delete bill item

Under bill items, to delete a bill item, click Delete.

Note:

Deleting a bill item already used in other parts of Monetization cannot be done. Every particular reference to the bill item first has to be deleted.

Docs: Packages

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Plans
Bundles
Terms
Coupons

To access this section in Monetization, from the Menu, select Catalog, and click Packages.

Plans

To access this section, click Plans. A paginated list of all plans is shown in a tabular format.

Plans are the highest level object in Monetization while designing your offering catalog. A plan is what customers subscribe to consume a service(s) or use a product resource(s).

A plan can consist of multiple bundles, where each bundle is a group of products and discounts which are ultimately responsible for granting resources to the customer.

Four actions/subpages can be performed/viewed under this section, namely:

Create plan
Details plan page
Update plan
Delete plan

Create plan

Under plans, to create a plan, click Create new. The name, code, bundles, and validity period are required, while the description, term, compatible bundles, compatible bundles only, and supported payment types are optional.

Information:

The code is a unique identifier of an object; it must be distinct on each site. It can also be used during integration with Monetization API.

During the onboarding process of a customer, a plan must be selected at the subscription section. Additional bundles (add-ons) can also be included and purchased with the plan.

However, suppose compatible bundles only is enabled by using the Compatible bundles only toggle switch, and a list of compatible bundles is provided. In that case, this will specify which bundles the customer can purchase as add-ons to the plan.

Note:

If a customer has a postpaid payment type, and the plan is defined only to work for a prepaid payment type by checking the checkbox Prepaid, only. The plan will not be available to the customer for purchase.

Information:

Enabling sensitive data on a plan using the Sensitive data toggle switch means the plan cannot be accessed during the onboarding process of a new customer in the self-care portal.

Details plan page

Under plans, to see the full details of a plan, click Details. It contains the following:

Status
Name
Code
Description
Validity period
Term
Bundles
Compatible bundles
Compatible bundles only
Supported payment types
Sensitive data

Information:

A plan with the status of Active means the plan is still valid.

Update plan

Under plans, to update a plan, first, click Details; it shows the details of the plan. Then to update, click Update.

Note:

All information filled out under the create plan section can be updated, except for the Code.

Delete plan

Under plans, to delete a plan, click Delete.

Note:

Deleting a plan that a customer has already purchased cannot be done. An object related to something else in Monetization cannot be deleted.

Bundles

To access this section, click Bundles. A paginated list of all bundles is shown in a tabular format.

Bundles are logical groups of products and discounts, which can be part of a plan or purchased separately as an add-on. It is the lowest hierarchy object that a customer can still purchase as a single object on a subscription.

Information:

Rateplan Product/Discount Bundle Plan; shows the complete catalog hierarchy in Monetization.

Bundles can have unlimited products and discounts, and they can either be optional or mandatory. A bundle is like a middle object that connects a product to a plan and can have specific term tied to it.

Information:

When a customer purchases something additional on an existing subscription, it will be a bundle, not a specific single product.

Four actions/subpages can be performed/viewed under this section, namely:

Create bundle
Details bundle page
Update bundle
Delete bundle

Create bundle

Under bundles, to create a bundle, click Create new. The name, code, validity period, and a single product or discount from your offering catalog are required.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Information:

Multiple products can be part of multiple bundles; they have a many-to-many relationship. The same also applies to discounts.

Once a product is selected, it is marked as red. This means the product is required, and the customer must purchase it as part of the bundle. If the red button is clicked, it will change to blue, which means the product is optional.

If a product is optional, when a customer purchases the bundle, they can either include it as part of the purchase or not.

A term can also be chosen for the bundle. The term specifies the commitment period expected from the customer after the bundle is purchased. For more information, see Terms.

The validity period means when the bundle will be available for purchase.

Tip:

The Valid to input field should be left to infinite. However, if the bundle should be moved out of service, then set Valid from to today’s date and Valid to to tomorrow. Therefore, this bundle will no longer be available for purchase the next day.

Details bundle page

Under bundles, to see the full details of a bundle, click Details. It contains the following:

Status
Name
Code
Products
Discounts
Term
Validity period

Information:

A bundle with the status of Active means the bundle is still valid.

Update bundle

Under bundles, to update a bundle, first, click Details; it shows the details of the bundle. Then to update, click Update.

Note:

All information filled out under the create bundle section can be deleted except for the Code.

Delete bundle

Under bundles, to delete a bundle, click Delete.

Note:

Deleting a bundle a customer has already purchased or linked to a plan cannot be done. An object related to something else in Monetization cannot be deleted.

Terms

To access this section, click Terms. A paginated list of all terms is shown in a tabular format.

A term is assigned to either a plan or bundle to know how long they should be effective. It specifies the commitment levels expected from a customer and any penalty fees that may be applicable if the customer cancels prematurely.

Four actions/subpages can be performed/viewed under this section, namely:

Create term
Details term page
Update term
Delete term

Create term

Under terms, to create a term, click Create new.

Under the commitment duration base, choose between:

Billing cycle
Actual

The Billing cycle specifies the number of billing cycles the term is in effect, while Actual means the actual period after the purchase.

Provide a commitment period which could either be in days, months, or years. For example, configuring the commitment period to one year means the customer has to be subscribed to the plan/bundle for at least a year.

Under early termination, choose between:

Allowed
Penalty
Not allowed

Selecting Allowed means that the customer can terminate the plan before the end of the commitment period without any penalty.

Selecting Not allowed means that Monetization will disallow any form of early termination from the customer.

Selecting Penalty means that the customer will be penalized for terminating the plan before the end of the commitment period.

After selecting Penalty, the following input fields can be configured:

Grace period — a specific number that denotes the time given to the customer to renew the plan before they are fined.
Grace period time unit — it could be in days, months, or years.
Penalty charge (Charge up to) — specifies how much the customer will be charged.
Prorated penalty — if configured, the penalty charge will be adjusted for a specific period. For example, a customer leaving towards the end of the term should have a lesser penalty fee than someone who left earlier.
General ledger — depicts how Monetization will record this penalty fee for financial accounting purposes.
Bill item type — specifies how Monetization will present the charge on the bill/invoice.
Tax
Tax supplier
Renewal term (Auto renew) — enables the connection of one term to another after the expiration of the previous term. For example, after a contract of 2 years expires, it will auto-renew with a different term, such as a 1-year contract, without a penalty fee.

Details term page

Under terms, to see the full details of a particular term, click Details. It contains the following:

Code
Name
Commitment period
Commitment time unit
Commitment duration base
Early termination action
- Grace period [ For early termination with a penalty ]
- Grace period time unit
- Penalty charge
- Prorate penalty
- General ledger
- Bill item type
- Tax
- Tax supplier
- Renewal term

Update term

Under terms, to update a term, first, click Details; it shows the details of the term. Then to update, click Update.

Delete term

Under terms, to delete a term, click Delete.

Note:

Deleting a term linked to either a plan or bundle cannot be done. An object related to something else in Monetization cannot be deleted.

Coupons

To access this section, click Coupons. A paginated list of all coupons is shown in a tabular format.

Coupons are generated code(s) that can give specific bundles that offer customers a discount when consumed. When a customer subscribes to a plan, they can also use a coupon code as part of the purchase; thereby, Monetization will give the customer a discounted price as configured in the coupon.

Tip:

Before configuring a coupon, the discounts and the bundles that use those discounts must have been configured.

Coupon vs. Voucher

A coupon works the same way as a voucher, the difference being that a coupon only lasts for that specific purchase. In contrast, a voucher can give something to the customer on a longer basis.

In addition, a voucher code can be consumed anytime, while a coupon code is used and valid during a purchase, then becomes deactivated.

Example of a coupon

A customer purchases an add-on bundle, Additional service, for $10 and is also consuming a coupon code MINUS 20 as part of that purchase.

If the coupon code contains a bundle with a 20% discount configured to target the Additional service product, the customer will end up paying $8 instead of $10.

Two actions/subpages can be performed/viewed under this section, namely:

Create coupon
Details coupon page

Create coupon

Under coupons, to create a coupon, click Create new. Provide a name, code, vendor, code character set, code template, quantity, redemption quantity, range start, bundle, and validity period; the remaining input fields are optional.

Explanation of some terms

Vendor

This means the name of the entity that owns the coupon. It is only used for information purposes. Your organization name can be used under this section.

Code character set

This can either be numerical or alphanumerical. If numerical is selected, the generated codes will only include numbers, while if alphanumerical is selected, the generated codes will include both letters and numbers.

The code template

This provides the template that Monetization will use to generate the coupon codes.

Note:

Use # as a placeholder for auto-generated codes.

Quantity

This represents the number of coupon codes to be generated.

Redemption quantity

This represents how many times the customer can use each code.

Range start

This represents the starting point for the auto-generated codes.

Practical example

The below shows an example of a coupon configuration setting.

code template = coupon_##
character set = numerical
quantity = 5
redemption quantity = 1
range start = 87

This will yield five generated coupon codes, which the customer can only use once. The codes will be generated as follows based on the code template and range start:

coupon_87
coupon_88
coupon_89
coupon_90
coupon_91

Details coupon page

Under coupons, to see the full details of a coupon, click Details. It contains the following:

Name
Code
Description
Vendor
Type
Code character set
Code template
Quantity
Redemption quantity
Range start
bundle
Validity period

Below the information will be the generated coupon codes shown in a tabular format, including their status and remaining quantity.

Information:

You can filter for the coupon codes by New, In use, Used, Expired, or Canceled.

Docs: Radius

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

RADIUS Protocol
RADIUS Accounting Protocol
RADIUS Disconnect Protocol

RADIUS Protocol

This section give information on how AAA Gateway maps the RADIUS access-control messages for the RADIUS protocol defined in RFC-2865 and RFC-2869.

Section Compliance

The Table 1-1 below lists the compliance information for the RADIUS protocol sections in RFC-2865.

Table 1-1: RFC-2865 Section Compliance

Section Number	Section	Status	Notes
1	Introduction	Not applicable	-
1.1	Specification of Requirements	Not applicable	-
1.2	Terminology	Not applicable	-
2	Operation	Partially supported	-
2.1	Challenge/Response	Supported	-
2.2	Interoperation with PAP and CHAP	Not supported	-
2.3	Proxy	Not applicable	-
2.4	Why UDP?	Not applicable	-
2.5	Retransmission Hints	Supported	-
2.6	Keep-Alives Considered Harmful	Supported	-
3	Packet Format	Supported	-
4	Packet Types	Supported	-
4.1	Access-Request	Supported	-
4.2	Access-Accept	Supported	-
4.3	Access-Reject	Supported	-
4.4	Access-Challenge	Supported	-
5	Attributes	Supported	-
5.1	User-Name	Supported	-
5.2	User-Password	Supported	-
5.3	CHAP-Password	Supported	-
5.4	NAS-IP-Address	Supported	-
5.5	NAS-Port	Supported	-
5.6	Service-Type	Supported	-
5.7	Framed-Protocol	Supported	-
5.8	Framed-IP-Address	Supported	-
5.9	Framed-IP-Netmask	Supported	-
5.10	Framed-Routing	Supported	-
5.11	Filter-Id	Supported	-
5.12	Framed-MTU	Supported	-
5.13	Framed-Compression	Supported	-
5.14	Login-IP-Host	Supported	-
5.15	Login-Service	Supported	-
5.16	Login-TCP-Port	Supported	-
5.17	(unassigned)	Supported	-
5.18	Reply-Message	Supported	-
5.19	Callback-Number	Supported	-
5.20	Callback-Id	Supported	-
5.21	(unassigned)	Supported	-
5.22	Framed-Route	Supported	-
5.23	Framed-IPX-Network	Supported	-
5.24	State	Supported	-
5.25	Class	Supported	-
5.26	Vendor-Specific	Supported	-
5.27	Session-Timeout	Supported	-
5.28	Idle-Timeout	Supported	-
5.29	Termination-Action	Supported	-
5.30	Called-Station-Id	Supported	-
5.31	Calling-Station-Id	Supported	-
5.32	NAS-Identifier	Supported	-
5.33	Proxy-State	Supported	-
5.34	Login-LAT-Service	Supported	-
5.35	Login-LAT-Node	Supported	-
5.36	Login-LAT-Group	Supported	-
5.37	Framed-AppleTalk-Link	Supported	-
5.38	Framed-AppleTalk-Network	Supported	-
5.39	Framed-AppleTalk-Zone	Supported	-
5.40	CHAP-Challenge	Supported	-
5.41	NAS-Port-Type	Supported	-
5.42	Port-Limit	Supported	-
5.43	Login-LAT-Port	Supported	-
5.44	Table of Attributes	Supported	-
6	IANA Considerations	No requirement	-
6.1	Definition of Terms	No requirement	-
6.2	Recommended Registration Policies	No requirement	-
7	Examples	Supported	-
7.1	User Telnet to Specified Host	Supported	-
7.2	Framed User Authenticating with CHAP	Supported	-
7.3	User with Challenge-Response card	Not supported	-
8	Security Considerations	Not supported	-
9	Change Log	No requirement	-
10	References	No requirement	-
11	Acknowledgements	No requirement	-
12	Chair’s Address	No requirement	-
13	Authors’ Addresses	No requirement	-
14	Full Copyright Statement	No requirement	-

The following Table 1-2 provides a list of the compliance information for the RADIUS protocol sections in RFC-2869.

Table 1-2: RFC-2869 Section Compliance

Section Number	Section	Status	Notes
1	Introduction	Not applicable	-
1.1	Specification of Requirements	Not applicable	-
1.2	Terminology	Not applicable	-
2	Operation	Partially supported	-
2.1	RADIUS support for Interim Accounting Updates	Not supported	-
2.2	RADIUS support for Apple Remote Access Protocol	Not supported	-
2.3	RADIUS Support for Extensible Authentication Protocol (EAP)	Supported	-
2.3.1	Protocol Overview	Supported	-
2.3.2	Retransmission	Supported	-
2.3.3	Fragmentation	Not supported	-
2.3.4	Examples	Supported	-
2.3.5	Alternative Uses	Supported	-
3	Packet Format	Supported	-
4	Packet Types	Supported	-
5	Attributes	Partially supported	-
5.1	Acct-Input-Gigawords	Not supported	-
5.2	Acct-Output-Gigawords	Not supported	-
5.3	Event-Timestamp	Not supported	-
5.4	ARAP-Password	Not supported	-
5.5	ARAP-Features	Not supported	-
5.6	ARAP-Zone-Access	Not supported	-
5.7	ARAP-Security	Not supported	-
5.8	ARAP-Security-Data	Not supported	-
5.9	Password-Retry	Not supported	-
5.10	Prompt	Not supported	-
5.11	Connect-Info	Not supported	-
5.12	Configuration-Token	Not supported	-
5.13	EAP-Message	Supported	-
5.14	Message-Authenticator	Supported	-
5.15	ARAP-Challenge-Response	Not supported	-
5.16	Acct-Interim-Interval	Not supported	-
5.17	NAS-Port-Id	Supported	-
5.18	Framed-Pool	Not supported	-
5.19	Table of Attributes	Not supported	-
6	IANA Considerations	No requirement	-
7	Security Considerations	Supported	-
7.1	Message-Authenticator Security	Supported	-
7.2	EAP Security	Supported	-
7.2.1	Separation of EAP server and PPP authenticator	Not supported	-
7.2.2	Connection hijacking	Not supported	-
7.2.3	Man in the middle attacks	Not supported	-
7.2.4	Multiple databases	Not supported	-
7.2.5	Negotiation attacks	Not supported	-
8	References	No requirement	-
9	Acknowledgements	No requirement	-
10	Chair’s Address	No requirement	-
11	Authors’ Addresses	No requirement	-
12	Full Copyright Statement	No requirement	-

Access-Request AVPs

Here is a Table 1-3 with the compliance information for Access-Request attribute-value pairs (AVPs).

Table 1-3: Access-Request AVPs

RADIUS AVP	Status	Notes
User-Name	Supported	-
User-Password	Supported	-
CHAP-Password	Supported	-
CHAP-Challenge	Supported	-
NAS-IP-Address	Supported	-
NAS-Port	Supported	-
NAS-Port-Type	Supported	-
NAS-Identifier	Supported	-
Service-Type	Supported	-
Framed-Protocol	Supported	-
Framed-IP-Address	Supported	-
Framed-IP-Netmask	Supported	-
Framed-MTU	Supported	-
Framed-Compression	Supported	-
Login-IP-Host	Supported	-
Callback-Number	Supported	-
Called-Station-Id	Supported	-
Calling-Station-Id	Supported	-
State	Supported	-
Proxy-State	Supported	-
Login-LAT-Service	Supported	-
Login-LAT-Node	Supported	-
Login-LAT-Group	Supported	-
Login-LAT-Port	Supported	-
Vendor-Specific	Supported	-
EAP-Message	Supported	-
Message-Authenticator	Supported	-

Access-Accept AVPs

Below is the compliance information for Access-Accept AVPs.

Table 1-4: Access-Accept AVPs

RADIUS AVP	Status	Notes
User-Name	Supported	-
Service-Type	Supported	-
Framed-Protocol	Supported	-
Framed-IP-Address	Supported	-
Framed-IP-Netmask	Supported	-
Framed-Routing	Supported	-
Framed-Route	Supported	-
Framed-IPX-Network	Supported	-
Framed-AppleTalk-Link	Supported	-
Framed-AppleTalk-Network	Supported	-
Framed-AppleTalk-Zone	Supported	-
Filter-Id	Supported	-
Framed-MTU	Supported	-
Framed-Compression	Supported	-
Login-IP-Host	Supported	-
Login-Service	Supported	-
Login-TCP-Port	Supported	-
Reply-Message	Supported	-
Callback-Number	Supported	-
Callback-Id	Supported	-
Class	Supported	-
Session-Timeout	Supported	-
Idle-Timeout	Supported	-
Termination-Action	Supported	-
State	Supported	-
Proxy-State	Supported	-
Login-LAT-Service	Supported	-
Login-LAT-Node	Supported	-
Login-LAT-Group	Supported	-
Login-LAT-Port	Supported	-
Port-Limit	Supported	-
Vendor-Specific	Supported	-
Acct-Session-Id	Supported	-
EAP-Message	Supported	-
Message-Authenticator	Supported	-

Access-Reject AVPs

Table 1-5 has a list of the compliance information for Access-Reject AVPs.

Table 1-5: Access-Reject AVPs

RADIUS AVP	Status	Notes
User-Name	Supported	-
Reply-Message	Supported	-
Class	Supported	-
Proxy-State	Supported	-
Vendor-Specific	Supported	-
Acct-Session-Id	Supported	-
EAP-Message	Supported	-
Message-Authenticator	Supported	-

Access-Challenge AVPs

Table 1-6 contains the compliance information for Access-Challenge AVPs.

Table 1-6: Access-Challenge AVPs

RADIUS AVP	Status	Notes
Reply-Message	Supported	-
Session-Timeout	Supported	-
Idle-Timeout	Supported	-
State	Supported	-
Proxy-State	Supported	-
Vendor-Specific	Supported	-
EAP-Message	Supported	-
Message-Authenticator	Supported	-

RADIUS Accounting Protocol

This section provides details on how AAA Gateway maps the RADIUS accounting messages for the RADIUS protocol defined in RFC-2866.

Section Compliance

Below is a list of the compliance information for the RADIUS Accounting protocol sections in RFC-2866.

Table 2-1 RFC-2866 Section Compliance

Section Number	Section	Status	Notes
1	Introduction	Not applicable	-
1.1	Specification of Requirement	Not applicable	-
1.2	Terminology	Not applicable	-
2	Operation	Supported	-
2.1	Proxy	Not supported	-
3	Packet Format	Supported	-
4	Packet Types	Supported	-
4.1	Accounting-Request	Supported	-
4.2	Accounting-Response	Supported	-
5	Attributes	Supported	-
5.1	Acct-Status-Type	Supported	-
5.2	Acct-Delay-Time	Supported	-
5.3	Acct-Input-Octets	Supported	-
5.4	Acct-Output-Octets	Supported	-
5.5	Acct-Session-Id	Supported	-
5.6	Acct-Authentic	Supported	-
5.7	Acct-Session-Time	Supported	-
5.8	Acct-Input-Packets	Supported	-
5.9	Acct-Output-Packets	Supported	-
5.10	Acct-Terminate-Cause	Supported	-
5.11	Acct-Multi-Session-Id	Supported	-
5.12	Acct-Link-Count	Supported	-
5.13	Table of Attributes	Supported	-
6	IANA Considerations	Supported	-
7	Security Considerations	Supported	-
8	Change Log	Not applicable	-
9	References	No Requirement	-
10	Acknowledgements	No requirement	-

Accounting-Request AVPs

The following table contains the description of how ECE supports Accounting-Request attribute-value pairs (AVPs).

Table 2-2 Accounting-Request AVPs

RADIUS Accounting AVP	Status	Notes
User-Name	Supported	This is mandatory AVP.
NAS-IP-Address	Supported	This is mandatory AVP.
NAS-Identifier	Supported	This is mandatory AVP.
NAS-Port-Type	Supported	-
Class	Supported	-
Service-Type	Supported	-
Framed-Protocol	Supported	-
Framed-IP-Address	Supported	-
Framed-IP-Netmask	Supported	-
Framed-MTU	Supported	-
Framed-Compression	Supported	-
Login-IP-Host	Supported	-
Callback-Number	Supported	-
Called-Station-Id	Supported	-
Calling-Station-Id	Supported	-
Proxy-State	Supported	-
Login-LAT-Service	Supported	-
Login-LAT-Node	Supported	-
Login-LAT-Group	Supported	-
Login-LAT-Port	Supported	-
CHAP-Challenge	Supported	-
Acct-Status-Type	Supported	This is mandatory AVP.
Acct-Delay-Time	Supported	-
Acct-Input-Octets	Supported	-
Acct-Output-Octets	Supported	-
Acct-Session-Id	Supported	This is mandatory AVP.
Acct-Authentic	Supported	-
Acct-Session-Time	Supported	-
Acct-Input-Packets	Supported	-
Acct-Output-Packets	Supported	-
Acct-Terminate-Cause	Supported	-
Acct-Multi-Session-Id	Supported	-
Acct-Link-Count	Supported	-
Vendor-Specific	Supported	-

Accounting-Response AVPs

The Accounting-Response message does not have any AVPs.

RADIUS Disconnect Protocol

This section describes how AAA Gateway maps the RADIUS disconnect messages for the RADIUS protocol defined in RFC-3576.

Section Compliance

Below is the the compliance information for the RADIUS Disconnect protocol sections in RFC-3576.

Table 3-1 RFC-3576 Section Compliance

Section Number	Section	Status	Notes
1	Introduction	-	-
1.1	Applicability	-	-
1.2	Requirements Language	-	-
1.3	Terminology	-	-
2	Overview	-	-
2.1	Disconnect Messages (DM)	-	-
2.2	Change-of-Authorization Messages (CoA)	-	-
2.3	Packet Format	-	-
3	Attributes	-	-
3.1	Error-Cause	-	-
3.2	Table of Attributes	-	-
4	IANA Considerations	-	-
5	Security Considerations	-	-
5.1	Authorization Issues	-	-
5.2	Impersonation	-	-
5.3	IPsec Usage Guidelines	-	-
5.4	Replay Protection	-	-
6	Example Traces	-	-
7	References	-	-
7.1	Normative References	-	-
7.2	Informative References	-	-
8	Intellectual Property Statement	-	-
9	Acknowledgements	-	-
10	Author’s Addresses	-	-
11	Full Copyright Statement	-	-

Disconnect-Request AVPs

The following Table 3-2 lists the compliance information for Disconnect-Request attribute-value pairs (AVPs).

Table 3-2: Disconnect-Request AVPs

RADIUS AVP	Status	Notes
User-Name	Supported	-
User-Password	Supported	-
CHAP-Password	Supported	-
CHAP-Challenge	Supported	-
NAS-IP-Address	Supported	-
NAS-Port	Supported	-
NAS-Port-Type	Supported	-
NAS-Identifier	Supported	-
Service-Type	Supported	-
Framed-Protocol	Supported	-
Framed-IP-Address	Supported	-
Framed-IP-Netmask	Supported	-
Framed-MTU	Supported	-
Framed-Compression	Supported	-
Login-IP-Host	Supported	-
Callback-Number	Supported	-
Called-Station-Id	Supported	-
Calling-Station-Id	Supported	-
State	Supported	-
Proxy-State	Supported	-
Login-LAT-Service	Supported	-
Login-LAT-Node	Supported	-
Login-LAT-Group	Supported	-
Login-LAT-Port	Supported	-
Vendor-Specific	Supported	-
EAP-Message	Supported	-
Message-Authenticator	Supported	-

Disconnect-Response AVPs

The Disconnect-Response message have no AVPs.

Docs: Taxation Gateways

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select System configuration, and click Taxation gateways.

Monetization supports two taxation gateways out-of-the-box, which are:

SureTax
Avalara

Note:

A customer can only use one taxation gateway provider at a time in Monetization. Using multiple taxation gateways simultaneously is not supported.

Information:

In Monetization, taxation occurs as soon as rating happens. For instance, suppose a customer calls for 100 minutes; once the call is rated, the configured taxation gateway is immediately called to get the tax rate.

SureTax

Suretax is a cloud-based tax calculation software provider that offers businesses a comprehensive platform for managing tax compliance processes.

To configure, click SureTax; insert your API key and company identifier. Use the Active toggle switch to activate/deactivate the configuration. Once activated and configured, Monetization can communicate with SureTax.

Note:

Clicking Test Connection will try a test request to the taxation gateway provider to confirm that the connection with the inserted keys is okay.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

Avalara

Avalara is a cloud-based tax compliance software provider that offers businesses a comprehensive platform for managing tax compliance processes. Its solutions automate tax calculation, filing, and remittance, making it easy for businesses to comply with complex tax regulations.

To configure, click Avalara; insert your API key, company identifier, client ID, and client profile ID. Use the Active toggle switch to activate/deactivate the configuration. Once activated and configured, Monetization can communicate with SureTax.

Note:

Clicking Test Connection will try a test request to the taxation gateway provider to confirm that the connection with the inserted keys is okay.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

Docs: 5G CHF

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Introduction
- How To Interpret The Status In The Compliance Sections
Charging Function - Charging Service
- Section Compliance
- Response Codes
Charging Function - Spending Limit Control Service
- Section Compliance
- Response Codes
Charging Function - Interactions with Network Repository Function (NRF)
- Section Compliance
CHF-CDR Format

Introduction

The 5G CHF includes Nchf interfaces to enable converged charging and spending limit control for policy management. Interactions with the Network Repository Function are also outlined here.

How To Interpret The Status In The Compliance Sections

The following table describes the meaning of the status in section compliance sections.

Status	Meaning
Supported	Application supports functionality. Application supports the attribute and is mapped to the charging function. The attribute is received in the request and used in the charging flows. This attribute is sent in the response as indicated by the specifications. Optionally, you can utilize this attribute for event storage and to inform charging decisions.
Supported with Extensions	Application supports functionality with extension. The application supports the attribute and can be optionally utilized to select a price. The attribute is received in the request and is not used in the out-of-the-box charging flow. The attribute may or may not be sent in the response. You have an option to leverage available extensions in the charging flow to achieve the intended functionality. You can also prefer to use this attribute for storing in the event, and for making charging decisions.
Not Supported	Application does not support the functionality or the attribute.
Not Applicable	The section is not applicable for the implementation.
Informational	This section serves solely for informational purposes.

Charging Function – Charging Service

Section Compliance

The table below contains the description of the section compliance of the 5G System Charging Service 3GPP TS 32.291 v16.5.1 (2020-09):

Table 1-1: 5G System Charging Service 3GPP TS 32.291 v16.5.1 (2020-09) Section Compliance

Section Number	Section	Status	Notes
1	Scope	Informational	-
2	References	Informational	-
3	Definitions, symbols and abbreviations	Informational	-
4	Overview	Supported	-
5	Services offered by CHF	Supported	-
5.1	Introduction	Supported	-
5.2	Nchf_ConvergedCharging service	Supported	-
5.2.1	Service description	Supported	-
5.2.2	Service operations	Supported	-
5.2.2.1	Introduction	Supported	-
5.2.2.2	Nchf_ConvergedCharging_Create Operation	Supported	-
5.2.2.3	Nchf_ConvergedCharging_Update Operation	Supported	-
5.2.2.4	Nchf_ConvergedCharging_Release Operation	Supported	-
5.2.2.5	Nchf_ConvergedCharging_Notify Operation	Supported	-
5.3	Nchf_OfflineOnlyCharging service	Supported	-
5.3.1	Service description	Supported	-
5.3.2	Service operations	Supported	-
5.3.2.1	Introduction	Supported	-
5.3.2.2	Nchf_OfflineOnlyCharging_Create Operation	Supported	-
5.3.2.3	Nchf_OfflineOnlyCharging_Update Operation	Supported	-
5.3.2.4	Nchf_OfflineOnlyCharging_Release Operation	Supported	-
6	API Definitions	Supported	-
6.1	Nchf_ConvergedCharging Service API	Supported	-
6.1.1	Introduction	Supported	-
6.1.2	Usage of HTTP	Supported	-
6.1.2.1	General	Supported	-
6.1.2.2	HTTP standard headers	Supported	-
6.1.2.2.1	General	Supported	-
6.1.2.2.2	Content type	Supported	-
6.1.2.3	HTTP custom headers	Supported	Only 3gpp-Sbi-Target-apiRoot header is supported among custom headers.
6.1.2.3.1	General	Supported	-
6.1.3	Resources	Supported	-
6.1.3.1	Overview	Supported	-
6.1.3.2	Resource: Charging Data	Supported	-
6.1.3.2.1	Description	Supported	-
6.1.3.2.2	Resource Definition	Supported	-
6.1.3.2.3	Resource Standard Methods	Supported	-
6.1.3.2.3.1	POST	Supported	ChargingDataRequest and ChargingDataResponse. The response includes one of the following codes: For success 201 (created). For failure ProblemDetails include - 400, 403, 404.
6.1.3.2.4	Resource Custom Operations	Not Applicable	-
6.1.3.3	Resource: Individual Charging Data	Supported	-
6.1.3.3.1	Description	Supported	-
6.1.3.3.2	Resource Definition	Supported	-
6.1.3.3.3	Resource Standard Methods	Not Applicable	-
6.1.3.3.4	Resource Custom Operations	Supported	-
6.1.3.3.4.1	Overview	Supported	-
6.1.3.3.4.2	Operation: update	Supported	-
6.1.3.3.4.2.1	Description	Supported	-
6.1.3.3.4.2.2	Operation Definition	Supported	ChargingDataRequest and ChargingDataResponse. The response includes one of the following codes: For success 200 (OK). For failure ProblemDetails include - 400, 403, 404.
6.1.3.3.4.3	release	Supported	-
6.1.3.3.4.3.1	Description	Supported	-
6.1.3.3.4.3.2	Operation Definition	Supported	ChargingDataRequest and ChargingDataResponse. For success the response will be 204 (No content). For failure ProblemDetails include - 404.
6.1.4	Custom Operations without associated resources	Not Applicable	-
6.1.5	Notifications	Supported	-
6.1.5.1	General	Supported	-
6.1.5.2	Event Notification	Supported	-
6.1.5.2.1	Description	Supported	-
6.1.5.2.2	Target URI	Supported	-
6.1.5.2.3	Standard Methods	Supported	-
6.1.5.2.3.1	POST	Supported	ChargingDataRequest and ChargingDataResponse. For success the response will be 204 (No content). For failure ProblemDetails include - 404.
6.1.6	Data Model	Supported	-
6.1.6.1	General	Supported	-
6.1.6.2	Structured data types	Supported	-
6.1.6.2.1	Common Data Type	Supported	-
6.1.6.2.1.1	Type ChargingDataRequest	Supported
	subscriberIdentifier	Supported with Extensions
	nfConsumerIdentification	Supported with Extensions
	invocationTimeStamp	Supported
	invocationSequenceNumber	Supported
	retransmissionIndicator	Supported with Extensions
	oneTimeEvent	Supported with Extensions
	oneTimeEventType	Supported with Extensions
	notifyUri	Supported with Extensions
	supportedFeatures	Supported
	serviceSpecificationInfo	Supported with Extensions
	multipleUnitUsage	Supported with Extensions
	triggers	Supported
6.1.6.2.1.2	Type ChargingDataResponse	Supported
	invocationTimeStamp	Supported
	invocationResult	Supported with Extensions
	invocationSequenceNumber	Supported
	sessionFailover	Supported
	supportedFeatures	Supported with Extensions
	multipleUnitInformation	Supported with Extensions
	triggers	Supported
6.1.6.2.1.3	Type ChargingNotifyRequest	Supported with Extensions
	notificationType	Supported with Extensions
	reauthorizatoinDetails	Supported with Extensions
6.1.6.2.1.4	Type NFIdentification	Supported with Extensions
	nodeFunctionality	Supported with Extensions
	nFName	Supported with Extensions
	nFIPv4Address	Supported with Extensions
	nfIPv6Address	Supported with Extensions
	nFFqdn	Supported with Extensions
	nFPLMNID	Supported with Extensions
6.1.6.2.1.5	Type MultipleUnitUsage	Supported
	ratingGroup	Supported
	requestedUnit	Supported
	usedUnitContainer	Supported
6.1.6.2.1.6	Type InvocationResult	Supported with Extensions
	error (ProblemDetails)	Supported with Extensions
	failureHandling	Supported with Extensions
6.1.6.2.1.7	Type Trigger	Supported	See 6.1.6.3.6 for supported Trigger types.
	triggerType	Supported with Extensions
	triggerCategory	Supported with Extensions
	timeLimit (DurationSec)	Supported with Extensions
	volumeLimit	Supported with Extensions
	volumeLimit64	Supported with Extensions
	maxNumberOfccc	Supported with Extensions
6.1.6.2.1.8	Type MultipleUnitInformation	Supported
	resultCode	Supported
	ratingGroup	Supported
	grantedUnit	Supported
	triggers	Supported
	validityTime (DurationSec)	Supported with Extensions
	quotaHandlingTime (DurationSec)	Supported
	finalUnitIndication	Supported
	timeQuotaThreshold	Supported
	volumeQuotaThreshold	Supported with Extensions
	unitQuotaThreshold	Supported with Extensions
6.1.6.2.1.9	Type RequestedUnit	Supported
	time	Supported
	totalVolume	Supported
	uplinkVolume	Supported
	downLinkVolume	Supported
	serviceSpecificUnits	Supported
6.1.6.2.1.10	Type UsedUnitContainer	Supported
	serviceId	Supported
	quotaManagementIndicator	Supported
	triggers	Supported
	triggerTimeStamp	Supported with Extensions
	time	Supported with Extensions
	totalVolume	Supported
	uplinkVolume	Supported
	downlinkVolume	Supported
	serviceSpecificUnits	Supported
	eventTimeStamps	Supported with Extensions
	localSequenceNumber	Supported with Extensions
6.1.6.2.1.11	Type GrantedUnit	Supported
	tariffTimeChange	Supported
	time	Supported
	totalVolume	Supported
	uplinkVolume	Supported
	downlinkVolume	Supported
	serviceSpecificUnits	Supported
6.1.6.2.1.12	Type FinalUnitIndication	Supported
	finalUnitAction	Supported
	restrictionFilterRule	Not Supported
	filterId	Not Supported
	redirectServer	Supported
6.1.6.2.1.13	Type RedirectServer	Supported
	redirectAddressType	Supported
	redirectServerAddress	Supported
6.1.6.2.1.14	Type ReauthorizationDetails	Supported
	service (serviceId)	Supported
	ratingGroup	Supported
	quotaManagementIndicator	Supported
6.1.6.2.1.15	Void	Not applicable
6.1.6.2.1.16	Type ChargingNotifyResponse	Not Supported
	invocationResult	Not Supported
6.1.6.2.2	5G Data Connectivity Specified Data Type	Supported	-
6.1.6.2.2.1	ChargingDataRequest	Supported	The out of the box charging flow does not process records for 5G roaming.
6.1.6.2.2.2	ChargingDataResponse	Supported with Extensions	The out of the box charging flow does not process records for 5G roaming.
6.1.6.2.2.3	MultipleUnitUsage	Supported with Extensions	-
6.1.6.2.2.4	MultipleUnitInformation	Supported with Extensions	-
6.1.6.2.2.5	UsedUnitContainer	Supported with Extensions	-
6.1.6.2.2.6	PDUSessionChargingInformation	Supported with Extensions	uetimeZone is used as the request time for the event.
6.1.6.2.2.7	UserInformation	Supported with Extensions	-
6.1.6.2.2.8	PDUSessionInformation	Supported with Extensions	-
6.1.6.2.2.9	PDUContainerInformation	Supported with Extensions	-
6.1.6.2.2.10	NetworkSlicingInfo	Supported with Extensions	-
6.1.6.2.2.11	PDUAddress	Supported with Extensions	-
6.1.6.2.2.12	ServingNetworkFunctionID	Supported with Extensions	-
6.1.6.2.2.13	RoamingQBCInformation	Supported with Extensions	-
6.1.6.2.2.14	MultipleQFIcontainer	Supported with Extensions	-
6.1.6.2.2.15	RoamingChargingProfile	Supported with Extensions	The out of the box charging flow does not process records for 5G roaming.
6.1.6.2.2.16	QFIContainerInformation	Supported with Extensions	All are supported only in request, not supported in response
6.1.6.2.2.17	RANSecondaryRATUsageReport	Supported with Extensions	-
6.1.6.2.2.18	QosFlowsUsageReport	Supported with Extensions	-
6.1.6.2.2.19	MAPDUSessionInformation	Supported with Extensions	-
6.1.6.2.3	SMS Specified Data Type	Supported with Extensions	-
6.1.6.2.3.1	ChargingDataRequest	Supported with Extensions	-
6.1.6.2.3.2	SMSChargingInformation	Supported with Extensions	-
6.1.6.2.3.3	OriginatorInfo	Supported with Extensions	-
6.1.6.2.3.4	RecipientInfo	Supported with Extensions	-
6.1.6.2.3.5	SMAddressInfo	Supported with Extensions	-
6.1.6.2.3.6	RecipientAddress	Supported with Extensions	-
6.1.6.2.3.7	MessageClass	Supported with Extensions	-
6.1.6.2.3.8	SMAddressDomain	Supported with Extensions	-
6.1.6.2.3.9	SMInterface	Supported with Extensions	-
6.1.6.2.4	5G connection and mobility Specified Data	Not Supported	-
6.1.6.2.4.1	ChargingDataRequest	Not Supported	-
6.1.6.2.4.2	ChargingDataResponse	Not Supported with Extensions	-
6.1.6.2.4.3	Type RegistrationChargingInformation	Not Supported
	registrationMessagetype	Not Supported
	userInformation	Not Supported
	userLocationinfo	Not Supported
	uetimeZone	Not Supported
	rATType	Not Supported
	5gMMCapability	Not Supported
	mICOModeIndication	Not Supported
	smsIndication	Not Supported
	taiList	Not Supported
	serviceAreaRestriction	Not Supported
	requestedNSSAI	Not Supported
	allowedNssai	Not Supported
	rejectedNSSAI	Not Supported
	-	Not Supported
6.1.6.2.4.4	Type N2ConnectionChargingInformation	Not Supported
	n2ConnectionMessageType	Not Supported
	userInformation	Not Supported
	userLocationinfo	Not Supported
	uetimeZone	Not Supported
	rATType	Not Supported
	amfUeNgapId	Not Supported
	ranUeNgapId	Not Supported
	ranNodeId	Not Supported
	restrictedRatList	Not Supported
	forbiddenAreaList	Not Supported
	serviceAreaRestriction	Not Supported
	restrictedCnList	Not Supported
	allowedNssai	Not Supported
	rrcEstCause	Not Supported
	-	Not Supported
6.1.6.2.4.5	Type LocationReportingChargingInformation	Not Supported
	locationReportingMessageType	Not Supported
	userInformation	Not Supported
	userLocation	Not Supported
	infouetimeZone	Not Supported
	presenceReportingAreaInformation	Not Supported
	rATType	Not Supported
	-	Not Supported
6.1.6.2.5	Exposure Function Northbound API Specified	Not Supported
	-	Not Supported
6.1.6.2.5.1	Type ChargingDataRequest	Not Supported

6.1.6.2.5.1a	Type ChargingDataResponse	Not Supported

6.1.6.2.5.2	Type NEFChargingInformation	Not Supported
	groupIdentifier	Not Supported
	aPIDirection	Not Supported
	aPITargetNetworkFunction	Not Supported
	aPIResultCode	Not Supported
	aPIName	Not Supported
	aPIReference	Not Supported
	aPIContent	Not Supported

6.1.6.2.6	Network Slice Management (NSM) Specified Data Type	Not Supported

6.1.6.2.6.1	Type ChargingDataRequest	Not Supported
	tenantIdentifier	Not Supported
	mnSConsumerIdentifier	Not Supported
	nSMChargingInformation	Not Supported

6.1.6.2.6.2	Type ChargingDataResponse	Not Supported

6.1.6.2.6.3	Type NSMChargingInformation	Not Supported
	managementOperation	Not Supported
	idNetworkSliceInstance	Not Supported
	listOfServiceProfileChargingInformation	Not Supported
	managementOperationStatus	Not Supported
	operationalState	Not Supported
	administrativeState	Not Supported

6.1.6.2.6.4	Type ServiceProfileChargingInformation	Not Supported
	serviceProfileIdentifier	Not Supported
	sNSSAIList	Not Supported
	latency	Not Supported
	availability	Not Supported
	resourceSharingLevel	Not Supported
	jitter	Not Supported
	reliability	Not Supported
	maxNumberofUEs	Not Supported
	coverageArea	Not Supported
	uEMobilityLevel	Not Supported
	delayToleranceIndicator	Not Supported
	dLThptPerSlice	Not Supported
	dLThptPerUE	Not Supported
	uLThptPerSlice	Not Supported
	uLThptPerUE	Not Supported
	maxNumberofPDUsessions	Not Supported
	kPIMonitoringList	Not Supported
	supportedAccessTechnology	Not Supported
	v2XCommunicationModeIndicator	Not Supported
	addServiceProfileChargingInfo	Not Supported

6.1.6.2.6.5	Type Throughput	Not Supported
	guaranteedThpt	Not Supported
	maximumThpt	Not Supported

6.1.6.2.7	NS performance and analytics Specified Data Type	Not Supported
6.1.6.2.7.1	Type ChargingDataRequest	Not Supported
	tenantIdentifier	Not Supported
	nSPAChargingInformation	Not Supported
6.1.6.2.7.2	Type ChargingDataResponse	Not Supported
6.1.6.2.7.3	Type UsedUnitContainer	Not Supported
	nSPAContainerInformation	Not Supported
6.1.6.2.7.4	Type NSPAChargingInformation	Not Supported
	singleNSSAI	Not Supported
6.1.6.2.7.5	Type NSPAContainerInformation	Not Supported
	latency	Not Supported
	throughput	Not Supported
	maximumPacketLossRate	Not Supported
	serviceExperienceStatisticsData	Not Supported
	theNumberOfPDUSessions	Not Supported
	theNumberOfRegisteredSubscribers	Not Supported
	loadLevel	Not Supported
6.1.6.3	Simple data types and enumerations	Supported
6.1.6.3.1	Introduction	Supported
6.1.6.3.2	Simple data types	Supported with Extensions
	Diagnostics	Supported with Extensions
	IPFilterRule	Supported with Extensions
	N2ConnectionMessageType	Supported with Extensions
	LocationReportingMessageType	Supported with Extensions
6.1.6.3.3	Enumeration: NotificationType	Supported
6.1.6.3.4	Enumeration: NodeFunctionality	Supported
6.1.6.3.5	Enumeration: ChargingCharacteristicsSelectionMode	Supported
6.1.6.3.6	Enumeration: TriggerType	Supported	FINAL, RAT_CHANGE, and TARIFF_TIME_CHANGE are supported. Other trigger types are supported with extensions.
6.1.6.3.7	Enumeration: FinalUnitAction	Supported
6.1.6.3.8	Enumeration: RedirectAddressType	Supported
6.1.6.3.9	Enumeration: TriggerCategory	Supported
6.1.6.3.10	Enumeration: QuotaManagementIndicator	Supported
6.1.6.3.11	Enumeration: FailureHandling	Supported
6.1.6.3.12	Enumeration: SessionFailover	Supported
6.1.6.3.13	Enumeration: 3GPPPSDataOffStatus	Supported
6.1.6.3.14	Enumeration: ResultCode	Supported
6.1.6.3.15	Enumeration: PartialRecordMethod	Supported
6.1.6.3.16	Enumeration: RoamerInOut	Supported
6.1.6.3.17	Void	Supported
6.1.6.3.18	Enumeration: SMMessageType	Supported
6.1.6.3.19	Enumeration: SMPriority	Supported
6.1.6.3.20	Enumeration: DeliveryReportRequested	Supported
6.1.6.3.21	Enumeration: InterfaceType	Supported
6.1.6.3.22	Enumeration: ClassIdentifier	Supported
6.1.6.3.23	Enumeration: SMAddressType	Supported
6.1.6.3.24	Enumeration: SMAddresseeType	Supported
6.1.6.3.25	Enumeration: SMServiceType	Supported
6.1.6.3.26	Enumeration: ReplyPathRequested	Supported
6.1.6.3.27	Enumeration: DnnSelectionMode	Supported
6.1.6.3.28	Enumeration: EventType	Supported
6.1.6.3.29	Enumeration: MICOModeIndication	Supported
6.1.6.3.30	Enumeration: RegistrationMessageType	Supported
6.1.6.3.31	Enumeration: SmsIndication	Supported
6.1.6.3.32	Enumeration: APIDirection	Supported
6.1.6.3.33	Enumeration: ManagementOperation	Supported
6.1.6.3.34	Enumeration: ManagementOperationStatus	Supported
6.1.6.4	Data types describing alternative data types or combinations of data types	Not Applicable
6.1.6.5	Binary data	Not Applicable
6.1.7	Error handling	Supported
6.1.7.1	General	Supported
6.1.7.2	Protocol Errors	Not Applicable
6.1.7.3	Application errors	Supported
6.1.8	Feature negotiation	Not Supported
6.2	Nchf_OfflineOnlyCharging Service API	Supported
6.2.1	Introduction	Supported
6.2.2	Usage of HTTP	Supported
6.2.3	Resources	Supported
6.2.3.1	Overview	Supported
6.2.3.2	Resource: Charging Data	Supported
6.2.3.2.1	Description	Supported
6.2.3.2.2	Resource Definition	Supported
6.2.3.2.3	Resource Standard Methods	Supported
6.2.3.2.3.1	POST	Supported	ChargingDataRequest and ChargingDataResponse. The response includes one of the following codes: For success 201 (created). For failure ProblemDetails include - 400, 403, and 404.
6.2.3.2.4	Resource Custom Operations	Not Applicable
6.2.3.3	Resource: Individual Offline Only Charging Data	Supported
6.2.3.3.1	Description	Supported
6.2.3.3.2	Resource Definition	Supported
6.2.3.3.3	Resource Standard Methods	Not Applicable
6.2.3.3.4	Resource Custom Operations	Supported
6.2.3.3.4.1	Overview	Supported
6.2.3.3.4.2	Operation: update	Supported
6.2.3.3.4.2.1	Description	Supported
6.2.3.3.4.2.2	Operation Definition	Supported	ChargingDataRequest and ChargingDataResponse. The response includes one of the following codes: For success 200 (OK). For failure ProblemDetails include - 400, 403, and 404.
6.2.3.3.4.3	Operation: release	Supported
6.2.3.3.4.3.1	Description	Supported
6.2.3.3.4.3.2	Operation Definition	Supported	ChargingDataRequest and ChargingDataResponse. For success the response will be 204 (No content). For failure ProblemDetails include - 404.
6.2.4	Custom Operations without associated resources	Not Applicable
6.2.5	Data Model	Supported
6.2.5.1	General	Supported
6.2.5.2	Structured data types	Supported
6.2.5.2.1	Common Data Type	Supported
6.2.5.2.1.1	Type ChargingDataRequest	Supported
	subscriberIdentifier	Supported
	nfConsumerIdentification	Supported
	invocationTimeStamp	Supported with Extensions
	invocationSequenceNumber	Supported
	serviceSpecificationInformation	Supported
	multipleUnitUsage	Supported with Extensions
	triggers	Supported with Extensions	See 6.2.5.3.5 for supported Trigger types.
6.2.5.2.1.2	Type ChargingDataResponse	Supported
	invocationTimeStamp	Supported
	invocationResult	Supported
	invocationSequenceNumber	Supported
	sessionFailover	Supported
	triggers	Supported with Extensions
6.2.5.2.1.3	Type MultipleUnitUsage	Supported
	ratingGroup	Supported
	usedUnitContainer	Supported
6.2.5.2.1.4	Type UsedUnitContainer	Supported
	serviceId	Supported
	triggers	Supported
	triggerTimeStamp	Supported
	time	Supported
	totalVolume	Supported with Extensions
	uplinkVolume	Supported
	downlinkVolume	Supported
	serviceSpecificUnits	Supported
	eventTimeStamps	Supported with Extensions
	localSequenceNumber	Supported with Extensions
6.2.5.2.1.5	Type Trigger	Supported with Extensions
	triggerType	Supported with Extensions
	triggerCategory	Supported with Extensions
	timeLimit (DurationSec)	Supported with Extensions
	volumeLimit64	Supported with Extensions
	eventLimit	Supported with Extensions
	maxNumberOfccc	Supported with Extensions
6.2.5.2.2	5G Data Connectivity Specified Data Type	Supported
6.2.5.2.2.1	Type ChargingDataRequest	-	Same as 6.1.6.2.2.1
6.2.5.2.2.2	Type ChargingDataResponse	-	Same as 6.2.5.2.1.2
6.2.5.2.2.3	Type MultipleUnitUsage	-	Same as 6.2.5.2.1.3
6.2.5.2.2.4	Type UsedUnitContainer	-	Same as 6.2.5.2.1.4
6.2.5.2.2.5	Type PDUSessionChargingInformation	-	Same as 6.1.6.2.2.6
6.2.5.2.2.6	Type UserInformation	-	Same as 6.1.6.2.2.7
6.2.5.2.2.7	Type PDUSessionInformation	-	Same as 6.1.6.2.2.8
6.2.5.2.2.8	Type PDUContainerInformation	-	Same as 6.1.6.2.2.9
6.2.5.2.2.9	Type NetworkSlicingInfo	-	Same as 6.1.6.2.2.10
6.2.5.2.2.10	Type PDUAddress	-	Same as 6.1.6.2.2.11
6.2.5.2.2.11	Type ServingNetworkFunctionID	-	Same as 6.1.6.2.2.12
6.2.5.2.2.12	Type RoamingQBCInformation	-	Same as 6.1.6.2.2.13
6.2.5.2.2.13	Type MultipleQFIcontainer	-	Same as 6.1.6.2.2.14
6.2.5.2.2.14	Type RoamingChargingProfile	-	Same as 6.1.6.2.2.15
6.2.5.2.2.15	Type QFIContainerInformation	-	Same as 6.1.6.2.2.16
6.2.5.2.2.16	Type RANSecondaryRATUsageReport	-	Same as 6.1.6.2.2.17
6.2.5.2.2.17	Type QosFlowsUsageReport	-	Same as 6.1.6.2.2.18
6.2.5.3	Simple data types and enumerations	Supported
6.2.5.3.1	Introduction	Supported
6.2.5.3.2	Simple data types	-	Same as 6.1.6.3.2
6.2.5.3.3	Enumeration: ChargingCharacteristicsSelectionMode	-	Same as 6.1.6.3.5
6.2.5.3.4	Enumeration: NodeFunctionality	Supported
6.2.5.3.5	Enumeration: TriggerType	Supported	FINAL, RAT_CHANGE and TARIFF_TIME_CHANGE are supported. Other trigger types are supported with extensions.
6.2.5.3.6	Enumeration: ResultCode	Supported
6.2.5.3.7	Enumeration: 3GPPPSDataOffStatus	-	Same as 6.1.6.3.13
6.2.5.3.8	Enumeration: PartialRecordMethod	-	Same as 6.1.6.3.15
6.2.5.3.9	Enumeration: RoamerInOut	-	Same as 6.1.6.3.16
6.2.5.3.10	Enumeration: SubscriberIdentityType	-	Same as 6.1.6.3.17
6.2.6	Error handling	Supported
6.2.6.1	General	Supported
6.2.6.2	Protocol Errors	Not Applicable
6.2.6.3	Application errors	Supported
6.2.7	Feature negotiation	Not Supported
7	Bindings of CDR field, Information Element and Resource Attribute	Supported
7.0	General	Supported
7.1	Bindings of common CDR field, Information Element and Resource Attribute	Supported
7.2	Bindings for 5G data connectivity	Supported
7.3	Bindings for SMS charging	Not Supported
7.4	Bindings for 5G connection and mobility	Not Supported
7.5	Bindings for Exposure Function Northbound API charging	Not Supported
7.6	Bindings for NS performance and Analytics charging	Not Supported
8.0	Security	Not Supported	OAuth2 is not supported.

Response Codes

Table 1-2: Response Codes

Response codes	Description
201 Created (Create)	The creation of a Charging Data resource is confirmed, and a representation of that resource is returned. The Charging Data resource is created and returned successfully. The representation of created resource is identified via Location header field in the 201 response.
200 OK (Updates)	The modification of a Charging Data resource is confirmed, and a representation of that resource is returned. The Charging Data resource which is modified and returned successfully.
204 No Content (Release)	The Charging Data resource matching the ChargingDataRef is modified and then released.
400 Bad Request	CHARGING_FAILED: The HTTP request is rejected because the set of session or subscriber information needed by the CHF for charging or CDR creation is incomplete or erroneous or not available (for example, Rating Group, subscriber information). RE_AUTHORIZATION_FAILED: The HTTP request is rejected because the set of information needed by the NF Consumer (CTF) to report the usage is incomplete or erroneous or not available.
403 Forbidden	CHARGING_NOT_APPLICABLE: The HTTP request is rejected by the CHF since it has been determined that the service can be granted to the end user without any charging or CDR creation. END_USER REQUEST_DENIED: The HTTP request is denied by the CHF due to restrictions or limitations related to the end-user. QUOTA_LIMIT_REACHED: The HTTP request denied by the CHF because the end user’s account could not cover the requested service. If the request contained used units they are deducted, if applicable. END_USER_REQUEST_REJECTED: The HTTP request rejected by the CHF due to end-user restrictions or limitations.
404 Not Found	USER_UNKNOWN: The HTTP request is rejected because the end user specified in the request cannot be served by the CHF.
500 Internal Server Error	Common Application Error

Charging Function – Spending Limit Control Service

Section Compliance

The table provided below outlines the compliance of sections within the 5G System Charging Service as per 3GPP TS 29.594 v16.3.0 (2020-09).

Table 2-1: 5G System Charging Service 3GPP TS 29.594 v16.3.0 (2020-09) Section Compliance

Section Number	Section	Status	Notes
1	Scope	Informational	-
2	References	Informational	-
3	Definitions and abbreviations	Informational	-
4	Nchf_SpendingLimitControl Service	Supported	-
4.1	Service Description	Supported	-
4.1.1	Overview	Supported	-
4.1.2	Service Architecture	Supported	-
4.1.3	Network Functions	Supported	-
4.1.3.1	Charging Function (CHF)	Supported	-
4.1.3.2	NF Service Consumers	Supported	-
4.2	Service Operations	Supported	-
4.2.1	Introduction	Supported	-
4.2.2	Nchf_SpendingLimitControl_Subscribe service operation	Supported	-
4.2.2.1	General	Supported	-
4.2.2.2	Initial spending limit retrieval	Supported	-
4.2.2.3	Intermediate spending limit report retrieval	Supported	-
4.2.3	Nchf_SpendingLimitControl_Unsubscribe service operation	Supported	-
4.2.3.1	General	Supported	-
4.2.3.2	Unsubscribe from spending limit reporting	Supported	-
4.2.4	Nchf_SpendingLimitControl_Notify service operation	Supported	-
4.2.4.1	General	Supported	-
4.2.4.2	Spending limit report	Supported	-
4.2.4.3	Subscription termination request by CHF	Not Supported	-
5	Nchf_SpendingLimitControl Service API	Supported	-
5.1	Introduction	Supported	-
5.2	Usage of HTTP	Supported	-
5.2.1	General	Supported	-
5.2.2	HTTP standard headers	Supported	-
5.2.2.1	General	Supported	-
5.2.2.2	Content type	Supported	-
5.2.3	HTTP custom headers	Supported	Only 3gpp-Sbi-Target-apiRoot header is supported among custom headers.
5.3	Resources	Supported	-
5.3.1	Resource Structure	Supported	-
5.3.2	Resource: Spending Limit Retrieval Subscriptions (Collection)	Supported	-
5.3.2.1	Description	Supported	-
5.3.2.2	Resource Definition	Supported	-
5.3.2.3	Resource Standard Methods	Supported	-
5.3.2.3.1	POST	Supported	POST request with SpendingLimitContext to create a new individual spending limit retrieval subscription. POST Response to contain SpendingLimitStatus as 201 (Created), ProblemDetails with 400 (Bad Request).
5.3.2.4	Resource Custom Operations	Not Applicable	-
5.3.3	Resource: Individual Spending Limit Retrieval Subscription (Document)	Supported	-
5.3.3.1	Description	Supported	-
5.3.3.2	Resource definition	Supported	-
5.3.3.3	Resource Standard Methods	Supported	-
5.3.3.3.1	PUT	Supported	PUT request with SpendingLimitContext to modify the existing individual spending limit retrieval subscription. POST Response to contain SpendingLimitStatus as 200 (OK), ProblemDetails with 400 (Bad Request).
5.3.3.3.2	DELETE	Supported	DELETE request. DELETE Response to contain 204 (No Content). Successful case: The individual spending limit subscription matching the subscriptionId was deleted.
5.4	Customer Operations without associated resources	Not Applicable	-
5.5	Notifications	Supported	-
5.5.1	General	Supported	Terminate is not supported
5.5.2	Spending limit notification	Supported	-
5.5.2.1	Description	Supported	-
5.5.2.2	Target URI	Supported	-
5.5.2.3	Standard Methods	Supported	-
5.5.2.3.1	POST	Supported	POST request with SpendingLimitStatus for the policy counters. POST Response to contain 204 (no Content) and the receipt of the notification is acknowledged.
5.5.3	Subscription Termination	Not Supported	-
5.5.3.1	Description	Supported	-
5.5.3.2	Target URI	Supported	-
5.5.3.3	Standard Methods	Supported	-
5.5.3.3.1	POST	Supported	POST request with SubscriptionTerminationInfo for deletion of a resource. POST Response to contain 204 (no Content) and the receipt of the notification is acknowledged.
5.6	Data Model	Supported	-
5.6.1	General	Supported	-
5.6.2	Structured data types	Supported	-
5.6.2.1	Introduction	Supported	-
5.6.2.2	Type SpendingLimitContext	Supported	-
5.6.2.3	Type SpendingLimitStatus	Supported	-
5.6.2.4	Type PolicyCounterInfo	Supported	-
5.6.2.5	Type PendingPolicyCounterStatus	Supported	-
5.6.2.6	Type SubscriptionTerminationInfo	Not Supported	-
5.6.3	Simple data types and enumerations	Supported	-
5.6.3.1	Introduction	Supported	-
5.6.3.2	Simple data types	Supported	-
5.6.3.3	Enumeration: TerminationCause	Not Supported	-
5.7	Error handling	Supported	-
5.7.1	General	Supported	-
5.7.2	Protocol Errors	Not Applicable	-
5.7.3	Application Errors	Supported	-
5.8	Feature negotiation	Not Supported	-
5.9	Security	Not Supported	OAuth2 is not supported.

Response Codes

Table 2-2 Response Codes

Response codes	Description
201 Created	SUCCESS: The spending limit subscription was created, and spending limit reports are provided.
200 OK	The individual spending limit subscription was modified, and spending limit reports are provided.
204 No Content	Please see individual operations
400 Bad Request	USER_UNKNOWN: The subscriber specified in the request is not known at the CHF and the subscription cannot be created. NO_AVAILABLE_POLICY_COUNTERS: There are no policy counters available for the subscriber at the CHF
500 Internal Server Error	Common Application Error

Charging Function – Interactions with Network Repository Function (NRF)

Section Compliance

The table below provides a description of the services supported by CHF as a consumer Network Function for its interaction with NRF, in accordance with the 5G System Network Function Repository Services in 3GPP TS 29.510 v16.5.0 (2020-09).

Table 3-1: Services Supported by CHF as a Consumer Network Function

Section Number	Section	Status	Notes
5	Services Offered by the NRF	Supported
5.1	Introduction	Supported	Only NFManagement Service with operations NFRegister, NFUpdate, NFDeregister, and NFListRetrieval are supported.
5.2	Nnrf_NFManagement Service	Supported
5.2.1	Service Description	Supported
5.2.2	Service Operations	Supported
5.2.2.1	Introduction	Supported
5.2.2.2	NFRegister	Supported
5.2.2.2.1	General	Supported
5.2.2.2.2	NF (other than NRF) registration to NRF	Supported
5.2.2.3	NFUpdate	Supported
5.2.2.3.1	General	Supported
5.2.2.3.2	NF Heart-Beat	Supported
5.2.2.4	NFDeregister	Supported
5.2.2.4.1	General	Supported
5.2.2.5	NFStatusSubscribe	Not Supported
5.2.2.6	NFStatusNotify	Not Supported
5.2.2.7	NFStatusUnsubscribe	Not Supported
5.2.2.8	NFListRetrieval	Supported
5.2.2.8.1	General	Supported
5.2.2.9	NFProfileRetrieval	Not Supported
5.2.2.9.1	General	Not Supported

CHF-CDR Format

The table below outlines the compliance status of the fields within the 3GPP Charging Function Call Detail Record (CHF-CDR) from the 3GPP TS 32.298 version 16.5.0 specification.

Table 4-1: CHF-CDR Format

Field	Status
Record Type	Supported
Recording Network Function ID	Not supported
Charging Session Identifier	Supported
Subscriber Identifier	Supported
NF Consumer Information	Supported
NF Functionality	Supported
NF Name	Supported
NF Address	Supported
NF PLMN ID	Supported
Triggers	Supported
SMF Triggers	Supported
List of Multiple Unit Usage	Supported
Rating Group	Supported
Used Unit Container	Supported
Service Identifier	Supported
Quota management Indicator	Supported
Local Sequence Number	Supported
Time	Supported
Uplink Volume	Supported
Downlink Volume	Supported
Total Volume	Supported
Service Specific Units	Supported
Event Time Stamp	Supported
Rating Indicator	Supported
Triggers	Supported
SMF Triggers	Supported
Trigger Time Stamp	Supported
PDU Container Information	Supported
UPF ID	Supported
Record Opening Time	Supported
Duration	Supported
Record Sequence Number	Supported
Cause for Record Closing	Supported
Local Record Sequence Number	Supported
Record Extensions	Not supported
Service Specification Information	Supported
PDU Session Charging Information	Supported
Roaming QBC Information	Supported
SMS Charging Information	Supported
Registration Charging Information	Not supported
N2 connection charging Information	Not supported
Location reporting charging Information	Not supported

Docs: Charging

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Tags
Resources
Thresholds
Notifications
Credit limits
Credit profiles
Event types
Rounding modes

To access this section in Monetization, from the Menu, select Business configuration, and click Charging.

Resources

To access this section, click Resources. A paginated list of all resources is shown in a tabular format.

Information:

This section shows how to create resources in Monetization, for example, monetary resources (e.g., Euro, US Dollar, etc.), free resources (e.g., free SMS, free data, etc.), etc.

A resource represents an object in Monetization that can hold a value—for example, a monetary resource with a value of 10.

In addition, a resource can exist as a balance for a customer. A balance is one unique resource value inside a specific balance group.

Balances of a resource are created automatically in Monetization whenever a customer purchases a product or triggers a usage event. For instance, if a plan has a product that grants 100 free minutes. Upon the customer purchasing the plan, a balance of 100 free minutes will be created in the related balance group.

Information:

A balance can also be manually created via the API, which is used more for management than automation.

Resources are essential when creating a product catalog because the products a customer can purchase will result in a resource balance impact—for example, charging a customer 100 euros or granting them 100 free credits.

Examples of a resource

Below are five examples of a resource, including their industry.

Euro — Any industry — It represents the current monetary balance of a customer within the current cycle.
Free minutes — Telecommunications
Total consumption kWh — Utility
Minimum fare fee — Car sharing/Taxis — An helper resource holding the minimum fee that the customer has to pay for every ride
API calls total — Cloud services — To keep track of how many generated API call events

Note:

A resource balance can increase or decrease due to a customer purchasing a product or generating a usage event. A customer’s balance will be affected whenever they buy a product or use a service that triggers a usage event.

Four actions/subpages can be performed/viewed under this section, namely:

Create resource
Details resource page
Update resource
Delete resource

Create resource

Under resources, to create a resource, click Create new. It includes mandatory and optional input fields.

The mandatory input fields include the following:

Name
Code
Balance consumption order
Default value
Validity period

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

The optional input fields include the following:

Description
Temporary
Currency
Included on invoice

Note:

The most important resource in Monetization is the monetary resource because it represents a currency that the customer is paying in.

Monetary resource

Monetary resource means actual money in Monetization; it represents monetary currency (e.g., euros, dollars, etc.). To create a monetary resource, under create resource, provide a name (e.g., euro), a code (e.g., euro), a description (e.g., euro monetary resource), and a balance consumption order.

For a monetary resource, the earliest start time and earliest expiration time (ESTEET) is configured for the balance consumption order because the oldest balance should be consumed first.

Typically, the default value is set to 0. However, it can be modified to either a positive or negative value, for example, 100. Whenever Monetization creates a balance for the resource initially, it starts with the default value.

Tip:

It is a good practice not to change the default value of a free resource from zero because the default value will be applied globally to all customers for all the created resource balances. Instead, create a product that will grant some amount of free resources to the customer.

Typically, Monetization basis free resources on the customer plan. One customer can have 1GB of free data, while another has 2GB. Hence, create a product for that plan, which will grant the correct amount depending on the plan.

Information:

A resource can be created whose balance represents a counter that will count downward toward zero. In that case, the default value can be set to any positive number.

Instead of initially setting the resource balance with the purchase of a product, the resource balance will be set to the default value of the resource upon the creation of the resource balance. For more information about the usefulness, see helper resources.

To make the resource a temporary resource, use the Temporary toggle switch to enable/disable. Enabling this feature means that the resource will return to the default value immediately after Monetization completes rating. It is used mainly for helper resources.

By default, a resource is always valid from the day it is created to an infinite period. However, it can be configured to expire sometime in the future. Typically, a monetary resource should have infinite validity.

Note:

A resource becomes a monetary resource when a currency is assigned to the resource. In contrast, for a non-monetary resource, see non-monetary resource.

To include the resource on the invoice, use the Included on invoice toggle switch to enable/disable. Enabling this feature means that Monetization will pull this data on the JSON object generated for one invoice.

Note:

Only include the information needed on the invoice for performance optimization.

Balance consumption order

The balance consumption order specifies the order to which the resource balance should be impacted when multiple balances of the same resource exist in a balance group.

For instance, a customer balance group has the following:

100 free minutes valid from the 1st of January to the 15th of February
50 free minutes valid from the 1st of February to the 1st of March

Assume today is the 10th of February; both balances are valid. Therefore, the customer currently has 150 free minutes in total. The customer then generates an event for 120 free minutes; the balance consumption order configuration decides which balance should be consumed first based on the validity period.

If the balance consumption order is set to ESTEET, the customer will end up with 30 free minutes, valid from the 1st of February to the 1st of March. However, suppose the balance consumption order is set to consume the latest resource first. In that case, the customer will end up with 30 free minutes valid from the 1st of January to the 15th of February.

Explanation of some terms

EST: Configuring the balance consumption order to earliest start time (EST) means that the balance with the earliest validity start time is used first.
LST: Configuring the balance consumption order to latest start time (LST) means that the balance with the latest validity start time is used first.
EET: Configuring the balance consumption order to earliest expiration time (EET) means that the balance with the earliest validity end time is used first.
LET: Configuring the balance consumption order to latest expiration time (LET) means that the balance with the latest validity end time is used first.
ESTLET: Configuring the balance consumption order to earliest start time and latest expiration time (ESTLET) means that the balance with the earliest validity start time is used first. If multiple balances have the same validity start time, the one with the latest end time is used first.
ESTEET: Configuring the balance consumption order to earliest start time and earliest expiration time (ESTEET) means that the balance with the earliest validity start time is used first. If multiple balances have the same validity start time, the one with the earliest end time is used first.

Tip:

The ESTEET should be used as the default balance consumption order.

LSTEET: Configuring the balance consumption order to latest start time and earliest expiration time (LSTEET) means that the balance with the latest validity start time is used first. If multiple balances have the same validity start time, the one with the earliest end time is used first.
LSTLET: Configuring the balance consumption order to latest start time and latest expiration time (LSTLET) means that the balance with the latest validity start time is used first. If multiple balances have the same validity start time, the one with the latest end time is used first.
EETEST: Configuring the balance consumption order to earliest expiration time and earliest start time (EETEST) means that the balance with the earliest validity end time is used first. If multiple balances have the same validity end time, the one with the earliest start time is used first.
EETLST: Configuring the balance consumption order to earliest expiration time and latest start time (EETLST) means that the balance with the earliest validity end time is used first. If multiple balances have the same validity end time, the one with the latest start time is used first.
LETEST: Configuring the balance consumption order to latest expiration time and earliest start time (LETEST) means that the balance with the latest validity end time is used first. If multiple balances have the same validity end time, the one with the earliest start time is used first.
LETLST: Configuring the balance consumption order to latest expiration time and latest start time (LETLST) means that the balance with the latest validity end time is used first. If multiple balances have the same validity end time, the one with the latest start time is used first.

Helper resources

A helper resource is not directly relevant to the customer; however, Monetization uses it for rating. For example, a counter resource, which Monetization uses to keep track of something.

Example of a helper resource

Assume a resource MBs used in a session to track how many MBs the customer has used in one data session/event. A helper resource in the form of a counter resource can be used.

If the pricing is expected to change after the customer has consumed 10MBs within one session, that is, there is multi-tier pricing, immediately Monetization receives a data event, it will be rated according to the rate plan. The counter resource can track how many quantities the customer has used to know when to start rating with a different price.

After the single event has been rated, the helper resource MBs used in a session in the form of a counter resource will be reset to zero for it to be ready for the next event.

Note:

For a resource to reset to its default value after each rating, the Temporary toggle switch should be enabled.

Non-monetary resource

A non-monetary resource does not have a monetary value; hence, it is not treated as money. Examples of non-monetary resources can include free data, free SMS, etc.

Information:

To learn how to generally create a resource, see monetary resource.

Note:

A non-monetary resource should not be given a currency. Assigning a currency to the resource turns it into a monetary resource.

Details resource page

Under resources, to see the full details of a resource, click Details. It contains the following:

Status — a resource with an active status means the resource is still valid.
Name
Code
Description
Balance consumption order
Default value
Type (Standard or Temporary)
Valid from
Valid to
Currency (if any)
Included on invoice

Update resource

Under resources, to update a resource, first, click Details; it shows the details of the resource. Then to update, click Update.

Information:

All information filled out under the create resource section can be updated except for the Code.

Delete resource

Under resources, to delete a resource, click Delete.

Note:

Deleting a resource already used in other parts of Monetization cannot be done. Every particular reference to the resource first has to be deleted.

Thresholds

To access this section, click Thresholds. A paginated list of all thresholds is shown in a tabular format.

A threshold is a configured value that can trigger a notification whenever a resource balance exceeds a threshold defined on the credit limit and linked to the resource by a credit profile.

Four actions/subpages can be performed/viewed under this section, namely:

Create threshold
Details threshold page
Update threshold
Delete threshold

Create threshold

Under thresholds, to create a threshold, click Create new. It includes mandatory and optional input fields.

The mandatory fields include the following:

Name (e.g., T_200)
Code (e.g., T_200)
Type (amount or percentage)
Value (e.g., 200)

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

The optional field includes:

Description (e.g., threshold for 200)

A threshold configured as an amount means the value is fixed—for example, 200. Therefore, when the balance exceeds 200, it will trigger a notification.

Note:

A threshold value configured as an amount can also be negative.

A threshold configured as a percentage means the value is relative to another resource balance. For instance, assume two balances:

Resource name	Balance
Granted free MBs	1000
Free MBs	900

If a percentage threshold for Free MBs is configured to be 80% of the Granted free MBs balance, then the threshold will trigger at 800.

Tip:

The percentage threshold is useful because it can change the value based on a different resource balance—allowing for more flexibility on the customer level. While the amount threshold is always constant based on the configured value.

Information:

Once a threshold is created, it will not be connected to anything, but rather it is an object that exists in Monetization that can be used when creating a credit limit.

Details threshold page

Under thresholds, to see the full details of a threshold, click Details. It contains the following:

Name
Code
Description
Type
Value

Update threshold

Under thresholds, to update a threshold, first, click Details; it shows the details of the threshold. Then to update, click Update.

Information:

All information filled out under the create threshold section can be updated except for the Code.

Delete threshold

Under thresholds, to delete a threshold, click Delete.

Note:

Deleting a threshold already linked to a credit limit cannot be done. Every particular reference to the threshold first has to be deleted.

Notifications

Monetization triggers a notification whenever a balance of a specific resource exceeds or falls below a threshold. The threshold is linked to a credit limit and configured for a particular resource by a credit profile.

The notifications can be seen in Monetization under the customer account page. For more information, see Notifications.

Credit limits

To access this section, click Credit limits. A paginated list of all credit limits is shown in a tabular format.

A credit limit can be used to restrict how far a customer can use a resource in terms of positive or negative value. You can also add multiple thresholds, which a customer can breach as they go over the configured value.

It describes a resource balance’s minimum and maximum limits and which thresholds can be triggered when breached.

Four actions/subpages can be performed/viewed under this section, namely:

Create a credit limit
Details credit limit page
Update credit limit
Delete credit limit

Create a credit limit

Under credit limits, to create a credit limit, click Create new. It includes mandatory and optional input fields.

The mandatory fields include the following:

Name
Code
Start
Stop

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

The optional fields include the following:

Description
Thresholds

Multiple thresholds can be added. For example, assume a credit limit with a threshold value of 200; therefore, whenever the resource balance exceeds 200, it will trigger a notification.

Note:

The Start and Stop fields represent the minimum and maximum values, respectively, one resource balance can have.

The Start and Stop fields can be configured as either positive or negative numbers. In addition, the Start and Stop fields can also be configured to No minimum or No maximum, which is more user-friendly, by clicking Pick value.

The No minimum and No maximum value means that the value can be unlimited, as it goes from minus infinite to plus infinite.

Tip:

A prepaid monetary resource should have its Stop value configured to zero. This would enable the resource balance not to exceed zero.

This is typical because prepaid customers can only use the service(s) while they have money available. Therefore, it does not make sense to let their monetary balance fall below zero.

In addition, if the limit is set to zero, then Monetization can tell when the money ran out and will no longer rate events.

Note:

It is impossible to bring a resource balance outside of the credit limit Start and Stop values. In addition, the service the customer consumes can be disabled as soon as the resource limit is reached—for example, a prepaid customer who runs out of money.

Details credit limit page

Under credit limits, to see the full details of a credit limit, click Details. It contains the following:

Name
Code
Description
Thresholds
Start
Stop

Update credit limit

Under credit limits, to update a credit limit, first, click Details; it shows the details of the credit limit. Then to update, click Update.

Information:

All information filled out under the create a credit limit section can be updated except for the Code.

Delete credit limit

To delete a credit limit, click Delete.

Note:

Deleting a credit limit already linked to a credit profile cannot be done. Every particular reference to the credit limit first has to be deleted.

Credit profiles

To access this section, click Credit profiles. A paginated list of all credit profiles is shown in a tabular format.

A credit profile links a credit limit to a particular resource for a specific payment type. For example, how the euro (monetary) resource has to behave, which credit limit should it use when it is available as a balance on a customer’s account.

Four actions/subpages can be performed/viewed under this section, namely:

Create a credit profile
Details credit profile page
Update credit profile
Delete credit profile

Create a credit profile

Under credit profiles, to create a credit profile, click Create new. It includes mandatory and optional input fields.

The mandatory fields include the following:

Name
Code
Payment type
Resource
Credit limit

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

The optional field includes:

Description

Note:

A credit profile must be created for each payment type because it describes balance behaviours in relation to a payment type. If non-existent, then the balance can not be created.

Information:

Configuring a credit profile will enable each resource to be given a description that depicts how it will be limited based on the payment type of the customer.

For a postpaid payment type

For a postpaid payment type, the credit limit with a Start value of No minimum and a Stop value of No maximum is recommended.

This means the resource that belongs to the customer can either be a negative value (because the customer was given some credit) or a positive value (because the customer will owe something).

For a pay-now payment type

The credit limit with a Start value of No minimum and a Stop value of No maximum is recommended for a pay-now payment type.

This means the resource that belongs to the customer can either be a negative value (because the customer was given some credit) or a positive value (because the customer will owe something).

For a prepaid payment type

For prepaid payment type, it is recommended that the credit limit with a Start value of No minimum and a Stop value of 0 should be chosen because the customer balance should not exceed zero.

For instance, assume a prepaid customer purchases a product that offers 100 euros, which is a monetary resource. It will be shown in the customer’s balance as -100 euros of credit. The customer can consume the resource and would not owe anything.

However, as they continue consuming the resource, the balance will reduce until it reaches zero, which indicates that the customer has exhausted the resource.

Details credit profile page

Under credit profiles, to see the full details of a credit profile, click Details. It contains the following:

Name
Code
Description
Payment type
Credit limit
Resource

Update credit profile

Under credit profiles, to update a credit profile, first, click Details; it shows the details of the credit profile. Then to update, click Update.

Information:

All information filled out under the create a credit profile section can be updated except for the Code.

Delete credit profile

Under credit profiles, to delete a credit profile, click Delete.

Event types

To access this section, click Event types. A paginated list of all event types is shown in a tabular format.

An event type represents a time interval in Monetization. It is created to be configured for a recurring product to determine how the product will renew. It is also configured for a customer to determine how frequently the customer will be charged.

Different cycles can be configured for an event type. For instance, monthly cycle, three months cycle, semi-annual cycle, annual cycle, etc.

Four actions/subpages can be performed/viewed under this section, namely:

Create event type
Details event type page
Update event type
Delete event type

Create event type

Under event types, to create an event type, click Create new. The name, code, interval unit, interval duration, and interval time are required, while the description is optional.

The interval unit constitutes three values:

Days
Weeks
Months

The interval duration specifies the length of time given to the interval unit—for example, six months; the interval time, which default value is 12:00 AM.

For instance, given the below table:

Interval unit	Interval duration	Interval time
Months	6	12:00 AM

If a recurring product is given the above event type, it means that the product will renew every six months at 12:00 AM. Similarly, configuring the event type for a customer under the billing profile means that the customer will be charged every six months at 12:00 AM.

Details event type page

Under event types, to see the full details of an event type, click Details. It contains the following:

Name
Code
Description
Interval unit
Interval duration
Interval time

Update event type

Under event types, to update an event type, first, click Details; it shows the details of the event type. Then to update, click Update.

Information:

All information filled out under the create event type section can be updated except for the Code.

Delete event type

Under event types, to delete an event type, click Delete.

Note:

Deleting an event type already used in other parts of Monetization cannot be done. Every particular reference to the event type first has to be deleted.

Rounding modes

To access this section, click Rounding modes.

Rounding modes are configured for each site to determine how many decimal places to round the calculations made during different stages of rating.

There are four distinct components to applying a scale for, which are:

Rating
Discounting
Taxation
Billing

Whenever one of these four components gets triggered in Monetization, the rounding mode is applied to round the values to the configured decimal places.

The Scale refers to a number that denotes the number of decimal places. The Mode can be configured to Half Up or Half Down. For example, if configured to be Half Up, a value of 7.5 will be rounded to 8, while if configured to be Half Down, a value of 7.5 will be rounded to 7.

Tip:

The Scale value should be adjusted to the point that will enable bills to be generated, especially when dealing with very low values.

Docs: Payment Gateways

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select System configuration, and click Payment gateways.

Monetization supports eight payment gateways out-of-the-box, which are:

Braintree
Authorize.Net
Paypal
Stripe
CyberSource
Bankart
Tranzila
Adyen

Note:

A customer can only use one payment gateway provider at a time in Monetization. Using multiple payment gateways simultaneously is not supported.

Information:

You can integrate with a custom third-party payment gateway provider in Monetization. For more information, see Custom payment gateway.

Braintree

Braintree provides businesses with an online merchant account and payment gateway to accept credit card payments, including Visa, MasterCard, Discover, American Express, JCB, and Diners.

To configure, click Braintree; insert your merchant ID, public key, and private key. In addition, choose the appropriate environment, whether sandbox (test) or production.

Use the Active toggle switch to activate/deactivate the configuration. Once activated and configured, Monetization can communicate with Braintree.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

Authorize.Net

The Authorize.Net Payment Gateway can help you accept credit card payments quickly and affordably.

To configure, click Authorize.Net; insert your login ID and transaction key. Use the Active toggle switch to activate/deactivate the configuration. Once activated and configured, Monetization can communicate with Braintree.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

Paypal

PayPal is a technology company that offers online payment solutions to individuals and businesses worldwide. It provides a platform for sending and receiving payments securely, with support for various payment methods.

To configure, click Paypal; insert your client ID and client secret. Use the Active toggle switch to activate/deactivate the configuration. Once activated and configured, Monetization can communicate with Paypal.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

Stripe

Stripe is a technology company that provides a suite of payment APIs for businesses of all sizes. It enables businesses to accept and manage payments online, including credit card, Apple Pay, and Google Pay, among others.

To configure, click Stripe; insert your stripe API key. Use the Active toggle switch to activate/deactivate the configuration. Once activated and configured, Monetization can communicate with Stripe.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

CyberSource

CyberSource is a payment management company that provides a range of services to help businesses process online payments securely and efficiently. It offers a suite of payment APIs that enable businesses to accept payments from multiple channels, including mobile, web, and point-of-sale systems.

To configure, click CyberSource; insert your merchant ID and key. Use the Active toggle switch to activate/deactivate the configuration. Once activated and configured, Monetization can communicate with CyberSource.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

Bankart

Bankart is a Slovenian payment processor that provides a range of services to banks and merchants in the European market. Their platform enables businesses to accept various payment methods, including debit and credit cards, contactless payments, and mobile payments, making it a comprehensive payment processing solution.

To configure, click Bankart; insert your API username and password, shared secret, and API key. In addition, choose the appropriate environment, whether sandbox (test) or production.

Use the Active toggle switch to activate/deactivate the configuration. Once activated and configured, Monetization can communicate with Bankart.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

Tranzila

Tranzila is an Israeli payment gateway that provides businesses with an easy-to-use platform to process online payments. Their platform supports various payment methods, such as credit cards, PayPal, and Google Pay, making it a versatile solution for businesses of all sizes.

To configure, click Tranzila; insert your terminal, credit password, and API password. In addition, choose the appropriate environment, whether sandbox (test) or production.

Use the Active toggle switch to activate/deactivate the configuration. Once activated and configured, Monetization can communicate with Tranzila.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

Adyen

Adyen is a financial technology platform that provides end-to-end payments, data, and financial management in a single platform. It can offer a wide range of payment options for your business.

Custom payment gateway

The custom payment gateway allows you to integrate with a payment gateway that Monetization does not support out-of-the-box.

To configure, click Third Party; insert your URL and API key. To include some additional information that the third-party payment gateway needs, click Headers. The information should be in key-value pairs.

Note:

To learn how Monetization enables payment processing support for third-party payment providers not supported out-of-the-box or for cases where you decide to handle payment processing logic outside of Monetization via your integration processes, see Custom Payment Integration.

Use the Active toggle switch to activate/deactivate the configuration. Once activated and configured, Monetization can communicate with the payment gateway.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

Docs: Products

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Products
Rate plans
Rating
Rating sets
Rollovers
Tariffs

To access this section in Monetization, from the Menu, select Catalog, and click Products.

Products

To access this section, click Products. A paginated list of all products is shown in a tabular format.

A product can either be a regular or service product. A regular product can be a monthly or one-time fee paid by customers, while a service product enables a customer to use services, for example, data or voice service.

Information:

This section gives you the tools to create, update, and delete products from your offering catalog. Products are ultimately used while creating bundles. Each product can have its own: price, tax, charge tag, and rate plans.

Note: A product can have multiple versions.

Five actions/subpages can be performed/viewed under this section, namely:

Create product
Copy product
Details product page
Update product
Delete product

Create product

Under products, to create a product, click Create new. It involves four sections, namely:

Product info section
Configuration section
Proration section
Product summary

Product info section

Under the info section, the product’s name, code, and description are required.

To include the product on the invoice, use the Included on invoice toggle switch to enable/disable. Enabling this feature means that Monetization will pull this data on the JSON object generated for one invoice.

Note:

Only include the information needed on the invoice for performance optimization.

Information:

Enabling sensitive data on a product using the Sensitive data toggle switch means the product cannot be accessed during the onboarding process of a new customer in the self-care portal.

Configuration section

Under the configuration section, there are numerous input fields. However, only the product type, cycle, quantity, price type, bill item, resources, versions, and price are required, others are optional.

Tip:

Knowing the type of product to be created in advance will be helpful. For example, if the product will be a one-time product, a monthly subscription product, or if it will be a product that grants service to the customer.

Product type

Selecting the product type is mandatory, and two options are available:

Subscription
One-time

Subscription: The subscription product means that the product is recurring based on an interval. The interval is called event type and is configurable in Monetization. For more information on configuring event types, see Event types.
One-time: The one-time product means that the product is not recurring and is only purchased once with no renewals. Therefore, the event type may not be included for a one-time product.

Note:

The customer can pay for a one-time product type in advance or arrears. For an advanced payment, the monetary balance is immediately impacted on the purchase. In contrast, for an arrears payment, the monetary balance is added to the invoice at the end of the billing cycle.

Event type

An event type is a configured cycle in Monetization. For example, weekly, monthly, and yearly cycles. For more information, see Event types.

Note:

It is mandatory to choose an event type for a product that has a subscription product type.

In the case of a monthly subscription, each time the billing cycle of the customer shifts (that is, Monetization issues out billing), if the customer has a monthly interval (event type) as well, Monetization also checks on all its purchased products to know which ones it should renew.

In the case of a weekly subscription, if the customer happens to have a monthly interval (event type). Each time the billing cycle of the customer shifts (that is, Monetization issues out billing), Monetization will figure out to charge the product four times. Therefore, it renews the product over the customer cycle (monthly customer on a weekly product).

Note:

The customer cycle can be configured during the onboarding process under subscription. For more information, see Onboarding a customer.

It can also be configured when creating a billing profile for the customer. For more information, see Billing profiles.

Information:

When choosing an event type for a one-time product, the interval will describe how long the one-time product will be valid after purchase. If the event type is not configured, it will be valid infinitely.

Duration

The duration of the product, which is optional, is deprecated in favor of terms. Monetization used the duration field to specify how many cycles a subscription product should be active—for example, six months. However, Monetization now uses terms to know how long a product should be effective and when it should be terminated.

For more information, see Terms.

Cycle

The product cycle is mandatory and can be configured as Forward or Arrear. For a Forward cycle, the customer pays for the product in advance. This implies that on the customer’s first invoice, Monetization charges twice; the first for the just concluded usage of the product service and the second for the subsequent use.

Configuring the product to use an Arrear cycle implies that the customer doesn’t pay for the product in advance; instead, the product is rated, and customers are charged at the end of the billing cycle.

Note:

Forward or Arrear can apply to a one-time and subscription product type. If Forward is selected, the balances will immediately be impacted at product purchase. If Arrear is selected, the balances will be impacted at billing time.

Priority

The optional priority, if configured, can give more importance to one product over another in a bundle. This is more critical when dealing with a prepaid payment type with a limited account balance.

When a bundle is being purchased for a customer that contains several products, you can determine which product should be purchased first and which should be purchased at the end.

Note:

A bundle is a higher-level object for grouping, but product priorities apply regardless of the bundle.

In addition, configuring the priority is essential when dealing with multiple service products. For instance, assume two products that offer an SMS service. The first product is intended for regular messaging and has a rate plan for regular messages. The second product is purchased over the first for a specific customer at a special rate.

Suppose the second product is given a higher priority than the first. It implies that when Monetization receives a usage event for that customer, it will find two products that offer an SMS service. Monetization only needs the rate plan for the two products to figure out the price to apply. However, the product with the highest priority (the second product) will be used.

Hence, a product can be purchased over an existing product and override the price of the previous product.

Note:

A higher number indicates a higher priority.

Information:

If two products with the same service are given the same priority, with the same service identifier, Monetization will match the first one it finds.

Quantity

The quantity, which is required, depicts the number of times the customer initially purchases the product. It represents the default quantity offered during the product purchase, typically 1. However, during the actual purchase of the product, the quantity can be overridden.

Note:

The quantity value must be greater than or equal to one.

Price type

The mandatory price type can be Debit or Credit and implies how the resources will be impacted for the product. For a debit price type, it will positively impact the resource, while for a credit price type, it will negatively impact the resource.

Tip:

For a monetary charge, set the price type to Debit. This will move the monetary resource, for example, from 0 to 10, making the customer indebted for 10 euros. While if it is set to Credit, the customer is given some monetary resource.

Bill item

The mandatory bill item entails how the charge should be presented on the bill/invoice. Bill items are configurable in Monetization under Business configuration Finance Bill Items.

For more information, see Bill Items.

Quantity override resource

The quantity override resource is optional. However, if configured, it means when a product is being purchased or renewed during a new billing cycle, there will be an option to choose to override the quantity of that product with the current balance of the configured resource.

For example, suppose a product (typically with an Arrear cycle) has a quantity override resource configured. In that case, it means Monetization will use the balance from the customer’s configured resource to determine the product’s quantity.

This is particularly helpful in the utility industries when there are products related to total consumption—for example, the Network Access Tariff, which depends on the total kWh consumed in one cycle. The kWh counter resource (helper resources) can be used, which will be updated throughout the billing cycle. Then at the end of the cycle, the value of that counter resource will be the quantity of the Network Access Tariff.

Charge tag

The optional charge tag depicts how Monetization can target the product in discounting. Once the product is given a particular charge tag, it can be targeted by referring to its charge tag when creating discounts.

The charge tag is configurable in Monetization under Business configuration Charging Tags.

For more information, see Tags.

Charge interval

The optional charge interval should be added when creating a service product. It entails rounding the ratable quantity obtained from the usage events with the configurations stated in a specific charge interval.

Charge interval are configurable in Monetization under Business configuration Service design Charge Intervals.

For more information, see Charge intervals.

Tax supplier

The tax supplier, which is optional, is much more critical when integrating with a third-party taxation gateway that Monetization provides.

Information:

Monetization does not calculate the taxes. The configured taxation gateway does the calculation of the taxes.

Tax suppliers are configurable in Monetization under Business configuration Finance Tax suppliers.

General ledger

The general ledger is optional; however, if configured, it tells Monetization how the product should behave and act for financial purposes. Under the general ledger, accounts are mapped, specifying which account to credit and which account to debit whenever the product is purchased.

Information:

The general ledger helps to create financial reports in Monetization.

General ledgers are configurable in Monetization under Business configuration Finance General ledgers.

Rollover

Rollover is optional; however, if configured, it allows for transferring specific resources from the product between billing cycles.

For example, assume a product that, when purchased, offers 1GB of data to the customer. However, before the billing cycle ends, the customer still has 200MB of unused data. In that case, rollover allows for the transition of the unused resource to the next billing cycle; however, as stated in the Cycle rollover amount.

Rollovers are configurable in Monetization under Catalog Products Rollovers.

For more information, see Rollovers.

Service

The service is optional; however, it is mandatory for creating a service product.

Note:

Products with a service type are treated as a service product and, upon their purchase, must have a service identifier provided. Typically, these products have a rate plan configured, which Monetization uses for rating specific service events.

Services are configurable in Monetization under Business configuration Service design Service Types.

For more information, see Service types.

Provisioning tag

The provisioning tag is optional; however, it works hand-in-hand with a provisioning server if configured. When dealing with a networking solution integration, some service products (Data, Voice, SMS - related to a SIM card) must be provisioned in the network before they can be used in Monetization.

Note:

The product is activated and charged once the provisioning server replies to Monetization with a successful response.

For instance, after a customer purchases the product, Monetization will send out (if the web link is configured) a request to the provisioning server, telling the provisioning server that a particular SIM card with a specific number purchased a product. Once the server provisions that, Monetization expects a response confirming that everything is okay, and only then is the product activated for the customer.

Non-active rating

The non-active rating is optional but can be configured on products and discounts. It means whether Monetization should still apply impacts related to these products and discounts after they are inactive or closed.

It has three configurable options:

FORBIDDEN — means Monetization can only rate the product if it is active.
RATE_INACTIVE — means Monetization can only rate the product when active or inactive but not closed.
RATE_INACTIVE_AND_CLOSED — means Monetization will consistently rate the product, whether active, inactive, or closed.

For example, if an inactive service product has a non-active rating of RATE_INACTIVE, suppose Monetization receives a usage event for that service. In that case, Monetization will rate the product; however, if the non-active rating is set to FORBIDDEN, the usage event will not be rated for the product.

Resources

Resources are mandatory, and it depicts the resource(s) that would be attached to the product. That is, when a customer purchases the product, they get the resource(s) in return. The customer can then consume the resource(s).

Resources are configurable in Monetization under Business configuration Charging Resources.

For more information, see Resources.

To add a resource, click Add resource, and select the particular resource that will come with the product purchase.

Information:

Multiple resources can be added to a product, and the resource can be a monetary resource or a non-monetary resource.

Note:

Each resource must include a version.

To delete a resource, click Delete.

Versions

Versions go along with a resource and are valid based on the validity period configuration. By default, the product version is valid from the day the product was created to an infinite period. However, if another version of the product must be included, first, change the current version’s end date from an infinite period to a specific date.

Note:

The price, rate plans, and tax can be changed in a product version.

Information:

When configuring a service product, multiple rate plans can be included. For instance, one rate plan can be used to rate events for a particular region, while another can be used to rate events for a different region.

For every product change/update, a new product does not have to be created; you can update the product version instead. The history of the product versions is also kept in Monetization. Hence, what was configured on previous dates is still accessible.

Note:

The product’s basic configuration cannot be modified when configuring the version.

To add a product version, click Add version. The validity period and price are mandatory. In addition, rate plans and tax can be configured optionally.

To delete a version, click Delete.

Proration section

Prorated means to adjust for a specific period. Under this section, the Purchase action can be configured to either of three variables, namely:

Full amount
Prorated amount
None

Note:

The proration section only applies during the first purchase of the product.

If configured as Full amount, if the product costs 50 euros, for example, and the customer purchases it on the 16th of the month, Monetization will still charge the customer the same 50 euros.

If configured as Prorated amount, if the product costs 50 euros, for example, and the customer purchases it on the 16th of the month. Monetization will not charge the customer 50 euros; instead, it takes into account the customer’s and product’s cycle. Based on this, it calculates the exact price the customer will pay.

Note:

The Prorated amount is rounded to a daily basis. Therefore, the price remains the same if the product is purchased at 2 am or 2 pm.

Product summary

This section shows the summary of what was inputted in the previous three sections (Product info section, configuration, and proration). The product details can be reviewed before creating the product.

Copy product

Under products, copying an existing product equips you with the ability to create a new product quickly. Essentially, by clicking Copy, it redirects you to a product creation page, and it includes with it the data from the copied product.

For example, assume having a gold, diamond, and platinum product, where only the name and price change. Instead of creating each product from scratch, you can create one and copy the remaining two from the previous one while editing the name and price.

Details product page

Under products, to see the full details of a product, click Details. It contains the following section:

Info
Configuration
Proration

Information:

A product with the status Active means that the product is still valid.

Update product

Under products, to update a product, first, click Details; it shows the details of the product. Then to update, click Update.

Note:

All information filled out under the create product section can be updated except for the Code.

Delete product

Under products, to delete a product, click Delete.

Note:

Deleting a product that a customer has already purchased cannot be done. An object related to something else cannot be deleted in Monetization.

Rate plans

To access this section, click Rate plans. A paginated list of all rate plans is shown in a tabular format.

Overview: Rate plans are used for matching fields from a service type and then applying the specific impacts (prices) for one mapping. For instance, a data service originating from Slovenia has different impacts/prices than one originating from the United States.
Definition: Rate plans are mappings used to rate usage events. When a product is a service product (that is, has a service type configured), it typically also has a rate plan which tells Monetization how events from that service should be rated.

Note:

As soon as the rating metric determines the quantity-to-be-rated, the quantity is used as a base in the rate plan to apply impacts.

How does it work?: Whenever Monetization receives an event for a specific service, it tries to find a service product to which the service belongs and checks if that product has a rate plan tied to it for Monetization to figure out how the event should be rated.
Specification: Rate plans are given to products that offer a specific service for rating events. A product can have multiple rate plans. Furthermore, a customer can purchase a new product with a higher priority rate plan, which changes the pricing; this can be done for marketing strategy.

Five actions/subpages can be performed/viewed under this section, namely:

Create a rate plan
Copy rate plan
Details rate plan
Update rate plan
Delete rate plan

Create a rate plan

Under rate plans, to create a rate plan, click Create new. It consists of three sections, namely:

Rate plan info section
Mappings section
Rate plan summary

Rate plan info section

Under the info section, provide a name, code, description, and validity period. The general ledger depicts how Monetization will record the rate plan for financial accounting purposes. In addition, select the service and rating metric for the rate plan.

Note:

The service depicts which service type will be ascribed to the rate plan. For example, a rate plan for data should not be used to rate voice call events.

In addition, by including the service, Monetization will know which field(s) it can offer for your mappings.

Information:

When an event occurs and it enters the rate plan, Monetization first needs to figure out what the actual quantity-to-rate is before applying any prices, which can only be gotten from a rating metric.

A rating metric is a set of expressions that allows Monetization to calculate the quantity-to-rate from the service type fields.

Mappings section

Under the mappings section, there is an empty list of mappings initially.

Mapping fields

A mapping field represents one column in a rate plan row. Mapping fields relate to service type fields which will be compared to string values or rating sets to determine the correct rate plan mapping to apply charges.

The mapping field offers a drop-down selection of the service fields found in the service type, which was included in the rate plan info section. Once you select a particular service field, click Add; once added, to remove a mapping field, click .

Note:

Each event has a Quantity and Amount field, which are not service type fields, because they are not input parameters—they are calculated through rating. The Quantity refers to the calculated quantity to be rated by Monetization.

Mappings

Infinite mappings can be created, each can be responsible for a unique event entry, and each has a priority. To create a rate plan mapping, under Mappings, click Add mapping.

Note:

The mappings with the highest priority will be rated first. Setting priorities becomes useful if you have mappings specific to some operators in a region/country.

Once you add a particular mapping field for each mapping row, input the values that you want the parameters in a usage event to match for a particular mapping row to be matched.

Note:

To match the usage event parameter against anything for a mapping field in a mapping row, use *.

If the mapping field is a rating set field, Monetization will show the hierarchy structure that was set up under the rating sets section.

Tip:

When creating rate plan mappings, you can map to rating sets instead of fixed string/text values. This is useful because rating sets are looking for prefix matches, and rating sets can have multiple values to be compared with.

For example, in the telecommunication industry, assume the Slovenia rating set has match values (+386, +38671, +38641) and the United States rating set has match values (+1, +12).

If a usage event arrives for voice calls where the origin is set to +3865541234, the event will be mapped to the Slovenia rate plan mapping because the string prefix matches a match value from the Slovenia rating set. If the origin in the event were +14234235435, it would map to the United States rate plan mapping.

To copy a mapping, under Mappings, click Copy, and to delete a mapping click Delete. Copying a mapping creates a new mapping row while retaining the data from the copied mapping.

Mapping groups

Each mapping can have multiple mapping groups. To create a mapping group, under Mappings, first, click Toggle, then click Add mapping group.

For each mapping group, you can include a rating metric. Including a rating metric enables you to override the rating metric inserted in the rate plan info section. Also, it can enable you to have multiple rating metrics used throughout the rating process.

For each mapping group, you can also include multiple tariffs.

Tip:

Two tariffs can be configured; for example, daily and nightly tariffs. Then you can have two mapping groups, one for the daily tariff and another for the nightly tariff.

The behavior of what happens underneath the process when Monetization figures out the tariff can then be changed.

Note:

When Monetization tries to rate an event, it will look at the mapping, and once it finds a match, it checks what was configured in terms of tariff.

For each mapping group, you can also include a charge tag, which is predominantly used for discounting. For more information, see Tags. In addition, under each mapping group, ranges can be configured. For more information, see Ranges.

Ranges

Once a rate plan mapping has been determined, ranges are used for additional conditions, such as checking if a customer has free resources available.

If a range condition is true, then Monetization will apply the details found within the range. Monetization will keep applying the range details as long as any unrated quantity remains.

To create a range, under Mapping groups, click Add range.

Note:

The Base typify which type of value Monetization is checking. To configure, click Pick value; it could either be a resource, an event field, a value, or a custom value.

Example of a range

Assume two ranges, with the first having a Priority of 1, a Base of Free Data resource, a Start value of No minimum, and a Stop value of 0.

The second has a Priority of 0, a Base of US-Dollar resource, a Start value of No minimum, and a Stop value of No maximum.

Suppose a customer has free 20MB but consumes 25MB. The free 20MB will be applied to the Free Data resource because it is in a valid range (-20 to 0). However, the remaining 5MB will no longer fit that range; therefore, they will be applied as a monetary charge (from the second range, which is always valid).

Note:

The Start and Stop values are the minimum and maximum values specified in each range. Setting the values to No minimum and No maximum means that the fields will be set to -2147483647 and 2147483647, respectively.

The Multi-tier checkbox option is used for a step-by-step progression through the ranges. For example, given the following ranges:

Quantity_Counter; 0-100 — apply 1 euro per unit
Quantity_Counter; 100-200 — apply 2 euro per unit
Quantity_Counter; 200-infinite — apply 3 euros per unit

Assume an event with a quantity of 250; if Multi-tier is disabled, the amount will be:

250 × 3 euro = 750 euro the whole quantity is charged based on the range it falls under (3).

If Multi-tier is enabled, the price will be:

100 × 1 euro + 100 × 2 euro + 50 × 3 euro = 450 euro the quantity progresses through each tier.

Note:

Each resource range can have multiple resource details. If a rule is satisfied, Monetization can apply a specific detail. For more information, see Details.

Details

The details refer to the impacts that will occur in Monetization.

To create a detail, under Ranges, click Toggle, then click Add detail. Provide a priority, resource, amount, impact type, bill item, general ledger, unit, and resource tag.

Explanation of some terms

The amount refers to the price; the amount (debit) means you are charging the customer.
The impact type (scaled) means Monetization is multiplying the received calculated quantity with the amount, and the impact type (fixed) means that the price will not be multiplied by the quantity received.
The bill item is used to tell Monetization how the charge will show up on the invoice.
The unit is used for possible quantity unit conversion. For more information, see Unit groups.
The resource tag is used for discount targeting.
The general ledger tells Monetization how to keep track of things financially. Multiple account mappings are provided when creating a general ledger to determine which account should be credited or debited.

Rate plan summary

This section presents the information filled out in the previous two sections and can be reviewed before the rate plan is created.

Copy rate plan

Under rate plans, copying an existing rate plan equips you with the ability to create a new rate plan quickly. Essentially, by clicking Copy, it redirects you to a rate plan creation page, and it includes with it the data from the copied rate plan.

Using this functionality, you can model after the previously created rate plan to create a new rate plan quickly.

Details rate plan

Under rate plans, to see the full details of a rate plan, click Details. It contains the following:

Name
Code
Description
General ledger
Service
Rating metric
Validity

Below the information will be the rate plan mappings shown in a tabular format, including their ranges and details.

Update rate plan

Under rate plans, to update a rate plan, first, click Details. It shows the details of the rate plan. Then to update, click Update.

Information:

All information filled out under the create a rate plan section can be updated except for the Code.

Delete rate plan

To delete a rate plan, click Delete.

Note:

Deleting a rate plan already used in a product cannot be done. Every particular reference to the rate plan first has to be deleted.

Rating

Rating is a process in Monetization that applies the resource balance impacts according to the quantity and amounts set on the respective products or rate plan resource details.

Rating sets

To access this section, click Rating sets; all the rating sets will be shown.

Overview: Rating sets depict where zoning hierarchy can be created. They are tightly coupled with rate plans because one or the other will be needed to set up usage events.
Definition: Rating sets are hierarchical objects with multiple match sets to add a layer of flexibility to rate plan mapping. Instead of string mapping, they will be matched against an entire match set of a RatingSet object.
Example: The most common example is; prefixes in countries. For instance, Slovenia prefix is +386, then the Telemach operator in Slovenia can be +38670, +38640, and another operator can be +38641. This creates zoning hierarchies and can then be referenced in rate plan mappings.

Four actions/subpages can be performed/viewed under this section, namely:

Create a rating set
Details rating set
Update rating set
Delete rating set

Create a rating set

Under rating sets, to create a parent rating set, click Create a new parent rating set.

Tip:

For the creation of simple rating sets, the user interface should be used to create them. However, using the Monetization API may be easier for rating sets that contain lots of data or during the first import.

Provide a name and code. The Match Set is a set of string values that a field in the usage event is compared against to determine the correct rate plan mapping. To create a match set, under Match Set, click Create new.

The Info Set is a set of key-value pairs used to store custom information for a rating set. It has no processing logic impact. To create an info set, under Info Set, click Create new.

Information:

When creating rate plan mappings, they can be mapped to rating sets instead of fixed string/text values. This is useful because rating sets look for prefix matches and can be compared with multiple values.

Example of a rating set

In the telecommunication industry, the Slovenia rating set has match values of +386, +38671, and +38641, and the United States rating set has match values of +1 and +12.

A usage event arrives for a voice call where the origin is set to +3865541234. This event will be mapped to the Slovenia rate plan mapping because the string prefix matches a match value from the Slovenia rating set.

In contrast, if the origin in the event is set to +14234235435, it will map to the United States rate plan mapping.

Note:

Under each parent rating set, a rating subset can be created. To achieve this, click the name of the rating set and fill out the details of the rating subset: name, code, match set (optional), and info set (optional).

Details rating set

Under rating sets, to see the full details of a rating set, click the name of the rating set. It contains the following information:

Name
Code
Match set
Info set

Update rating set

Under rating sets, to update a rating set, first, click the name of the rating set; It shows the details. Then to update, click Update.

Delete rating set

Under rating sets, to delete a rating set, first click the name of the rating set; It shows the details. Then to delete, click Delete.

Note:

Deleting a rating set already used in a rate plan cannot be done. Every particular reference to the rating set first has to be deleted.

Rollovers

To access this section, click Rollovers. A paginated list of all rollovers is shown in a tabular format.

Rollovers are configured rules that determine how resource balances can be transferred between billing cycles. It enables a customer to move some unconsumed units of resources into their next billing cycle.

For example, a customer receives free 200MB of data every month, but a rollover defines that 100MB of data can be carried over to the next cycle if not consumed.

Four actions/subpages can be performed/viewed under this section, namely:

Create rollover
Details rollover page
Update rollover
Delete rollover

Create rollover

Under rollovers, to create a rollover, click Create new. It involves four sections, namely:

Rollover info section
Validity section
Rollover details section
Rollover summary

Rollover info section

Under the info section, provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Validity section

Under the validity section, configure the dates, which depict the active period of the rollover.

Rollover details section

Under this section, provide a name and code. The Priority determines the rollover to be used first if there are multiple rollovers.

Note:

A higher number indicates a higher priority.

The Cycle rollover amount specifies the maximum amount that can be transferred. Configuring the cycle rollover amount to -1 means that the maximum amount will be infinite.

The Transfer type determines whether the newly transferred balance is subtracted from the original (modified source) or created as a copy (leave source).

The Resource transfer from depicts the resource that would be transferring its balance.

The Resource transfer to depicts the resource receiving a specific balance.

The General ledger depicts how the rollover will be recorded for accounting purposes.

Rollover summary

This section presents the information from the previous three sections and can be reviewed before the rollover is created.

Details rollover page

Under rollovers, to see the full details of a rollover, click Details. It contains the following sections:

Info
Validity
Rollover details

Update rollover

Under rollovers, to update a rollover, first, click Details. It shows the details of the rollover. Then to update, click Update.

Information:

All information filled out under the create rollover section can be updated except for the Code.

Delete rollover

Under rollovers, to delete a rollover, click Delete.

Note:

Deleting a rollover already used in a product cannot be done. Every particular reference to the rollover first has to be deleted.

Tariffs

To access this section, click Tariffs. A paginated list of all tariffs is shown in a tabular format.

Tariffs depict Time of Use in Monetization. It is used to represent a specific time of use for service events. Through the use of tariffs, different pricing can be set up for usage events occurring during the night/day, weekend/workday, etc.

Information:

A tariff can also be referred to as time-related intervals and are very popular in the electricity/utility industries.

Four actions/subpages can be performed/viewed under this section, namely:

Create tariff
Details tariff page
Update tariff
Delete tariff

Create tariff

Under tariffs, to create a tariff, click Create new. Provide a name, code, type, priority, and validity period. Optionally, add a description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Note:

Multiple tariffs can be created with different ranges for specific times, days, and weeks. The tariffs are then used while creating a rate plan.

Based on the selected type, the tariff can represent a date (dd-mm-yy), a day of the week (1-7), a time range (08:00-10:00), a day range within a month (8-12), a day and time range (on the 8th to 12th between 08:00-10:00)

For instance, if the type is configured to use a time range with a start time of 12:00 AM and a stop time of 5:00 AM. Applying the tariff to a rate plan can lead to different pricing.

In addition, the tariffs are matched based on their priority. For example, a workday tariff could target all Mon-Fri days with priority 1, but it will be overruled with a Holiday Date tariff on Tuesday, 13th Sep 2022, with priority 2.

Note:

A higher number indicates a higher priority.

Details tariff page

Under tariffs, to see the full details of a tariff, click Details. It contains the following:

Status
Name
Code
Description
Type
Priority
Validity period

Update tariff

Under tariffs, to update a tariff, first, click Details. It shows the details of the tariff. Then to update, click Update.

Information:

All information filled out under the create tariff section can be updated except for the Code.

Delete tariff

Under tariffs, to delete a tariff, click Delete.

Note:

Deleting a tariff already used in a rate plan cannot be done. Every particular reference to the tariff first has to be deleted.

Docs: Subscriptions

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select Analytics, and click Subscriptions.

The subscription analytics section is divided into three subsections:

First subsection
Second subsection
Third subsection

First subsection

The first subsection shows the number of newly activated customer subscriptions for all plans. The information is based on the current month, a month ago, six months ago, and a year ago.

For example, assume the current month is April, and there a no new customer subscriptions to any plan. Last month in March, two customers subscribed to a particular plan. Six months ago, in October last year, no customer subscribed to any plan.

Note:

The red or green arrow shows the percentage decrease or increase respectively in the number of newly activated customer subscriptions for any plan at the moment against the same time a month ago, six months ago, and a year ago.

Second subsection

The second subsection shows a line graph representing the total customer subscriptions for each plan from a specific period based on an interval. You can filter by date-time.

Note:

The visual representation in the form of a line graph can be downloaded in various formats. To achieve this, click Chart context menu.

Third subsection

The third subsection shows a bar chart representing the number of newly activated customer subscriptions for all plans from a specific period based on an interval, including the churn rate. You can filter by an individual plan or/and date-time.

Information:

The churn rate refers to the rate of “leaving” customers.

Note:

The visual representation in the form of a bar chart can be downloaded in various formats. To achieve this, click Chart context menu.

Docs: Custom Attributes

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select System configuration, and click Custom attributes. A paginated list of all custom attributes is shown in a tabular format.

Information:

You can filter for custom attributes by an entity.

Four actions/subpages can be performed/viewed under this section, namely:

Create a custom attribute
Details custom attribute page
Update custom attribute
Delete custom attribute

Create a custom attribute

Under custom attributes, to create a custom attribute, click Create new. Provide a name and code.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

A custom attribute can have one out of four data types, which are:

Numeric (Number)
String (Text)
Boolean (True/False)
Datetime (Timestamp)

Note:

The data type specifies how the custom attribute will appear on the user interface in Monetization.

The entity specifies the object to which the custom attribute belongs.

Details custom attribute page

Under custom attributes, to see the full details of a custom attribute, click Details. It contains the following:

Name
Code
Data type
Entity
Mandatory
Included on invoice

Update custom attribute

Under custom attributes, to update a custom attribute, first, click Details; it shows the details of the custom attribute. Then to update, click Update.

Note:

All information filled out under the create a custom attribute section can be updated, except for the Code and Entity.

Delete custom attribute

Under custom attributes, to delete a custom attribute, click Delete.

Note:

Deleting a custom attribute already used in other parts of Monetization cannot be done. Every particular reference to the custom attribute first has to be deleted.

Docs: Discounts

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Create discount
- Simple discount section
- Advanced discount section
Details discount page
Update discount
Delete discount

To access this section in Monetization, from the Menu, select Catalog, and click Discounts. A paginated list of all discounts is shown in a tabular format.

Discounts as objects are treated the same way as products. They are part of a bundle which is part of a plan, and they also have a set of rules and rule filters describing what the discount targets exactly.

Note:

A discount has rule filters that target a specific tag or/and a combination of tags. Therefore, whenever rating applies an impact, this impact has the configured tags. These tags are then compared against any active discount rule filters; if they match, Monetization will know that the discount should be applied for these impacts.

Four actions/subpages can be performed/viewed under this section, namely:

Create discount
Details discount page
Update discount
Delete discount

Create discount

Under discounts, to create a discount, click Create new. Choose either the simple or the advanced discount section.

Information:

As the name implies, the advanced discount section is used to create complex discounts that can target both the charge and resource tag.

Simple discount section

For the simple discount section, provide a name and code.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

In addition, choose the type and insert the value. The type can be configured either as a percentage or a flat amount. Also, choose the charge tag, monetary resource, and configure the validity period.

Note:

The charge tag is used to determine the product the discount will target. For more information about a charge tag, see Tags.

Information:

Discount works similarly to a product. Therefore, after creating a discount, it should be added to a bundle that is then included in a plan to enable it.

Advanced discount section

For the advanced discount section, it involves three sections, namely:

Info section
Rule sets
Summary

Info section

Under the info section, provide a name, code, description, and validity period.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

The priority determines the discount to be used first if multiple discounts exist in the bundle.

Information:

A higher number indicates a higher priority.

Note:

A bundle is a higher-level object for grouping, but discount priorities apply regardless of the bundle.

The non-active rating can be configured on products and discounts. It means whether Monetization should still apply impacts related to these products and discounts after they are inactive or closed.

It has three configurable options:

FORBIDDEN — means Monetization can only rate the discount if it is active.
RATE_INACTIVE — means Monetization can only rate the discount when active or inactive but not closed.
RATE_INACTIVE_AND_CLOSED — means Monetization will consistently rate the discount, whether active, inactive, or closed.

In addition, choose the type and insert the value. The type can either be a percentage or a flat amount.

Rule sets

Under the rule sets section, to create a rule set, click Add rule set. The rule set is used to group rule object that fit together.

Rules

To create a rule, under Rule sets, first, click Toggle, then click Add rule. Each rule has a priority, base, base value, rule filters, and ranges.

Base: The base means what is being checked (resource, event field, value, custom value).
Base value (Value): Depending on the base, it can be a resource, event field, value, or custom value.

Information:

The value tells Monetization which base to check. For instance, if you want to look at the event field called amount, you will set the base to event field and the value to amount.

Rule filters: The rule filter depicts what the discount should target. This means it will only pick up events that match the rule filter. You can filter by charge tag, resource tag, service, and event name.
Ranges: When the rule filter matches, Monetization will take the base and value and compare them against the ranges.

Information:

For example, if the base and value are event field and amount, respectively, and you have a voice event with an amount of 3.5, Monetization will compare 3.5 against the ranges.

If it finds an applicable range, it will apply the discount details which belong to that range.

The discount details then discount the amount (3.5) for a specific percentage value and apply that impact to the specified resource, bill item with a specific tax, and general ledger.

Summary

This section shows the summary of what was inputted in the previous two sections (info section and rule sets). The discount details can be reviewed before creating the discount.

Details discount page

Under discounts, to see the full details of a particular discount, click Details. It contains the following:

Name
Code
Priority
Description
Non-active rating
Value
Validity period

Below the information will be the rule sets shown in a tabular format, including their rules, rule filters, and ranges.

Update discount

Under discounts, to update a discount, first, click Details; it shows the details of the discount. Then to update, click Update.

Information:

All information filled out under the create discount section can be updated except for the Code.

Delete discount

Under discounts, to delete a discount, click Delete.

Note:

Deleting a discount already used in other parts of Monetization cannot be done. Every particular reference to the discount first has to be deleted.

Docs: Service Design

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Service fields
Service types
Unit groups
Rating metrics
Charge intervals

To access this section in Monetization, from the Menu, select Business configuration, and click Service design.

Information:

Monetization must be taught what service(s) are required for a business to operate internally. For example, assume a telecommunication industry with a data, voice, and SMS service. These services will consist of several fields or parameters. You can then use part of those fields to determine the quantity to be rated.

Service fields

To access this section, click Service fields. A paginated list of all service fields is shown in a tabular format.

A service field is a parameter that can be part of a service type. The parameter will hold information about one session/event in Monetization.

Service fields example

Assume a telecommunication company that enables customers to make phone calls. The service fields can include the following:

start_time
origin
destination
duration
direction
quantity

Information:

These service fields can then be included in a service. Then, whenever a usage event comes in for the service, these are the fields Monetization will expect, and it can get the ratable quantity from these fields.

Reserved fields

The session identifier and identifier are reserved fields that must exist as part of the service fields. They are created automatically when a site is created in Monetization.

The identifier will represent the service identifier of one customer—for instance, a mobile phone number for data or voice service. The identifier must be unique for each site; it could be an integer number, a device, or anything that can be used to identify a customer uniquely.

The session identifier should be included in each usage event. This ensures that the same event will only be rated once and cannot be duplicated.

Four actions/subpages can be performed/viewed under this section, namely:

Create a service field
Details service field page
Update service field
Delete a service field

Create a service field

Under service fields, to create a service field, click Create new. Provide a name and code. Optionally, add a description.

Information:

Multiple service fields can be created.

Details service field page

Under service fields, to see the full details of a service field, click Details. It contains the following:

Name
Code
Description

Update service field

Under service fields, to update a service field, first, click Details; it shows the details of the service field. Then to update, click Update.

Information:

All information filled out under the create a service field section can be updated except for the Code.

Delete a service field

Under service fields, to delete a service field, click Delete.

Note:

Deleting a service field already used in other parts of Monetization cannot be done. Every particular reference to the service field first has to be deleted.

Service types

To access this section, click Service types. A paginated list of all service types is shown in a tabular format.

A service type describes one service in Monetization—for instance, a voice or data service. It determines which service fields are meant to be part of one session/event for that particular service.

In addition, a service type defines a service by depicting the optional or mandatory service fields and rating set fields Monetization needs in usage events for a specific service.

Information:

A purchased product can offer a service when the created product contains a service type. Monetization can rate events for service usage.

Four actions/subpages can be performed/viewed under this section, namely:

Create service type
Details service type page
Update service type
Delete service type

Create service type

Under service types, to create a service type, click Create new.

The mandatory input fields include the following:

name
code
mandatory service field(s)
authorization strategy

The optional input fields include the following:

description
optional service field(s)
rating set fields
Included on invoice
Impact balances

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Information:

Including the session identifier and identifier as mandatory fields is good practice. They are known as reserved fields. For more information, see Reserved fields.

To include the service details on the invoice, use the Included on invoice toggle switch to enable/disable. Enabling this feature means that Monetization will pull this data on the JSON object generated for one invoice.

Note:

Only include the information needed on the invoice for performance optimization.

If Impact balances toggle switch is enabled then this service will be impacting, reserving, and working with balances in real-time. In case this is not necessary, turning this off will increase rating performance.

Rating set fields

A rating set field is a field that, instead of being matched as raw strings, is compared against a rating sets object, which can have multiple matches. It is helpful for prefix matching.

Tip:

Monetization will map the rating set field towards a pattern.

Rating set field example

The Slovenia rating sets in the telecommunication industry can have multiple matches: 003865, 003867, 003864, etc., representing telephone number prefixes. If an origin service field is defined as a rating set field on a service type, the field’s contents will be compared to all prefixes in Slovenia when Monetization tries to find a match. Therefore, if the origin is 003865123123, the Slovenia rating set will be matched.

Information:

Comparing a service field to a hierarchy of zones becomes a rating set field.

Details service type page

Under service types, to see the full details of a service type, click Details. It contains the following:

Name
Code
Description
Mandatory fields
Optional fields
Rating set fields
Authorization strategy
Included on invoice
Impact balances

Update service type

Under service types, to update a service type, first, click Details; it shows the details of the service type. Then to update, click Update.

Information:

All information filled out under the create service type section can be updated except for the Code.

Note:

When updating the information from services used by customers and events, if a new service field is added to the service type, the service field will be missing from all previous events. This is because the service field was unknown to Monetization then.

Delete service type

Under service types, to delete a service type, click Delete.

Note:

Deleting a service type already used in other parts of Monetization cannot be done. Every particular reference to the service type first has to be deleted.

Unit groups

To access this section, click Unit groups. A paginated list of all unit groups is shown in a tabular format.

A unit group is designed to create related units in Monetization. A conversion factor must also be provided to enable Monetization to make conversions between the units automatically.

Example of a unit group

Assume a telecommunication company provides data service to customers. After configuring the units in kilobytes (kB), megabytes (MB), and gigabytes (GB), the usage event can have input in kB; at the same time, pricing can work in MB.

Note:

Each unit group should hold units that belong together. For example, the data unit group can comprise kB, MB, and GB. Also, it should include a conversion factor that allows Monetization to convert between the units automatically—for example, converting between kB and MB.

Information:

When creating a rate plan, a unit can be provided for possible quantity unit conversion.

Four actions/subpages can be performed/viewed under this section, namely:

Create unit group
Details unit group page
Update unit group
Delete unit group

Create unit group

Under unit groups, to create a unit group, click Create new. Provide a name and code. Optionally, provide a description and some units.

To add a unit, under Units, click Add unit. Provide a name, symbol, and factor. To make a particular unit the base unit, check the checkbox Base unit.

Note:

The base unit must have a factor of one, while others should have a factor compared to the base unit.

For example, assume the following units in a unit group:

Name	Symbol	Factor
kilobyte	kB	1
megabye	MB	1024
gigabyte	GB	1048576

To delete a unit, under Units, click Delete

Details unit group page

Under unit groups, to see the full details of a unit group, click Details. It contains the following:

Name
Code
Description
Units - The units are shown in a tabular format.

Update unit group

Under unit groups, to update a unit group, first, click Details; it shows the details of the unit group. Then to update, click Update.

Information:

All information filled out under the create unit group section can be updated except for the Code.

Delete unit group

Under unit groups, to delete a unit group, click Delete.

Rating metrics

To access this section, click Rating metrics. A paginated list of all rating metrics is shown in a tabular format.

Monetization uses a rating metric to determine the quantity to be rated based on the service field(s) from the session/event. In other words, a rating metric enables Monetization to know how to get the ratable quantity out of an event.

Information:

When a rating metric is created in Monetization, it is not tied to a service or product. This is done when creating a rate plan.

Four actions/subpages can be performed/viewed under this section, namely:

Create rating metric
Details rating metric page
Update rating metric
Delete rating metric

Create rating metric

Under rating metrics, to create a rating metric, click Create new. Provide a name and code. Optionally, provide a description and a metric expression(s).

To add a metric expression, under Metric expressions, click Add metric expression. Provide a priority, expression, and unit. The unit is configured under unit groups. For more information, see Unit groups.

Note:

The Expression should refer directly to the service fields from the service type.

For example, assume a quantity service field is inserted as the rating metric expression; Monetization will get the ratable quantity from the quantity service field.

Note:

Multiple metric expressions can be created with different priorities. For example, priority 0, priority 1, priority 2, etc. However, Monetization will initially use the metric expression with a greater priority number.

Basic math expressions like addition, subtraction, and multiplication can be performed in a metric expression to determine the ratable quantity. For example, assume an end_timeand start_time service field; from that, a rating metric expression of the form end_time - start_time can be created.

Information:

The actual assignment of the metric happens later when the service product is being created.

Details rating metric page

Under rating metrics, to see the full details of a rating metric, click Details. It contains the following:

Name
Code
Description
Metric expressions - The metric expressions are shown in a tabular format.

Update rating metric

Under rating metrics, to update a rating metric, first, click Details; it shows the details of the rating metric. Then to update, click Update.

Information:

All information filled out under the create rating metric section can be updated except for the Code.

Delete rating metric

Under rating metrics, to delete a rating metric, click Delete.

Note:

Deleting a rating metric already used in other parts of Monetization cannot be done. Every particular reference to the rating metric first has to be deleted.

Charge intervals

To access this section, click Charge intervals. A paginated list of all charge intervals is shown in a tabular format.

A charge interval describes how Monetization will round the ratable quantity from the rating metric. After the rating metric calculates the raw quantity-to-be-rated, the charge interval can round up or down based on the configurations.

Note:

When Monetization receives an event, the ratable quantity is gotten. It is then compared to the charge interval to round up or down to the next step. Once rounded, that will be the new ratable quantity.

Four actions/subpages can be performed/viewed under this section, namely:

Create charge interval
Details charge interval page
Update charge interval
Delete charge interval

Create charge interval

Under charge intervals, to create a charge interval, click Create new. Provide a name and code. Optionally, provide a description, minimum step, step, rounding mode, and unit.

The minimum step represents the smallest quantity that can be rated. Therefore, if Monetization receives an event below that, it will be rounded to the minimum step. For instance, assume a minimum step configuration of zero, and Monetization receives an event below zero; the event will be rounded to zero.

The step represents how the ratable quantity should increment. For example, Monetization receives an event and figures out the ratable quantity to be 550 through the rating metric; if the step is configured to be 100, Monetization will round the quantity up or down depending on the configuration of the rounding mode.

If the rounding mode is configured to Up, the new ratable quantity will be 600, while if the rounding mode is configured to Down, the new ratable amount will be 500.

Details charge interval page

Under charge intervals, to see the full details of a charge interval, click Details. It contains the following:

Name
Code
Description
Min step
Step
Rounding mode
Unit

Update charge interval

Under charge intervals, to update the charge interval, first, click Details; it shows the details of the charge interval. Then to update, click Update.

Information:

All information filled out under the create charge interval section can be updated except for the Code.

Delete charge interval

Under charge intervals, to delete a charge interval, click Delete.

Note:

Deleting a charge interval already used in other parts of Monetization cannot be done. Every particular reference to the charge interval first has to be deleted.

Docs: Usage

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select Analytics, and click Usage.

The usage analytics section is divided into two subsections:

First subsection
Second subsection

First subsection

The first subsection shows the total usage of the monetary resources in terms of quantity and amount. The information is based on the current month, a month ago, six months ago, and a year ago.

For example, assume the current month is April, and no customer usage occurred. Last month in March, 140 quantities resulted from the usage of the monetary resource, which also led to 140 euros. Six months ago, in October last year, no customer usage occurred.

Note:

The red or green arrow shows the percentage decrease or increase respectively in the usage of the monetary resource in terms of their quantity and amount by customers at the moment against the same time a month ago, six months ago, and a year ago.

Second subsection

The second subsection shows a bar chart representing the customer usage of services/resources in Monetization from a specific period based on a metric and interval. You can filter by resources, services, or/and customer types.

Note:

The visual representation in the form of a bar chart can be downloaded in various formats. To achieve this, click Chart context menu.

Docs: Event Generators

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select Catalog, and click Event generators. A paginated list of all event generators is shown in a tabular format.

An event generator can be linked to a service or billing profile. Essentially, it is used to generate an event just before billing, which can contain fields with values of resource balances.

Event generator example

Suppose a customer is about to be billed; therefore, their billing cycle is about to shift. Using an event generator, Monetization can create some usage events on its own based on the status of the current resources available to each customer.

For instance, suppose a utility company for electricity, and only once per month do we have a balance on the customer. The event generator can be used to take the balance of the counter on the customer and generate a usage event out of it.

Four actions/subpages can be performed/viewed under this section, namely:

Create an event generator
Details event generator page
Update event generator
Delete event generator

Docs: Notifications

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Notifications
Platforms
- Twilio
- Firebase (FCM)

To access this section in Monetization, from the Menu, select System configuration, and click Notifications.

Notifications

To access this section, click Notifications. A paginated list of all notifications is shown in a tabular format.

Four actions/subpages can be performed/viewed under this section, namely:

Create notification
Details notification page
Update notification
Delete notification

Create notification

Under notifications, to create a notification, click Create new. Provide a name and code.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

Publishers are used for configuring what type of notification to be sent: SMS, push notification, URL, Email, and Log. It is also used to configure where the notification will be sent using Receivers.

To create a publisher, under Publishers, click Add publisher. The action and number of retries specify the type of notification that will be sent and how many times to resend in case of a failure—for instance, sending out an email that will resend three times, suppose it fails.

Information:

The template is configured in Monetization, under Business configuration Templates. For more information, see Template.

Note:

The URL action means the notification will be sent as an API request to the URL, while the Log action means the logging service will add a log entry whenever the notification is triggered.

Under each publisher are Receivers. The Receivers refers to where the notification will be sent. It can be a URL or a customer (if it is an email or SMS).

The Scope typifies what will trigger the notification, which can be that of subscription, billing, rating, or exporting.

Once a specific action from the scope occurs, you can add filtering options. To add a filter, under Filters, click Add filter.

Details notification page

Under notification, to see the full details of a notification, click Details. It contains the following information:

Name
Code
Action
Scope
Publishers
Filters (if any)

Update notification

Under notification, to update a notification, first, click Details; it shows the details of the notification. Then to update, click Update.

Information:

All information filled out under the create notification section can be updated except for the Code.

Delete notification

Under notification, to delete a notification, click Delete.

Platforms

To access this section, click Platforms.

This section shows different platforms that enable the delivery of notifications, which Monetization is integrated with. It includes Twilio for text messages and Firebase for push notifications.

Note:

You need to set up the services to use it in Monetization.

Twilio

Twilio is a cloud communication platform that provides businesses with a suite of APIs for building messaging, voice, and video communication applications. Its platform enables businesses to send text messages as notifications from Monetization.

To configure, click Twilio; insert your Client ID and Client secret.

Information:

Once configured, you can edit and delete the configuration. To delete, click Delete.

Firebase (FCM)

Firebase Cloud Messaging (FCM) provides a reliable and battery-efficient connection between your server and devices, allowing you to deliver and receive messages and notifications on iOS, Android, and the web at no cost.

Docs: Products

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select Analytics, and click Products.

The product analytics section is divided into two subsections:

First subsection
Second subsection

First subsection

The first subsection shows a pie chart representing the top five product purchases by customers.

Second subsection

The second subsection shows a bar chart representation of all product purchases from a specific period based on a metric and interval. You can filter by product or/and customer type.

Note:

The visual representation in the form of a bar chart can be downloaded in various formats. To achieve this, click Chart context menu.

Docs: Voucher

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Voucher vs. Coupon
- Example of a coupon
- Example of a voucher
Create voucher
- Explanation of some terms
- Practical example
Details voucher page

To access this section in Monetization, from the Menu, select Business configuration, and click Voucher. A paginated list of all vouchers is shown in a tabular format.

Vouchers give specific bundles that contain a discount to the customer when consumed. It is similar to a coupon.

Voucher vs. Coupon

The difference between a coupon and a voucher is that a coupon only lasts for that specific purchase. In contrast, a voucher can give something to the customer on a prolonged basis. For instance, a customer can get a discount that lasts two years through a voucher.

Note:

A coupon is used and only valid during purchase, while a voucher can be consumed anytime.

Example of a coupon

A customer is purchasing an add-on for 1GB, which costs 10 euros and has a coupon code for a 50% discount.

Example of a voucher

A customer receives a reward voucher code, which, when consumed, will grant 100 free MB.

Two actions/subpages can be performed/viewed under this section, namely:

Create a voucher
Details voucher page

Create a voucher

Under voucher, to create a voucher, click Create new. Provide a name, code, vendor, code character set, code template, quantity, redemption quantity, range start, bundle, and validity period; the remaining input fields are optional.

Explanation of some terms

Vendor

This means the name of the entity that owns the voucher. It is only used for information purposes. Your organization name can be used under this section.

Code character set

The code template

This provides the template that Monetization will use to generate the voucher codes.

Note:

Use # as a placeholder for auto-generated codes.

Quantity

This represents the number of voucher codes to be generated.

Redemption quantity

This represents how many times the customer can use each code.

Range start

This represents the starting point for the auto-generated codes.

Practical example

The below shows an example of a voucher configuration setting.

code template = voucher_##
character set = numerical
quantity = 5
redemption quantity = 1
range start = 87

This will yield five generated voucher codes, which the customer can only use once. The codes will be generated as follows based on the code template and range start:

voucher_87
voucher_88
voucher_89
voucher_90
voucher_91

Details voucher page

Under voucher, to see the full details of a voucher, click Details. It contains the following:

Name
Code
Description
Vendor
Type
Code character set
Code template
Quantity
Redemption quantity
Range start
bundle
Validity period

Below the information will be the generated voucher codes shown in a tabular format, including their status and remaining quantity.

Information:

You can filter for the voucher codes by New, In use, Used, Expired, or Canceled.

Docs: Billing

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select Analytics, and click Billing.

The billing analytics section is divided into three subsections:

First subsection
Second subsection
Third subsection

First subsection

The first subsection shows the net revenue obtained from customers. The information is based on the current month, a month ago, six months ago, and a year ago.

For example, assume the current month is April, with net revenue of 34,000 euros. Last month in March, there was a net revenue of 40,000 euros. Six months ago, in October last year, there was a net revenue of 25,000 euros.

Note:

The red or green arrow shows the percentage decrease or increase respectively in the net revenue at the moment against the same time a month ago, six months ago, and a year ago.

Second subsection

The second subsection shows a bar chart representing the revenue obtained from a specific period based on an interval. In addition, you also see the payments that you made.

Note:

The visual representation in the form of a bar chart can be downloaded in various formats. To achieve this, click Chart context menu.

Third subsection

The third subsection shows a bar chart representing the revenue from a specific period based on customer type/payment type and interval.

Note:

The visual representation in the form of a bar chart can be downloaded in various formats. To achieve this, click Chart context menu.

Docs: Business Operations

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Jobs
Job history
Usage

To access this section in Monetization, from the Menu, click Business operations.

Jobs

To access this section, click Jobs. Scheduled jobs (tasks) or currently executing jobs are shown in this section.

There are nine different jobs in Monetization, namely:

Billing job
Invoicing job
Purchase verification job
Plan transition job
Activate deferred purchases job
Payment collection job
Dunning job
Finance reporting job
Exporting job
Communication job

Billing job

The billing job is configured to execute billing for any billing profile that match the job criteria, and it is in a state where billing can be executed.

Information:

Billing closes the previous billing cycle and starts a new one. For example, for customers who have their billing day set to the 1st day of the month, the billing job can be scheduled to run on the 1st to shift their billing cycle.

To create a billing job, click Create new. Provide a name and description. Also, set the billing job schedule. To schedule the job to run only once, select One-off; to run repeatable based on configured period, select Repeatable; to run the job by another job, select Chain.

Note:

A job configured as a Chain can only be executed by another job.

If the One-off schedule is selected, the job must be configured to run at a particular date-time.

If the Repeatable schedule is selected, the job must also be configured to run at a particular date-time. In addition, you must configure how often the job should be executed. It could be yearly, monthly, weekly, daily, hourly, or in minutes.

Note:

Selecting Test mode means that the job will run as a test, which will not mutate the database.

Specific criteria for the billing job can be configured; it is designed to determine the particular element(s) the job will affect. The elements include the customer type, customer IDs, groups, custom attribute, and payment types. For instance, the billing job applied only to customers with a post-paid payment type.

To add a criteria, under Criteria, click Create new. To delete a criteria, under Criteria, click Delete.

Note:

The billing job will affect ALL entities if no criteria are provided.

Information:

When Monetization executes billing for a customer billing profile, the job will also run billing for group members in that customer’s group. To disable, under Criteria, select Groups, and select value.

To chain other jobs, under Chain jobs, click Create new; select the Job type and the Job.

Note:

Only a job configured as a chain job can be shown under Chain jobs.

Information:

The Offset parameter specifies the time that should pass before the chained job is executed.

To delete a chain job, click Delete.

Once the billing job has been configured, the status, name, criteria, and next run at variables for the job are displayed. To pause the job, click Pause; to resume the job, click Resume; to delete the job, click Delete.

Note:

When a job is paused, it will not execute, irrespective of the schedule. Resuming the job unpauses the job.

Invoicing job

The invoicing job is configured to generate the corresponding invoice for any bill(s) with the billing status. The bills will be shown on the invoice, which the customer can pay.

To create an invoicing job, click Create new. Provide a name and description. Also, set the invoicing job schedule. To schedule the job to run once, select One-off; to run repeatable based on configured period, select Repeatable; to run the job by another job, select Chain.

Note:

A job configured as a Chain can only be executed by another job.

If the One-off schedule is selected, the job must be configured to run at a particular date-time.

Note:

Selecting Test mode means that the job will run as a test, which will not mutate the database.

Specific criteria for the invoicing job can be configured; it is designed to determine the particular element(s) the job will affect. The elements include the customer type and customer IDs. For instance, the invoicing job applied only for a specific customer type.

To add a criteria, under Criteria, click Create new. To delete a criteria, under Criteria, click Delete.

Note:

The invoicing job will affect ALL entities if no criteria are provided.

To chain other jobs, under Chain jobs, click Create new; select the Job type and the Job.

Note:

Only a job configured as a chain job can be shown under Chain jobs.

Information:

The Offset parameter specifies the time that should pass before the chained job is executed.

To delete a chain job, click Delete.

Once the invoicing job has been configured, the status, name, criteria, and next run at variables for the job are displayed. To pause the job, click Pause; to resume the job, click Resume; to delete the job, click Delete.

Note:

When a job is paused, it will not execute, irrespective of the schedule. Resuming the job unpauses the job.

Purchase verification job

The purchase verification job is configured to check if your customers should have any of their products renewed or canceled, then it will execute that action.

To create a purchase verification job, click Create new. Provide a name and description. Also, set the purchase verification job schedule. To schedule the job to run once, select One-off; to run repeatable based on configured period, select Repeatable; to run the job by another job, select Chain.

Note:

A job configured as a Chain can only be executed by another job.

If the One-off schedule is selected, the job must be configured to run at a particular date-time.

Note:

Selecting Test mode means that the job will run as a test, which will not mutate the database.

Specific criteria for the purchase verification job can be configured; it is designed to control the element(s) the job will affect. The elements include the customer type and customer IDs. For instance, the purchase verification job applied only for a specific customer type.

To add a criteria, under Criteria, click Create new. To delete a criteria, under Criteria, click Delete.

Note:

The purchase verification job will affect ALL entities if no criteria are provided.

To chain other jobs, under Chain jobs, click Create new; select the Job type and the Job.

Note:

Only a job configured as a chain job can be shown under Chain jobs.

Information:

The Offset parameter specifies the time that should pass before the chained job is executed.

To delete a chain job, click Delete.

Once the purchase verification job has been configured, the status, name, criteria, and next run at variables for that job are displayed. To pause the job, click Pause; to resume the job, click Resume; to delete the job, click Delete.

Note:

When a job is paused, it will not execute, irrespective of the schedule. Resuming the job unpauses the job.

Plan transition job

The plan transition job is configured to handle migrating a customer from one plan to another. For instance, if the plan transition job is configured to execute once daily at midnight, then any customer waiting for their plan to be changed on that day will have their plan changed at midnight.

To create a plan transition job, click Create new. Provide a name and description. Also, set the plan transition job schedule. To schedule the job to run once, select One-off; to run repeatable based on configured period, select Repeatable; to run the job by another job, select Chain.

Note:

A job configured as a Chain can only be executed by another job.

If the One-off schedule is selected, the job must be configured to run at a particular date-time.

Note:

Selecting Test mode means that the job will run as a test, which will not mutate the database.

Specific criteria for the plan transition job can be configured; it is designed to control the element(s) the job will affect. The elements include the customer type and customer IDs. For instance, the plan transition job applied only for a specific customer type.

To add a criteria, under Criteria, click Create new. To delete a criteria, under Criteria, click Delete.

Note:

The plan transition job will affect ALL entities if no criteria are provided.

To chain other jobs, under Chain jobs, click Create new; select the Job type and the Job.

Note:

Only a job configured as a chain job can be shown under Chain jobs.

Information:

The Offset parameter specifies the time that should pass before the chained job is executed.

To delete a chain job, click Delete.

Once the plan transition job has been configured, the status, name, criteria, and next run at variables for that job are displayed. To pause the job, click Pause; to resume the job, click Resume; to delete the job, click Delete.

Note:

When a job is paused, it will not execute, irrespective of the schedule. Resuming the job unpauses the job.

Activate deferred purchases job

Customers can schedule purchases in advance. When configured and executed, the activate deferred purchases job would enable and charge the customer for those purchases.

Note:

The purchases must be valid at that time.

To create an activate deferred purchases job, click Create new. Provide a name and description. Also, set the activate deferred purchases job schedule. To schedule the job to run once, select One-off; to run repeatable based on configured period, select Repeatable; to run the job by another job, select Chain.

Note:

A job configured as a Chain can only be executed by another job.

If the One-off schedule is selected, the job must be configured to run at a particular date-time.

Note:

Selecting Test mode means that the job will run as a test, which will not mutate the database.

Specific criteria for the activate deferred purchases job can be configured; it is designed to control the element(s) the job will affect. The elements include the customer type and customer IDs. For instance, the activate deferred purchases job applied only for a specific customer type.

To add a criteria, under Criteria, click Create new. To delete a criteria, under Criteria, click Delete.

Note:

The activate deferred purchases job will affect ALL entities if no criteria are provided.

To chain other jobs, under Chain jobs, click Create new; select the Job type and the Job.

Note:

Only a job configured as a chain job can be shown under Chain jobs.

Information:

The Offset parameter specifies the time that should pass before the chained job is executed.

To delete a chain job, click Delete.

Once the activate deferred purchases job has been configured, the status, name, criteria, and next run at variables for that job are displayed. To pause the job, click Pause; to resume the job, click Resume; to delete the job, click Delete.

Note:

When a job is paused, it will not execute, irrespective of the schedule. Resuming the job unpauses the job.

Payment collection job

The payment collection job is configured to automatically collect payments for any due bill if the customer has added a default payment method (credit/debit card).

To create a payment collection job, click Create new. Provide a name and description. Also, set the payment collection job schedule. To schedule the job to run once, select One-off; to run repeatable based on configured period, select Repeatable; to run the job by another job, select Chain.

Note:

A job configured as a Chain can only be executed by another job.

If the One-off schedule is selected, the job must be configured to run at a particular date-time.

Note:

Selecting Test mode means that the job will run as a test, which will not mutate the database.

Specific criteria for the payment collection job can be configured; it is designed to control the element(s) the job will affect. The elements include the customer type and customer IDs. For instance, the payment collection job applied only to a specific customer type.

To add a criteria, under Criteria, click Create new. To delete a criteria, under Criteria, click Delete.

Note:

The payment collection job will affect ALL entities if no criteria are provided.

To chain other jobs, under Chain jobs, click Create new; select the Job type and the Job.

Note:

Only a job configured as a chain job can be shown under Chain jobs.

Information:

The Offset parameter specifies the time that should pass before the chained job is executed.

To delete a chain job, click Delete.

Once the payment collection job has been configured, the status, name, criteria, and next run at variables for that job are displayed. To pause the job, click Pause; to resume the job, click Resume; to delete the job, click Delete.

Note:

When a job is paused, it will not execute, irrespective of the schedule. Resuming the job unpauses the job.

Dunning job

The dunning job is configured to run actions set up at the dunning configurations. For more information, see Dunning.

To create a dunning job, click Create new. Provide a name and description. Also, set the dunning job schedule. To schedule the job to run once, select One-off; to run repeatable based on configured period, select Repeatable; to run the job by another job, select Chain.

Note:

A job configured as a Chain can only be executed by another job.

If the One-off schedule is selected, the job must be configured to run at a particular date-time.

Note:

Selecting Test mode means that the job will run as a test, which will not mutate the database.

Specific criteria for the dunning job can be configured; it is designed to control the element(s) the job will affect. The elements include the customer type, customer IDs, and custom attribute. For instance, the dunning job applied only to a specific customer type.

To add a criteria, under Criteria, click Create new. To delete a criteria, under Criteria, click Delete.

Note:

The dunning job will affect ALL entities if no criteria are provided.

To chain other jobs, under Chain jobs, click Create new; select the Job type and the Job.

Note:

Only a job configured as a chain job can be shown under Chain jobs.

Information:

The Offset parameter specifies the time that should pass before the chained job is executed.

To delete a chain job, click Delete.

Once the dunning job has been configured, the status, name, criteria, and next run at variables for that job are displayed. To pause the job, click Pause; to resume the job, click Resume; to delete the job, click Delete.

Note:

When a job is paused, it will not execute, irrespective of the schedule. Resuming the job unpauses the job.

Finance reporting job

The finance reporting job is configured to collect all the financial journals for a designated period.

To create a finance reporting job, click Create new. Provide a name and description. Also, set the finance reporting job schedule. To schedule the job to run once, select One-off; to run repeatable based on configured period, select Repeatable; to run the job by another job, select Chain.

Note:

A job configured as a Chain can only be executed by another job.

If the One-off schedule is selected, the job must be configured to run at a particular date-time.

Note:

Selecting Test mode means that the job will run as a test, which will not mutate the database.

Specific criteria for the financial reporting job can be configured; it is designed to control the element(s) the job will affect. The elements include general ledgers, general ledger groups, revenue types, and account types. For instance, the financial reporting job applied only to a specific account type.

To add a criteria, under Criteria, click Create new. To delete a criteria, under Criteria, click Delete.

Note:

The financial reporting job will affect ALL entities if no criteria are provided.

The Period duration specifies the period for which the financial report will be created—for example, a financial report from March 2022 or a report from the previous month.

To chain other jobs, under Chain jobs, click Create new; select the Job type and the Job.

Note:

Only a job configured as a chain job can be shown under Chain jobs.

Information:

The Offset parameter specifies the time that should pass before the chained job is executed.

To delete a chain job, click Delete.

Note:

When a job is paused, it will not execute, irrespective of the schedule. Resuming the job unpauses the job.

Exporting job

The exporting job is configured to export multiple components, such as invoices, financial reports, payment transactions, usage events, etc., in various formats to different locations.

To create an exporting job, click Create new. Provide a name and description. Also, set the exporting job schedule. To schedule the job to run once, select One-off; to run repeatable based on configured period, select Repeatable; to run the job by another job, select Chain.

Note:

A job configured as a Chain can only be executed by another job.

If the One-off schedule is selected, the job must be configured to run at a particular date-time.

Note:

Selecting Test mode means that the job will run as a test, which will not mutate the database.

Under Configuration, configure the type of data to be exported, which could be an invoice, financial report, payment transaction, or event. Furthermore, configure the destination: email, SFTP, or webhook.

If email is configured as the destination, provide the mail template. The mail template is configured under Business configuration Template Mail templates.

If SFTP is configured, provide the location and format. The location specifies where the exported file will be transferred.

Tip:

Download and install an SFTP/FTP client/software, for example, FileZilla . Run it as a server on your computer, and provide the URL to Monetization as the location. This will download the file to the server.

Specific criteria for the exporting job can be configured; it is designed to control the element(s) the job will affect. The elements include the customer type, custom attribute, and payment types. For instance, the exporting job applied only to customers with a post-paid payment type.

To add a criteria, under Criteria, click Create new. To delete a criteria, under Criteria, click Delete.

Note:

The exporting job will affect ALL entities if no criteria are provided.

The Period duration specifies the period for which the export will be created—for example, exporting usage events from March 2022 or invoices from the previous month. The Period field specifies the field to search by.

To chain other jobs, under Chain jobs, click Create new; select the Job type and the Job.

Note:

Only a job configured as a chain job can be shown under Chain jobs.

Information:

The Offset parameter specifies the time that should pass before the chained job is executed.

To delete a chain job, click Delete.

Once the exporting job has been configured, the status, name, criteria, and next run at variables for that job are displayed. To pause the job, click Pause; to resume the job, click Resume; to delete the job, click Delete.

Note:

When a job is paused, it will not execute, irrespective of the schedule. Resuming the job unpauses the job.

Communication Job

A Communication Job is used to send marketing or transactional messages to your customers on a scheduled basis.
It combines a Mail Template (content) with a job configuration (recipients, timing, and delivery rules).

Note:

Before creating a communication job, you first need to define a Mail Template, which specifies the email content and layout.
Templates can be reused across multiple jobs, ensuring consistency in communication.

For detailed steps on creating templates, see Mail Template.

Creating a Communication Job

Follow these steps to create and configure a new communication job:

Steps

Go to Business Operations → Communications.
Click Create New.
Enter job details:
- Name — A unique identifier for the job.
- Description — (Optional) Internal notes about the job.
Configure the schedule:
- Select One-off or Repeatable.
- Set the Run at date and time.
- If Repeatable, define the recurrence pattern.
Define job configuration:
- Type — Select Email.
- Mail template — Choose a previously created mail template.
Set targeting criteria:
- Add rules (e.g., Customer type equals Partner).
- Combine multiple criteria to refine the audience.
Click Submit to save and activate the job.

Example Walkthrough

Create Mail Template
- Name: Payment Details Changed
- Subject: Our Payment Details Changed
- From: no-reply@yourcompany.com
- Body: Add a hero image, content columns, etc.
- Save the template.
Create Communication Job
- Name: Payment Details Changed notification
- Type: Email
- Mail template: Payment Details Changed
- Schedule: One-off → September 1st at 09:00
- Criteria: Customer type equals Partner
- Submit the job.

Troubleshooting & Validation

Emails not delivered? Verify SMTP settings and check SMTP logs along with job history logs in Monetization.
Placeholders not populated? Double-check placeholder syntax and confirm the fields exist in object data.

Job history

To access this section, click Job history. The job history shows a paginated list of executed jobs for each job in a tabular format from a specific period. It includes the date-time the job last ran, with the total number of errors and successes.

For each executed job, the Name refers to the name of the job; the Time shows when the job started and ended and the execution duration of the job; the Processed shows the number of successes and errors.

To see the full details of the error message for each failed job, as well as the successes, click Details.

Information:

You can filter the job history by date-time.

Usage

To access this section, click Usage. This section shows usage events that cannot be rated due to a rating or input field problem. Such events can be corrected and then re-rated.

Docs: Dunning

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select Business configuration, and click Dunning. Provide a name and description.

The Amount Due Threshold refers to the minimum amount on the bill before the dunning process can pick it up. This means that the bill due amount needs to be above the amount due threshold to be picked up.

Actions like applying penalty fees, sending payment reminders, and recollecting unpaid bills can be configured. To achieve this, under Actions, click Create new. Each action has a type. They include the following:

Fee
Notification
Recollect
Block

Fee

This means the customer will be charged a penalty fee for the unpaid bill. To configure, provide a name and description for the action.

In addition, choose the bundle. The bundle is configured to charge the customer a specific amount for failing to pay the bill at the appropriate time. Therefore, the action will purchase an add-on bundle on the customer’s subscription.

Notification

This will send a notification in the form of an email or SMS to the customer. For instance, a customer receives a payment reminder email if their bill has been overdue for three days.

For this configuration type, you are required to choose a mail or SMS template. The mail template is configured in Monetization under Business configuration Template Mail template.

Recollect

This will automatically try to recollect the payment for an unpaid bill. For this dunning process, a payment gateway integration has to be configured in Monetization. In addition, the customer must have included a credit card.

Block

This will send an API request to your third-party service control system, which would block the customer’s service because of unpaid bills.

Note:

For each dunning configuration action, the Overdue days means the action will only be triggered when a bill has been due for that number of days.

For instance, assume a bill was due on the 15th day of the month and has yet to be paid on the 20th day. On the 20th day, the bill will be overdue for five days. Therefore, the action will be executed if the Overdue days is configured to five days.

To delete each action for the dunning configurations, click Delete.

Docs: Salesforce

Mon, 01 Jan 0001 00:00:00 +0000

Salesforce Integration with Tridens Monetization

1. Overview

This document provides step-by-step instructions for integrating Tridens Monetization with Salesforce. The integration enables two-way and one-way synchronization of key business entities.

Supported Synchronization Flows:

Two-Way Sync
- Customers ↔ Accounts
- Contact Info ↔ Contacts
- Products ↔ Products
- Product Versions ↔ Price Book & Price Book Entry
- Subscriptions & Addons ↔ Subscriptions & Addons
One-Way Sync (Tridens to Salesforce)
- Invoices
- Usage
- Subscriptions & Addons → Opportunity

Diagram: Tridens Supported Synchronization with Salesforce

2. Prerequisites

Active Salesforce account with access permissions.
Active Tridens Monetization account with API credentials.
Salesforce Monetization Settings enabled.

3. Accessing Salesforce Dashboard

Log in to your Salesforce account.
Confirm you are on the Home Dashboard.

Screenshot: First Page

4. Creating Bundles in Salesforce

In the Salesforce navigation bar, go to:
Bundles > New Bundle
Fill in the required fields:
- Name: (Example: Mobile Silver Bundle)
- Code: (Example: mobile_silver_bundle)
- Valid From: Set the start date and time.
- Unlimited: Toggle ON if applicable.
Select Products to include in the bundle.

Screenshot: Bundle Creation Screen

Click Save to create the bundle.

5. Plan Configuration

In the Salesforce navigation bar, go to:
Plans > New Plan
Enter the required plan details and associate it with the previously created bundle.

Screenshot: Plan Creation Page

Click Save to complete the plan setup.

Note: Ensure each plan is correctly linked to the appropriate bundles and products for proper synchronization with Tridens.

Docs: Salesforce Integration

Mon, 01 Jan 0001 00:00:00 +0000

Salesforce Integration with Tridens Monetization

1. Overview

This document provides step-by-step instructions for integrating Tridens Monetization with Salesforce. The integration enables two-way and one-way synchronization of key business entities.

Supported Synchronization Flows:

Two-Way Sync
- Customers ↔ Accounts
- Contact Info ↔ Contacts
- Products ↔ Products
- Product Versions ↔ Price Book & Price Book Entry
- Subscriptions & Addons ↔ Subscriptions & Addons
One-Way Sync (Tridens to Salesforce)
- Invoices
- Usage
- Subscriptions & Addons → Opportunity

Diagram: Tridens Supported Synchronization with Salesforce

2. Prerequisites

Active Salesforce account with access permissions.
Active Tridens Monetization account with API credentials.
Salesforce Monetization Settings enabled.

3. Accessing Salesforce Dashboard

Log in to your Salesforce account.
Confirm you are on the Home Dashboard.

Screenshot: First Page

4. Creating Bundles in Salesforce

In the Salesforce navigation bar, go to:
Bundles > New Bundle
Fill in the required fields:
- Name: (Example: Mobile Silver Bundle)
- Code: (Example: mobile_silver_bundle)
- Valid From: Set the start date and time.
- Unlimited: Toggle ON if applicable.
Select Products to include in the bundle.

Screenshot: Bundle Creation Screen

Click Save to create the bundle.

5. Plan Configuration

In the Salesforce navigation bar, go to:
Plans > New Plan
Enter the required plan details and associate it with the previously created bundle.

Screenshot: Plan Creation Page

Click Save to complete the plan setup.

Note: Ensure each plan is correctly linked to the appropriate bundles and products for proper synchronization with Tridens.

Docs: Accounting

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Bills
- The bill status
Invoices
- Invoice details
- Offline invoice payment
Transactions

To access this section in Monetization, from the Menu, click Accounting.

Bills

To access this section, click Bills. A paginated list of all bills from a specific period is shown in a tabular format.

A bill represents all the customer charges accumulated during a billing cycle.

To generate the bills list in a spreadsheet, click CSV. To print, click Print, and to copy, click Copy.

Note:

They are generated, printed, and copied per paginated page.

Information:

You can filter for bills by bill ID, date-time, status, customer ID, billing profile ID, total amount, or/and due amount.

The Invoice amount refers to the total amount of the bill. The Due amount refers to the remaining amount yet to be paid by the customer.

Note:

The invoice for a bill is generated by a separate job known as the invoicing job. For more information, see Invoicing job.

The bill status

Under the bill section, a bill can have the following status:

Active — An active bill refers to the current bill. Once the billing cycle is over, the active bill goes into the billing status.
Billing — When the bill is in the billing status, it means the customer has not fully paid the bill.
Closed — When the bill is closed, it means the bill has been paid in full by the customer.

Invoices

To access this section, click Invoices. A paginated list of all invoices from a specific period is shown in a tabular format.

An invoice in Monetization is a representation of the bill object that is presented to the customer.

To generate the invoices list in a spreadsheet, click CSV. To print, click Print, and to copy, click Copy.

Note:

They are generated, printed, and copied per paginated page.

Information:

You can filter for invoices by date-time, invoice ID, invoice number, bill ID, status, customer ID, or/and billing profile ID.

The Invoice amount refers to the total amount of the bill. The Due amount refers to the remaining amount yet to be paid by the customer.

The Due date represents the last date-time the customer has to pay in full amount for the invoice.

Note:

A separate background job is responsible for generating the invoices. For more information, see Invoicing job.

Under the invoice section, a bill can have the following status:

Billing — When the bill is in the billing status, it means the customer has not fully paid the bill.
Closed — When the bill is closed, it means the bill has been paid in full by the customer.

Invoice details

To preview a particular invoice with a template, click Details. Once previewed, it can be saved as PDF, HTML, or JSON.

Note:

You can change from one template to another.

Information:

The template for an invoice is configured in Monetization under Business configuration Template Document templates. For more information, see Document templates.

Offline invoice payment

To manually enter the payment for a particular invoice, click Wallet. You can enter the payment manually here if you have already received the payment through another channel (like cash or wire transfer).

The amount can be configured to be a charge or a refund. In addition, choose the payment method: cash, credit card, and transfer.

Information:

The transfer payment method means a bank transaction.

The provider typifies the payment provider—for example, Stripe, Bank, Paypal, etc. You may also include a payment reference and a note.

Transactions

To access this section, click Transactions. A paginated list of all payment transactions from a specific period is shown in a tabular format.

To generate the payment transactions list in a spreadsheet, click CSV. To print, click Print, and to copy, click Copy.

Note:

They are generated, printed, and copied per paginated page.

Information:

You can filter for payment transactions by date-time, customer ID, billing profile ID, bill ID, transaction ID, method, type, status, or/and amount.

The payment transaction type can be a/an:

Charge - direct charge on a credit/debit card
Capture - The confirmation of an existing authorization
Authorization - authorization of funds (reserving money on a card)
Voidance - Cancellation of an authorization
Refund - Refund of a charge or capture

Docs: ERP Integrations

Mon, 01 Jan 0001 00:00:00 +0000

Quickbooks Online

QuickBooks Online is a cloud-based accounting software that provides businesses with a platform to manage their financial processes, including invoicing, billing, and expense tracking. Its platform also includes features such as bank reconciliation and financial reporting, enabling businesses to streamline their accounting operations.

Xero

Xero is a cloud-based accounting software that provides businesses with a platform to manage their financial processes. Its platform also includes features such as bank reconciliation, payroll management, and financial reporting.

Create a Xero App

Go to the Xero Developer Portal and log in with your Xero account.
Navigate to the My Apps section and click on New App.
Fill in the required details (App name, company or application URL, Redirect URL, etc.).
- For App name set Tridens Monetization
- For the Integration Type choose Web app
- For Company or application URL please set https://<your-subdomain>.tridenstechnology.com
- For Redirect URI please set https://app.tridenstechnology.com/monetizaton/gw-erp/auth-exchange?erp-provider=xero&tenant=<your-subdomain>

Please note that this is set for your production environment. If you would like to use Xero on your sandbox environment please create separate organization in Xero and go to Xero Developer Portal, My Apps > Select Tridens Monetization > Configuration and click on Add Another URI and set it as https://app.tridenstechnology.com/monetizaton/gw-erp/auth-exchange?erp-provider=xero&tenant=<your-sandbox-subdomain>

Figure: Xero developer portal

Netsuite

NetSuite is a cloud-based enterprise resource planning (ERP) software that provides businesses with a suite of tools to manage their financial, accounting, inventory, and order management processes.

Docs: Profitability

Mon, 01 Jan 0001 00:00:00 +0000

To access this section in Monetization, from the Menu, select Analytics, and click Profitability.

It shows a line graph representing the net profits by comparing revenue with different resources in Monetization. You can filter by resources, services, or/and customer types.

For instance, you can configure a cost resource, where you track how much expenses you have to offer services. The profitability chart then lets you compare the expenses with the total revenue to determine the profits.

Note:

The visual representation in the form of a line graph can be downloaded in various formats. To achieve this, click Chart context menu.

Docs: Template

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Document templates
Mail templates

To access this section in Monetization, from the Menu, select Business configuration, and click Template.

Document templates

To access this section, click Document templates. A paginated list of all document templates is shown in a tabular format.

A document template is used to configure the layout for the documents generated in Monetization for the invoice, dunning, and financial reports.

Information:

The template can include content like images or text.

Four actions/subpages can be performed/viewed under this section, namely:

Create a document template
Details document template page
Update document template
Delete document template

Create a document template

Under document templates, to create a document template, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

There are three categories for a document template, which are:

Dunning
Invoice
Financial

The category determines where the template can be used. For instance, exporting invoices can only use invoice templates, and exporting financial reports can only use financial templates.

In addition, configure the title and body for the template.

Note:

The title represents how the template would be referenced in other parts/sections of Monetization.

Information:

Monetization provides a rich editor to customize the template body, as shown below.

Note: You can also import your template.

Figure 1: Document template body

Details document template page

Under document templates, to see the full details of a document template, click Details. It contains the following:

Name
Code
Category
Language
Title
Content

Update document template

Under document templates to update a document template, first, click Details; it shows the details of the document template. Then to update, click Update.

Information:

All information filled out under the create a document template section can be updated except for the Code.

Delete document template

Under document templates, to delete a document template, click Delete.

Mail templates

To access this section, click Mail templates. A paginated list of all mail templates is shown in a tabular format.

A mail template is used to configure the layout for the mails generated in Monetization for the invoice, dunning, and financial reports.

Information:

The template can include content like images or text.

Four actions/subpages can be performed/viewed under this section, namely:

Create a mail template
Details mail template page
Update mail template
Delete mail template

Create a mail template

Under mail templates, to create a mail template, click Create new. Provide a name, code, and description.

Note:

The code is a unique identifier of an object. It can be used during integration with the Monetization API.

There are three categories for a mail template, which are:

Dunning
Invoice
Financial

The category determines where the template can be used. For instance, sending mail for an invoice will use the invoice template.

Additional configurable parameters for the mail template include the following:

subject
from address
to
Cc
Bcc
reply to

Information:

The from address represents the sender address, while the to represents the receiver address.

Note: Dynamic placeholder can be used for the subject. It is used to get the customer’s information or other data—for example, first name.

In addition, configure the body for the template.

Information:

Monetization provides a rich editor to customize the template body, as shown below.

Note: You can also import your template.

Figure 2: Mail template body

To include attachments to the mail, under Attachments, click Add. Provide the name, type, format, and template.

Information:

To enable compression on an attachment, check the checkbox Compression.

Details mail template page

Under mail templates, to see the full details of a mail template, click Details. It contains the following:

Name
Code
Description
Category
Subject
Publishing type
From address
To
Cc
Bcc
Reply to
Attachments
Content (if any)

Update mail template

Under mail templates to update a mail template, first, click Details; it shows the details of the mail template. Then to update, click Update.

Information:

All information filled out under the create a mail template section can be updated except for the Code.

Delete mail template

Under mail templates, to delete a mail template, click Delete.

Docs: Automation

Mon, 01 Jan 0001 00:00:00 +0000

Zapier

Zapier is a web-based automation tool that enables businesses to connect various applications and automate repetitive tasks without coding or technical skills. Its platform offers a wide range of integrations with various web-based applications, such as Gmail, Slack, and Trello, among others.

Docs: Data Warehouses

Mon, 01 Jan 0001 00:00:00 +0000

The Tridens Monetization Data Warehouse Integration feature allows you to seamlessly export your subscription, billing, usage, and revenue data from Tridens to your preferred analytics platforms. This guide provides a clear roadmap for setting up and managing this integration, focusing on scalability for high-volume usage-based billing in industries like telecom, energy, and electric vehicles.

Topics on this Document

Introduction & Overview
Architecture & Components
Supported Data Sources & Targets
- 3.1 Tridens Data Sources
- 3.2 Target Data Warehouses
Data Modeling & Schema Mapping
- 4.1 Definition of Objects/Tables Exposed
- 4.2 Data Types Supported and Conversion Logic
Data Sync Modes & Strategies
Security, Authentication & Credentials
- 6.1 Credentials, Storage, Rotation
Permissions & Encryption
- 7.1 Permissions Required in Target Warehouse
- 7.2 Encryption in Transit SSL, TLS, Certificate Trust
Usage / Configuration Guide
- 8.1 Step by Step Setup for Datawarehouses
Limitations, Caveats, and Best Practices

1. Introduction & Overview

1.1 Purpose and Use Cases

The Tridens Monetization Data Warehouse Integration automates the extraction, transformation, and loading (ETL) of operational data from Tridens Monetization into customer-owned data warehouses. This enables advanced analytics, BI reporting, and machine learning workflows outside the native Tridens analytics module.

Key Use Cases:

Revenue Analytics: Sync subscription metrics (e.g., MRR, churn rates) for cohort analysis in SaaS or media companies.
Usage Pattern Insights: Load real-time IoT meter data (e.g., energy consumption) into PostgreSQL for predictive billing in utilities.
Compliance Reporting: Export audited billing records to MS SQL for IFRS15/ASC 606 reconciliation.
Custom Integrations: Feed anonymized usage events into dashboards via generic JDBC.

Data warehouse integration reduces manual exports (like CSV/API dumps), minimizes analytics latency, and supports schema evolution without downtime—critical for dynamic pricing models.

1.2 Supported Platforms

Supports direct connectors to the following targets, leveraging Tridens RESTful APIs and JDBC/ODBC standards:

Platform	Integration Type	Supported Deployments
Snowflake	Native connector via Snowpipe for staged loads	Account & warehouse-level
PostgreSQL	JDBC	On-prem, AWS RDS, GCP SQL
Microsoft SQL Server (MS SQL)	JDBC	Azure SQL, On-prem, Always Encrypted
MySQL	JDBC	AWS Aurora, GCP SQL, Self-hosted
Generic JDBC	Custom driver	Any JDBC-compliant data warehouse (e.g., BigQuery, Redshift)

1.3 Key Features

Incremental Syncs: Low-latency updates.
Schema Evolution: Handles field additions/removals automatically.
Scalability: Serverless execution, 1M+ events/day.

2. Architecture & Components

2.1 High-Level Architecture

The Data Warehouse Integration follows a modular ETL pipeline design:

Source (Tridens Monetization) → Integration Engine → Target Data Warehouse

This architecture ensures scalability, resilience, and low-latency data movement across Tridens services and supported data warehouses.

Architecture Overview

Source: Tridens Monetization microservices expose REST APIs and event logs for data extraction.
Integration Engine: The ETL process runs on AWS Lambda or Kubernetes Pods to extract, transform, and load data efficiently.
Target: Data warehouses like Snowflake, PostgreSQL, or MS SQL store structured analytics-ready data.

Architecture Diagram

2.2 Data Flow

Extract: Pull data from Tridens APIs.
Transform: Apply in-memory mappings to target data warehouse objects.
Load: Bulk upsert to target data warehouse with transaction boundaries.

2.3 Components/Modules Involved

Extractor: Tridens Monetization notifications.
Loader: Java-based JDBC handler using bulk operations.
Transformation Engine: Transforms DTOs to data warehouse compatible objects.

2.4 Data Flow / Pipeline Steps

Initialization: Validate config, acquire locks.
Extract: Fetch data from DTO and prepare for data warehouse structure.
Transform: Apply anonymization rules.
Validate: Schema and row-level checks.
Load: Transactional insert/update.
Commit: Update metadata and emit metrics.

3. Supported Data Sources & Targets

3.1 Tridens Data Sources

Extracts from core Tridens entities via REST APIs:

Entity	Description
Subscriptions	Plans, amendments, status
Usage Records	Metered events (e.g., calls, sms, data usage, energy)
Billing/Invoices	Charges, payments
Customers/Accounts	Hierarchies, balances

API Reference: Tridens API Documentation

3.2 Target Data Warehouses

Target	Min Version	Driver
Snowflake	N/A	Snowflake JDBC 3.13+
PostgreSQL	12	pgJDBC 42.5+
MS SQL	2019	MS JDBC 12.4+
MySQL	8.0	Connector/J 8.1+
Generic JDBC	N/A	Custom

4. Data Modeling & Schema Mapping

4.1 Definition of Objects / Tables Exposed

Tridens exposes over 17 core data tables.

Primary Tables:

Subscriptions
Balances
Events
Bills
Invoices
Payments
Customers
…

5. Data Sync Modes & Strategies

5.1 Data Frequency

Tridens Monetization provides real-time data delivery, leveraging event-driven architecture and change data capture (CDC) for near-instant updates.

Mechanism:

Notifications ensure sub-second latency.
Ideal for use cases such as:
- Real-time billing adjustments
- Fraud detection
- Instant customer insights

5.2 Handling Deletes, Updates, Inserts

Operation	Strategy
Inserts	New rows created with unique primary keys.
Updates	Performed via `MERGE` or `UPSERT` on primary key columns.
Deletes	Handled as soft deletes, depending on target warehouse support.

6. Security, Authentication & Credentials

6.1 Credentials Storage, Rotation, and Encryption

Security Mechanism	Description
Storage	Credentials stored on Tridens Monetization (encrypted)
Encryption	All payloads encrypted with AES-256 during transit and at rest.

7. Permissions

Minimal Access Required:

CREATE TABLE on schema
INSERT, UPDATE, DELETE on target tables

Role-Based Example:

GRANT USAGE ON DATABASE analytics_db TO ROLE tridens_role;
GRANT CREATE SCHEMA ON DATABASE analytics_db TO ROLE tridens_role;

8. Usage / Configuration Guide

8.1 Step-by-Step Setup for Data Warehouse

Navigate to System Configuration → Data Warehouse Integration.
Select your warehouse type (e.g., Snowflake).
Enter your JDBC/ODBC credentials and test the connection.
Save configuration.

Docs: Hosted Payment Page

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Configuring Hosted Payment Page
Set Up Checkout Page
- Configure Redirect URL
- Configure Legal Information

Configuring Hosted Payment Page

The Hosted Payment Page make online transactions a breeze for your customers. Designed for ease and security, it’s the perfect checkout solution for your business. Upon subscription or selecting Checkout, your users will be redirected to new URL dedicated to reviewing their order and inputting their payment details.

To access this section in Monetization, from the Menu, select Business configuration, and click Hosted Payment Page.

Set Up Hosted Payment Page

The Hosted Payment Page can be created via accessing the hosted page URL where a user can choose from different plans or checkout from pre-selected plan.

Additionally, you have the option to set up a redirect URL, and any necessary legal information for the users.

Configure Redirect URL

When using hosted pages, configure redirect URL where users will be redirected upon successful checkout.

Configure Legal Information

Legal Information specifies the Privacy Policy and Terms of Service for the subscription and checkout. Provide URL for this information.

Docs: Users

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Create a user
Details user page
Update user

To access this section in Monetization, from the Menu, click User management, and click Users. A paginated list of all users is shown in a tabular format.

Information:

You can filter users by first name, last name, email address, role, or/and status.

To generate the users’ information in a spreadsheet, click CSV. To print, click Print, and to copy, click Copy.

Note:

They are generated, printed, or copied per paginated page.

Three actions/subpages can be performed/viewed under this section, namely:

Create a user
Details user page
Update user

Create a user

Under users, to create a user, click Create new. Provide a first name, last name, email address, and password.

Specific roles can be assigned to a user. The role determines what the user can access in Monetization. They are as follows:

User role	Functionalities
Customer portal	Self-care portal only
Marketing analyst	Dashboard, Analytics
Business process analyst	Dashboard, Catalog [ Event generators ], Business configuration
Pricing analyst	Dashboard, Catalog [ Packages, Products, Discounts ]
Operations staff	Dashboard, Business operations, SFTP Access
Customer service	Dashboard, Customers
Financial analyst	Dashboard, Analytics, Business configuration [ Finance ], Accounting
System Administrator	Dashboard, System configuration, User management [ Users ]
Power	Everything apart from the self-care portal

Note:

Any role selected other than the power user must include a list of sites the user can access. A power user can access all created sites in Monetization.

Use the SFTP toggle switch to enable/disable SFTP access for the user in Monetization. By enabling SFTP, provide a username and password. Then, the user can Log In with the details to the Monetization SFTP location.

Information:

From the Monetization SFTP location, the user can download any file that has been exported. These can include various payment, invoice exports, usage details exports, direct debit files, and processed usage files.

Note: If the user is a power user and has SFTP enabled, the user will have access to all the data in the Monetization SFTP location for all sites. However, if the user is limited to a single site, then only that site’s data is accessible.

To activate/deactivate the user, use the Enabled toggle switch.

Details user page

Under users, to see the full details of a user, click Details. It contains the following information:

ID
First name
Last name
Email address
Roles
Sites
SFTP username
Status

Update user

Under users, to update a user, first, click Details; it shows the details of the user. Then to update, click Update.

Docs: Sites

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Sites in Monetization
Create a site

To access this section in Monetization, from the Menu, at the bottom left corner, select the name of the current site; it shows all the available sites, then click VIEW SITES. A paginated list of all sites is shown in a tabular format.

Sites in Monetization

Multiple sites can be created in Monetization to separate your business into different markets. For instance, you can have a site for the US market and another for the European market. Then, these two sites can have their specific customers, invoices, and analytics.

Furthermore, having a separate site can allow for different product catalogs for each site based on the market.

Note:

Each site is intended to have a single monetary currency. Therefore, if there is the need to use another currency, create a brand new site.

Create a site

Under sites, to create a site, click Create new. There are three sections, namely:

Site information
Environment setup
Summary

Site information

Under the site information section, provide a site name and the necessary company details. The details include the following information:

Email address
Organization
Address
Phone number
Country
State
City
Zip code

Environment setup

Under the environment setup section, configure the environment for the site with the following settings:

URL — registers a domain in the background for the site.
UI Language — language that reflects on the user interface in Monetization.
System Language — language configured internally for Monetization.
Time zone
Currency
Environment — sandbox (test) environment or production environment.
Invoice due delay — depicts how many days it takes for the invoice to be due.
Show details on the invoice — depicts whether Monetization should keep track of all the usage events and history, which can be shown on the invoice by configuring the template.
Customer portal enabled? — If the customer portal is enabled, the self-care portal is enabled for that site. If the customer portal is enabled and the mailing server is configured, after onboarding a customer and creating user information, the customer receives login details to the self-care portal where they can see their account details.
SMTP — Mailing server configuration settings. Provide the following information for the server configuration set up:
- From — SMTP server email address
- Username — SMTP server username
- Password — Password for the username
- Host — SMTP server host name
- Port — SMTP server port number
- Tls — Used to set secure connection or not. Enable it if you are using a secure connection. After filling in these details, use the Test SMTP connection button to verify email delivery.
Figure 1: SMTP set up

Hint:

Here is how to set up in-app-password for Microsoft and Gmail providers.

Summary

This section allows you to review what was configured in the previous sections.

Note:

Once a new site is created, Log Out and Log In for the new site to be reflected in Monetization.

Docs: FAQs

Mon, 01 Jan 0001 00:00:00 +0000

Where can I create new Plans?

In Monetization, Plans are created under Catalog Packages Plans

What steps do I take to set up a new monthly Plan?

You need to create a monthly Product with the following configuration: Type: Subscription, Event type: Monthly. Then, create a Bundle with that Product, then create a Plan containing that Bundle.

What is the difference between forward and arrear products?

Forward products are charged immediately, while arrear products apply at billing time.

Can I create one-time charges with Tridens Monetization?

Yes. Tridens Monetization supports both recurring and one-time products, as well as the ability to issue immediate one-time bills.

What are charge tags and resource tags used for?

The charge and resource tags are used in Discount Rule Filters for targeting specific charges with discounts.

What currencies does Tridens Monetization support?

Tridens Monetization can support any currency.

Does Tridens Monetization support multiple currencies on a single site?

Yes, users can use multiple currencies on a single site and specify which currency a customer Billing Profile will use.

How can I automate billing?

Create a Billing Job under Business Operations and assign the schedule based on your requirements. We also recommend creating a chainable Invoicing job and chaining it to the Billing Job.

What is a payment gateway?

A payment gateway is a service that facilitates online transactions by securely authorizing and processing credit cards or other electronic payments between a customer and a merchant.

What is a merchant account?

A merchant account for a payment gateway allows a business to accept payments through credit cards and other electronic payment methods.

Do I need to set up a merchant account to use Payment Gateway Integrations support in Tridens Monetization?

Yes. For example, you need a Stripe account to use Stripe with Tridens Monetization.

Does Tridens Monetization support payment processing via SEPA Direct Debit?

Yes. With Tridens Monetization, you can export a SEPA DD XML file, then import the result file.

Does Tridens Monetization support custom payment gateway integrations?

Yes. Tridens Monetization has REST APIs in place that allow for a very easy integration with any payment processing solution.

Am I always using the latest version of the product?

Yes. Tridens Monetization is a cloud-based platform, and all of our clients receive new rollouts at once.

How does Tridens Monetization manage release cycles?

We follow a pattern of bi-weekly releases for minor changes and fixes, and we have a quarterly based roadmap for new features.

Docs: Custom Payment Integration

Mon, 01 Jan 0001 00:00:00 +0000

Topic in this document:

Third-Party payment processing in Monetization
Asynchronous payment processing
- Exporting invoices
  - Exporting job – CSV file to SFTP
  - Notification - webhook method
- Importing payments
  - CSV file import via SFTP
  - Import via API call
    - Authentication
    - Payment import request
Synchronous payment processing

Third-party payment processing in Monetization

Third-party payment processing is achievable through two methods, synchronous and asynchronous. The synchronous method requires immediate responses from your payment integration component, while the asynchronous method combines extracting invoices from Monetization, then importing the payments at a later time.

Information:

Typically, your use case determines which processing method is optimal.

Asynchronous payment processing

For asynchronous payment processing, you export invoices from Monetization, and payments are processed outside of Monetization entirely. When you have payment processing results, you import them via CSV files or the Monetization API.

Exporting invoices

You can export invoices from Monetization by configuring an invoice export mapper and scheduling an exporting job, which will export the files to an SFTP location, or by subscribing to an invoice creation via Webhook, which will trigger an invoice request to the provided URL address whenever a new invoice is created.

Exporting job – CSV file to SFTP

To export invoices as CSV files, an Invoice Export mapper needs to be configured to map invoice parameters to CSV file columns. Monetization User Interface allows such configuration under Business configuration Export Invoice mappers.

Figure 1: Example of invoice export mapper configuration

Invoice exports are scheduled through Exporting Jobs, which can be one-off tasks or automated to run for specific periods. The Exporting Job will save the exported CSV file to the respective SFTP location storage/invoice/folder_name/file_name.csv.

Figure 2: Example of invoice export job

Notification - webhook method

Exporting invoices through webhooks allows you to receive invoices immediately upon creation. This is achieved by configuring an Invoice Notification Rule, which will send every created invoice as a JSON body request to the provided URL address, along with any pre-configured header options.

Figure 3: Example of invoice creation webhook configuration

Importing payments

You can import payment transactions to Monetization by configuring a payment import mapper and uploading the payment CSV files to the SFTP input location or by utilizing Monetizations REST API.

CSV file import via SFTP

For Monetization to import payment transactions via CSV files, there has to be a Payment Import Mapper configured. The configuration is possible through the Monetization User Interface under Business configuration Import Payment mappers.

The Payment mapper allows for the mapping of CSV columns to payment transaction parameters and the definition of a file prefix, which needs to be present in the uploaded files.

Files are uploaded on the SFTP server in folder edl/input and will be moved to edl/processed, edl/successful, edl/error, and edl/rejected folder depending on processing results.

Figure 4: Example of payment import mapper configuration

Import via API call

To import a payment transaction via the Monetization API, post a JSON request containing transaction details to the Monetization REST API.

Note:

A user must first be authenticated to communicate with the Monetization API.

Authentication

Monetization API uses Bearer Token authentication:

Execute the Authentication request with username, password, and specific site code.
Harvest the token from the response.
Set the Authorization header to Bearer <token> in the upcoming requests.
The token expires after 5 minutes.

URL: {{api_url}}/authenticate

Headers
Content-Type:application/json

Body
{
 "username": "your_monetization_username",
 "password": "password",
 "site_code": "your_monetization_site_code - subdomain"
}

Payment import request

URL: {{api_url}}/api/v1/import

Headers
Content-Type:application/json
Authorization:Bearer {{auth_token}}
Data-Type:Payment

Body
{
 "invoice_id": 123,
 "transaction_identifier": "T-1233-cew3-445f-feew3",
 "amount": 150,
 "transaction_time": 1600613169000,
 "currency": "EUR",
 "method": "other",
 "type": "charge",
 "provider": "stripe"
}

Synchronous payment processing

Synchronous payment processing requires synchronous communication between Monetization and your payment integration component. This processing method enables credit/debit card authorizations and immediate payments.

You configure Monetization to specify where the payment processing related requests should be sent, and Monetization has predefined responses which it expects in return. This processing method enables the storage of payment method references on the customers and supports automated payment collection processes.

For Monetization, the integration process is virtually the same as an out-of-the-box integration with an existing provider (Stripe, Braintree, etc.). However, the communication is executed through a component developed by you, which acts as a gateway to your local payment provider.

Essential operations to support Synchronous payment processing:

Setup Intent
Authorize
Capture
Charge

Third-party payment provider setup

To set up a third-party payment provider integration, configure a third-party payment gateway profile and provide the URL where Monetization should send requests.

This is achievable over the UI under System configuration Payment gateways, or by creating a Payment Gateway Profile via the Monetization REST API.

URL: {{api_url}}/api/v1/payment-gateway-profiles

Headers
Content-Type:application/json
Authorization:Bearer {{auth_token}}

Request
{
 "provider": "third-party",
 "headers": {
 "PGW_URL": "URL to your payment gateway"
 }
}

Customer operations

Customer operations only apply in cases where the third-party payment provider supports customer management. If the payment provider does not support customer management, then the customer ids can be replaced with any value (e.g., Unix timestamp of request).

Create customer (without card)

Creates a customer as an object on the payment provider service.

Request sent by Monetization:

{
 "action": "create_customer",
 "content": {
 "customer": {
 "first_name": "John",
 "last_name": "Anderson",
 "company": "Company",
 "email": "john_anderson@testmail123.com",
 "phone": "003861234335",
 "tax_identifier": "123543569596"
 },
 "billing_address": {
 "first_name": "John",
 "last_name": "Anderson",
 "company": "Company",
 "street_address": "Address street 12",
 "locality": "Name of City",
 "postal_code": "84116",
 "region": "Region",
 "country_code": "SI",
 "country_name": "Slovenia "
 }
 }
}

Expected response:

HTTP Status: 201 Created

{
 "customer": {
 "id": "payment_provider_customer_id"
 }
}

Update customer

Updates a customer object on the payment provider service.

Request sent by Monetization:

{
 "action": "update_customer",
 "content": {
 "customer": {
 "id": "payment_provider_customer_id_1",
 "first_name": "John",
 "last_name": "Anderson",
 "company": "Company",
 "email": "john_anderson@testmail123.com",
 "phone": "003861234335",
 "tax_identifier": "123543569596"
 },
 "billing_address": {
 "first_name": "John",
 "last_name": "Anderson",
 "company": "Company",
 "street_address": "Address street 12",
 "locality": "Name of City",
 "postal_code": "84116",
 "region": "Region",
 "country_code": "SI",
 "country_name": "Slovenia "
 }
 }
}

Expected response:

HTTP Status: 204 No Content

No Response Body

Read customer

Reads a customer object from the payment provider service.

{
 "action": "read_customer",
 "content": {
 "id": "payment_provider_customer_id_1"
 }
}

Expected response:

HTPP Status: 200 OK

{
 "content": {
 "customer": {
 "id": "payment_provider_customer_id_1",
 "first_name": "John",
 "last_name": "Anderson",
 "company": "Company",
 "email": "john_anderson@testmail123.com",
 "phone": "003861234335",
 "tax_identifier": "123543569596"
 },
 "billing_address": {
 "first_name": "John",
 "last_name": "Anderson",
 "company": "Company",
 "street_address": "Address street 12",
 "locality": "Name of City",
 "postal_code": "84116",
 "region": "Region",
 "country_code": "SI",
 "country_name": "Slovenia "
 },
 "credit_cards": [
 {
 "is_default": true,
 "card_holder_name": "John Anderson",
 "expiration_month": "03",
 "expiration_year": "2026",
 "type": "Mastercard",
 "token": "payment_provider_card_token",
 "last_four": "1234"
 }
 ]
 }
}

Delete customer

Deletes a customer object from the payment provider service.

Request sent by Monetization:

{
 "action": "delete_customer",
 "content": {
 "id": "payment_provider_customer_id_1"
 }
}

Expected response:

HTTP Status: 204 No Content

No Response Body

Card operations

Card operations refer to setting up or removing credit and debit cards.

Setup (setup card request)

Triggers a process where a customer can provide credit card details, which are tokenized and stored in Monetization. Upon a request to add a new credit card, Monetization will send a setup request to your integration component.

Your integration component needs to handle any logic related to the payment provider services and return a redirect URL to Monetization as a response. The customer will then be redirected to the provided URL, where your payment provider hosted form will collect and tokenize the customer’s card details.

Figure 5: Credit card setup

Request sent by Monetization:

{
 "action": "setup",
 "content": {
 "customer": {
 "id": "payment_provider_customer_id_1",
 "first_name": "John",
 "last_name": "Anderson",
 "company": "Company",
 "email": "john_anderson@testmail123.com",
 "phone": "003861234335",
 "tax_identifier": "123543569596"
 },
 "billing_address": {
 "first_name": "John",
 "last_name": "Anderson",
 "company": "Company",
 "street_address": "Address street 12",
 "locality": "Name of City",
 "postal_code": "84116",
 "region": "Region",
 "country_code": "SI",
 "country_name": "Slovenia "
 },
 "custom_attributes": {
 "intent": "CAPTURE",
 "amount": 1,
 "currency": "USD",
 "successUrl": "evcharge://app/account/payment-setup",
 "cancelUrl": "evcharge://app/account/payment-setup",
 "callbackUrl": "evcharge://app/account/payment-setup"
 }
 }
}

Expected response:

HTTP Status: 201 Created

{
 "customer": {
 "id": "payment_provider_customer_id"
 },
 "redirect_url": "https://card-data-collection-form.com"
}

Delete card

Sends a request to your integration component to handle credit card reference removal logic via the payment provider services, then removes the reference from Monetization upon success.

Request sent by Monetization:

{
 "action": "delete_credit_card",
 "content": {
 "customer": {
 "id": "provider_customer_id_34"
 },
 "credit_card": {
 "token": "provider_card_token_x23423532"
 }
 }
}

Expected response:

HTTP Status: 204 No Content

No Response Body

Transaction operations

Transaction operations refer to transactional actions executed on stored payment method (credit/debit card) tokens. These actions include:

Authorization
Capture
Charge
Void
Refund

Authorization

Authorization is used to authorize (lock) funds on a customer’s payment method. Authorizations can later be Captured or Voided. The request below is sent to your integration component, which should handle payment provider service logic and return a response.

Request sent by Monetization:

{
 "action": "authorize",
 "content": {
 "amount": 20.5,
 "currency": "EUR",
 "customer": {
 "id": "provider_customer_id_34"
 },
 "credit_card": {
 "token": "provider_card_token_x23423532"
 }
 }
}

Expected response:

HTTP Status: 202 Accepted

{
 "transaction_id": "payment_provider_transaction_id",
 "amount": 25.5,
 "currency": "EUR",
 "time": "1650629967000",
 "success": true,
 "message": "Message from provider if given",
 "code": "Code from provider if given"
}

Capture

Capture refers to the collection of authorized funds from a previous Authorization request. The amount to collect can be equal to or lower than the authorized amount.

Any uncollected authorized funds will be released back to the customer by the payment provider service. The below request is sent to your integration component, which should handle payment provider service logic and return a response.

Request sent by Monetization:

{
 "action": "capture",
 "content": {
 "transaction_id": "provider_transaction_id_t2134234",
 "amount": 10.5
 }
}

Expected response:

HTTP Status: 202 Accepted

{
 "transaction_id": "payment_provider_transaction_id",
 "amount": 10.5,
 "currency": "EUR",
 "time": "1650629967000",
 "success": true,
 "message": "Message from provider if given",
 "code": "Code from provider if given"
}

Charge

Charge authorizes and captures funds as a single immediate transaction. The below request is sent to your integration component, which should handle payment provider service logic and return a response.

Request sent by Monetization:

{
 "action": "charge",
 "content": {
 "amount": 25.5,
 "currency": "EUR",
 "customer": {
 "id": "provider_customer_id_34"
 },
 "credit_card": {
 "token": "provider_card_token_x23423532"
 }
 }
}

Expected response:

HTTP Status: 202 Accepted

{
 "transaction_id": "payment_provider_transaction_id",
 "amount": 25.5,
 "currency": "EUR",
 "time": "1650629967000",
 "success": true,
 "message": "Message from provider if given",
 "code": "Code from provider if given"
}

Void

Void operation voids an Authorization transaction, releasing the authorized funds. The below request is sent to your integration component, which should handle payment provider service logic and return a response.

Request sent by Monetization:

{
 "action": "void",
 "content": {
 "transaction_id": "provider_transaction_id_t2134234"
 }
}

Expected response:

HTTP Status: 202 Accepted

{
 "transaction_id": "payment_provider_transaction_id",
 "time": "1650629967000",
 "success": true,
 "message": "Message from provider if given",
 "code": "Code from provider if given"
}

Refund

Refund returns funds to the customer and references a previous Charge or Capture transaction. The below request is sent to your integration component, which should handle payment provider service logic and return a response.

Request sent by Monetization:

{
 "action": "refund",
 "content": {
 "transaction_id": "provider_transaction_id_t2134234",
 "amount": 10.5
 }
}

Expected response:

HTTP Status: 202 Accepted

{
 "transaction_id": "payment_provider_transaction_id",
 "amount": 25.5,
 "currency": "EUR",
 "time": "1650629967000",
 "success": true,
 "message": "Message from provider if given",
 "code": "Code from provider if given"
}

Error handling

In case an operation is not successful on your integration component, return any status outside of 200-300 range and the error message in the response body.

Docs: Devices

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

Devices
Scheduled Job Operations for Device Management

Devices

Devices provide the use of customer services. Each device has a lifecycle where it transitions between states. A device type is custom and specifies its physical type (sim card, modem, phone number, RFID, NFC, etc.).

Each device has several descriptors, which hold information about its model, vendor, brand. MAC address and other identifiers can be stored in an external system and related to a device with the external service identifier.

A device is typically created with a batch of other devices sharing the same type, optionally vendor, model and brand. The device identifier has to be unique to each device. Device codes are also unique. Unique values can be generated through a template for the whole device group. Devices can be assigned to services.

When a Device is no longer active, it moves to a proper state – e.g., mobile numbers can go into quarantine and be reused, while other devices can become permanently unusable.

Device Type

Navigate to Devices on the left side menu. Select the Device Type tab to define and manage different types of devices.

Batches

Navigate to Devices on the left side menu. Select the Batches tab and follow the wizard by which you can generate the batch of devices for the selected device type by the following rules definition:

Quantity of new devices.
Code format template (alphanumeric/numeric) with randomized values or incremental values.
Device identifier format template (alphanumeric/numeric) with randomized values or incremental values.

Devices

To manually add the Device, navigate to Devices on the left side menu. Select the Devices tab on the top and follow the wizard by providing the Device name, unique alphanumeric code identifier, parent Device Type and unique device identifier.

Assigning Device to the Customer’s Service

The service identifier is populated to reflect one of the device identifiers tied to that service. Can be setup at subscription creation or by modifying the existing subscription’s service and applying the device reference. Refer to Subscription’s Service.

Device’s Status Transitions

Table: Allowed device status transitions

Device Status	Description	Allowed Transition to new Device Status
NEW	Device is waiting to be assigned to the customer’s subscription service.	ASSIGNED
ASSIGNED	Device is currently tied to customer’s subscription service.	UNASSIGNED, QUARANTINED
UNASSIGNED	Device is not tied to any customer’s subscription service.	ASSIGNED, QUARANTINED
QUARANTINED	Device cannot be used tied to any customer’s subscription service, until in quarantine.	UNASSIGNED, CLOSED
CLOSED	Device is permanently unusable, meaning it is lost, destroyed or out of order indefinitely.	/

Device History

Device history represents the historical event which happened to the device: Customer change, status change, service change.

Scheduled Job Operations for Device Management

Manageable in the Operations section.

Job to Release Quarantined Devices

Quarantined devices will change their status to Unassigned or Inactive, depending on state transition definitions. A scheduled task will periodically check for devices to be put out of quarantine.

Configurable filters for the job execution:

Time period: Quarantine period length in seconds after which the device is allowed to be transitioned for new assigning.
Device id: To limit the job to apply only to the specific set of devices.
Device type: To limit the job to apply only to the specific type of devices.

Job to Delete Closed Devices

Devices may end up in the CLOSED state, meaning they are lost, destroyed or out of order indefinitely. To save up space and avoid unnecessary data, a scheduled task should delete such devices after a specified period of time.

Configurable filters for the job execution:

Time period: Period length in seconds since the device was closed and is allowed to be deleted.
Device id: To limit the job to apply only to the specific set of devices.
Device type: To limit the job to apply only to the specific type of devices.

Docs: Activity Log

Mon, 01 Jan 0001 00:00:00 +0000

The Activity Log is a powerful security and auditing tool that provides a detailed, chronological record of actions performed on key business objects within the system. It is designed to give you a clear understanding of data workflows, enhance security by tracking user activity, and simplify troubleshooting.

By tracking who did what and when, you can maintain a complete and immutable audit trail for compliance, operational management, and internal controls.

Key Use Cases and Benefits

The Activity Log is more than just a record of events; it’s a critical tool for maintaining data integrity and security. Here are some practical ways you can use it:

Accelerate Troubleshooting: When a customer reports an unexpected change to their subscription or an invoice appears incorrect, the Activity Log is your first place to look. You can filter the log by the specific Customer or Subscription ID to see a full history of changes, pinpointing exactly who made the change, what was altered, and when.
Strengthen Security and Compliance: For financial audits (like SOX compliance), you must demonstrate control over who can modify sensitive information. The Activity Log provides an immutable record of all changes to critical objects like Products, Plans, and Invoices. You can easily export this data to prove that your internal controls are working effectively.
Monitor User Activity: Keep an eye on actions performed by specific users, especially those with high-level permissions. This helps ensure that all actions are authorized and aligns with company policies.

Scope of the Activity Log

The Activity Log is designed to be comprehensive, but it’s important to understand what is and isn’t tracked.

What is Logged?

The log captures significant business events, primarily focusing on Create, Read, Update, and Delete (CRUD) actions for key business objects that you configure. This includes:

Changes made by users through the GUI.
Changes made via API calls.
Significant system events (e.g., plan transitions).

What is Not Logged?

The Activity Log does not track:

Every single API call, especially those that only read data without making changes (unless Read is explicitly configured for tracking).
Internal system processes that do not directly relate to a change in a business object.

Configuring the Activity Log

You have full control over which actions are tracked for specific business objects. This allows you to focus on logging the most critical data for your business needs. The configuration is managed in the Business Configuration section.

How to Add a New Log Configuration

Navigate to Business Configuration > Activity log from the main menu.
Click the + Activity log button in the top-right corner.
In the Add activity log dialog:
- Type: Select the category of the object. In most cases, this will be Entity.
- Target: Choose the specific business object to monitor (e.g., Customer, Subscription, Plan).
- Actions: Select the actions you want to log (Create, Read, Update, Delete).
Click Submit to save the configuration. The system will immediately begin logging the actions you specified.

Best Practices for Configuration

Be Specific: Avoid logging everything. Focus on the objects and actions that are most critical for your security, compliance, and operational needs. Logging Update and Delete actions on financial objects is a great starting point.
Avoid Excessive Read Logging: Tracking Read actions can generate a very high volume of data and may slow down system performance. Only enable this if you have a specific security requirement to monitor who is viewing sensitive data.
Regularly Review: Periodically review your log configurations to ensure they are still aligned with your business needs.

Viewing and Investigating Logs

Once configured, the system generates log entries that you can view, filter, and export.

How to View and Filter Logs

Navigate to the log viewer screen (e.g., Users > Activity Logs).
You will see a list of all captured events, sorted by date.
Use the powerful filtering options to investigate specific events:
- Date Range: Narrow your search to a specific time period.
- Target Object and ID: Filter for a specific object (e.g., Customer) and even a specific instance (e.g., Customer ID).
- User: See all actions performed by a specific user.
- Action Type: Isolate all Create or Delete actions.

Understanding the Log Data

Each log entry contains detailed information to help you understand the event:

Column	Description
`Created on`	The exact date and time the action occurred.
`IP Address`	The IP Address of user who performed the action.
`User`	The user who performed the action. This may show “System” for automated processes.
`Target`	The type of business object that was affected (e.g., `Subscription`).
`Target ID`	The unique identifier of the specific object that was changed.
`Action`	The action performed (`CREATE`, `UPDATE`, `DELETE`).
`Details`	A human-readable summary of the change. For `UPDATE` actions, this will show the old and new values for the fields that were modified.

Exporting Log Data

You can export your filtered log view for offline analysis, archival, or audit requests. Click the More button to download the data, typically in CSV format, which can be opened in any spreadsheet application.

Permissions and Data Retention

Permissions: Access to configure and view the Activity Log is controlled by user permissions. Typically, only administrative users have the ability to change log configurations, while other users may have view-only access.
Data Retention: Activity Log data is retained for a specific period to comply with audit and security standards. Please refer to your service agreement for the exact data retention policy.

Docs: Authentication Settings

Mon, 01 Jan 0001 00:00:00 +0000

Authentication is a critical part of securing your Monetization environment.
The platform allows administrators to define how users log in, how long sessions remain active, and what security measures (such as Multi-Factor Authentication) are required to protect accounts.

To configure authentication settings:

Open the Menu (bottom left, click on your username).
Select Business Portal.
Click Security.

The Authentication Settings page is displayed.

Available Settings

Session Timeout

The session timeout determines how long a user can remain inactive before being automatically signed out.
This helps protect against unauthorized access if a user forgets to log out.
Enter the duration in seconds (e.g., 300 for 5 minutes).

Tip: For production environments, we recommend setting a shorter session timeout (e.g., 10–15 minutes) to minimize security risks.

Single Sign-On (SSO) Providers

Single Sign-On (SSO) enables users to log in with their existing accounts from trusted providers, reducing the need for separate credentials.
Monetization supports several SSO integrations out of the box:

Google – Allow users to authenticate using their Google Workspace or Gmail account.
Twitter – Enable login with Twitter credentials.
Facebook – Allow authentication via Facebook accounts.
Microsoft Entra ID – Integrate with Microsoft’s enterprise identity service (formerly Azure AD).
Custom OIDC Provider – Configure any identity provider that supports the OpenID Connect (OIDC) standard.

You can enable one or more providers depending on your organization’s needs.
For example, enterprises typically use Microsoft Entra ID or Google Workspace, while customer-facing applications may offer social logins like Facebook or Twitter.

👉 See our step-by-step guide: How to Set Up Keycloak as an Identity Provider for Entra ID SSO

Multi-Factor Authentication (MFA)

Multi-Factor Authentication (MFA) requires users to provide an additional verification method (such as an authenticator app or SMS code) during login.
Enabling MFA significantly improves account security by ensuring that a stolen password alone cannot be used to access the system.

To enable MFA, toggle the Multi-Factor Authentication switch. Once enabled, all users will be required to complete MFA when signing in.

Password Policy

A strong password policy is essential to prevent brute-force attacks and ensure account safety.
Administrators can configure the following rules:

Minimum password length (recommended: 12 or more characters).
Maximum password length.
Password expiration (maximum password age in days).
Complexity requirements:
- At least one uppercase letter.
- At least one lowercase letter.
- At least one digit.
- At least one special character.
- Restrict use of email or username in the password.

These policies ensure that users create secure and unique passwords that are harder to guess or reuse.

Saving Changes

Once you have updated the settings, click Submit to apply and save the configuration.
Changes take effect immediately for all new logins and sessions.

Best Practices

Always enable MFA for production environments.
Use SSO whenever possible to centralize identity management and reduce password fatigue.
Set strong password policies (minimum length of 12–16 characters with complexity rules).
Adjust session timeout based on compliance or security needs (shorter timeouts for high-security accounts).

Docs: Customer Account Page

Mon, 01 Jan 0001 00:00:00 +0000

Topics in this document:

List customers’ account page
Finding customer account
Onboarding a customer
Generating customers’ information
Details customer account page
User information
Account information
- Edit account information
- Close account
Contact information
Payment information
- Edit payment information
Subscriptions
Billing profiles
- Bills
- Invoices
  - Invoice details
  - Offline invoice payment
Balance groups
Sharing
- Owner of a sharing group
- Member of a sharing group
Hierarchy
- Owner of a hierarchy group
- Member of a hierarchy group

To access the customer account page in Monetization, from the Menu, click Customers.

List customers’ account page

The list customers’ account page contains a paginated list of all active and inactive customers. It is the first page shown once the customer account page is accessed.

The page shows all your customers in a tabular format, with the following information: the customer name, how many subscriptions they have, how many services they are using, and a button to view the full details of each customer.

Additionally, on the page, you have access to the following functionalities, which are: finding customer account, onboarding a customer, and generating customers’ information.

Finding customer account

Under list customers’ account page, you can search for a customer account by full name, email address, address, city, country, status, customer type, or/and payment method.

To achieve this, from the list customers’ account page, click Filter and then enter the search criteria. After, click Search; it will update the list customers’ account page to include only the search query.

Once satisfied with the search result, to show all the customers’ accounts again, click Reset; follow this up by hiding the filtering section by clicking Filter.

Onboarding a customer

Onboarding a customer involves creating a new customer and setting them up with their desired subscription.

To onboard a customer, from the list customers’ account page, click Create new; the response will lead you to the customer onboarding page. The page is divided into six sections, namely:

Account info section
Payment info section
Sharing section (optional)
Hierarchy section (optional)
Subscription section
Summary section

Account info section

Under the account info section, add the customer’s first name, last name, email address, and phone number.

Note:

The customer’s email address must be unique for a particular site in Monetization.

Additionally, select a customer type. The customer type is configurable in Monetization. It can be used to segregate customers (for example, commercial or regular customers). It can as well be helpful for analytics, reporting, and business operations filtering (for example, invoicing, exporting, etc.). For more information, see Customer types.

The customer’s address, city, state, and country are also mandatory, while the customer’s organization and zip code are optional.

Note:

The customer’s organization, address, country, state, and city can be added to the invoice when an invoice template is created. For more information, see Template.

Also, for taxation to work correctly in Monetization, the address must be verified in some use cases.

Any custom attribute created under; System configuration Custom attributes that fall under the customer entity are also shown in this section. However, they will be treated as optional input fields. For more information, see Custom Attributes.

Payment info section

Under the payment info section, select the customer’s payment method. You can choose an invoice, a credit card, or a direct debit as the payment method.

If an invoice is selected, there are no additional requirements to fill out for the customer, except if the customer’s billing address differs from the customer’s address.

Note:

Choosing an invoice means that funds will never be taken automatically from a stored credit card, even if the customer’s credit card information is added.

If a credit card is selected, Monetization does not store any relevant credit card information, only basic information about its owner and a reference token in the case of integration with a payment gateway.

If a direct debit is selected, insert the following information about the customer:

The mandate identification
The mandate date of signature
The BIC
The IBAN

Note:

The customer’s tax identification number can be included under any payment method. It is useful when integrated with a taxation gateway in Monetization.

The value should represent the customer’s value-added tax (VAT) number and can be added to the invoice. For example, if a customer is a company, their VAT number can be populated and shown on the invoice PDF.

This optional section allows for the configuration of the transfer charges in real-time. The customer can either be a member or the owner of a sharing group. Then, if the owner has some resources, by extension, these resources are shared with the members because charges are transferred.

Note:

If the customer is the owner of a sharing group, it can only be configured from the details customer account page under sharing. However, when onboarding a customer, they can be assigned as members of one of the existing groups.

To add the customer to an existing group, search for the group owner account by their full name, then select the group.

Information:

The dropdown offers some suggestions, and they get filtered as you type.

Once the customer is added as a member of a sharing group, the resources from the subscription of the group owner are shared with group members, and they can consume them in real-time. However, this is subject to the policy configured on the group.

For example, if the owner of a sharing group has free 1000 megabytes of data, members of the group are all-consuming from the free available 1000 megabytes.

Hierarchy section (optional)

This optional section allows for the configuration of the transfer of charges between customers.

The charges are not transferred to the hierarchy group owner in real-time. Instead, when a member of a hierarchy group receives an invoice at the end of their billing cycle, that invoice (in total amount) is transferred to the hierarchy group owner’s account. This means the group owner becomes payment responsible for the invoice.

Note:

If the customer is the owner of a hierarchy group, it can only be configured from the details customer account page under hierarchy. However, when onboarding a customer, they can be assigned as members of one of the existing groups.

To add the customer to an existing group, search for the group owner account by their full name, then select the group.

Information:

The dropdown offers some suggestions, and they get filtered as you type.

Subscription section

Information:

Under this section, you set the customer up to a plan from your offering catalog for the customer.

Select a payment type. The billing profile that the subscription will be linked to must have a payment type.

Also, select a resource; this refers to the monetary resource (currency) that will be used in billing the customer.

Select the interval; this means the frequency of how the customer will be billed. For instance, the customer can be billed monthly, weekly, yearly, etc.

Note:

The interval is configured in Monetization under Business configuration Charging Event Types. For more information, see Event types.

Choose the billing day; it specifies the day of the month the customer will be billed. The information is needed when Monetization sets the customer’s billing cycle. For instance, the customer can be billed on the first day of every month.

The optional promotion code(s), can be coupons or/and vouchers. This code(s) enables customers to get special deal offers.

Information:

Typically, only coupons are used during this section.

The code is generated in Monetization, under Business configuration Voucher for vouchers, and under Catalog Packages Coupons for coupons.

Select a plan for the customer. The plan is the topmost object when configuring your offering catalog. It consist of bundles; the bundles consist of products or/and discounts. A plan is created under Catalog Packages Plans.

Note:

A plan is what your customers subscribe to consume a service(s) or to use a product resource(s). For more information, see Plans.

After a plan is chosen for the customer, a list of all the bundles under the plan is also shown. In addition, under each bundle will be a tabular presentation of the product(s).

The quantity, value, and validity period can be edited for each product.

Information:

The product value does not necessarily mean the product’s price because some can impact other balances—for instance, a grantor product for free 10 MBs. However, the value will represent the price if it is a regular product.

Other information about the product, including the name, type, etc., is also shown. Some products can be optional for the customer to purchase as part of the bundle. Therefore, you can decide whether to include it as part of the purchase by checking the checkbox Purchase.

Service products must include a service identifier, either as a string or a device already configured in Monetization. A service identifier is a unique ID for one customer for that service—for example, a mobile phone number.

Note:

The All set and Not set indicators makes it possible to know where the service identifier needs to be added.

You can assign a service identifier globally and not necessarily on a specific product. To achieve this, insert the service identifier from the Service identifier input field on the plan.

Note:

Monetization can only proceed to the next stage once there is not a single Not set indicator.

Information:

To include additional bundles on the subscription, click Add bundle.

Summary section

This section captures all the information filled out in the previous five sections. It allows you to review the details before successfully onboarding the customer.

Note:

The first billing profile is automatically created by Monetization based on the payment type and interval configurations set at the subscription section.

To finalize the onboarding process, click Submit.

Generating customers’ information

Under the list customers’ account page, customers’ information can be generated in a comma-separated values (CSV) format. To achieve this, click CSV; the customers’ information will be exported to a spreadsheet and then downloaded.

The downloaded file shows the following information about the customer: name, email address, subscription, and services.

Note:

The customers’ information is generated per paginated page.

The customers’ information can also be printed and copied. To achieve this, click Print and Copy respectively.

Details customer account page

Under list customers’ account page, to see the full details of a particular customer account, click Details. This will lead you to the details customer account page.

The details customer account page consists of nine sections, namely:

User information
Account information
Contact information
Payment information
Subscriptions
Billing profiles
Balance groups
Sharing
Hierarchy

User information

Note:

The user information section is only available if the self-care portal is enabled under the site environment configurations. For more information, see Sites.

After successfully onboarding a customer, user information for the customer can be created. Creating this will enable customers to access a self-care portal to view their account balance, consumption, and pay bills.

Information:

The self-care portal is available either as a web or mobile application.

Note:

Customers without user information cannot access the self-care portal.

A single action can be performed for customers without user information.

Create user information

Create user information

To create a user information, click Create user. The following input fields are required:

First name
Last name
Email address
Password
Password confirmation

The customer’s user information can also be enabled or disabled. To achieve this, use the Enabled toggle switch.

Information:

Disabled user information means inactive information, which implies the customer will not be able to access the self-care portal with the user information.

After successfully creating the customer’s user information, the following functionalities are accessible:

Delete user information
Edit user information
Request user verification email
Request user password update

Note:

Customers must verify their email addresses before they can access the self-care portal. For more information, see Request user verification email.

Delete user information

To delete the customer’s user information, click Delete user. Once deleted, the customer can no longer access the self-care portal.

Edit user information

To edit the customer’s user information, click Edit user. The information filled out under the create user information section can be edited.

Request user verification email

Before a customer can access the self-care portal, their email address must be verified. To achieve this, click Request user verification email. Once clicked, a user verification email will be sent to the customer.

Request user password update

Requesting a password update will send a user update password email to the customer, or the customer will be prompted to change their password when they login to the self-care portal. To achieve this, click Request user password update.

Account information

This section shows part of the information that was inputted during the onboarding process of the customer under the account info section. The information includes the customer type and custom attributes (if any).

In addition, the customer is assigned an ID (a unique auto-increment number to identify a customer uniquely). Also, the customer status is shown as either active or inactive.

Two actions can be performed under this section:

Edit account information
Close account

Edit account information

To edit the account information, click Edit account information. Only the type and custom attribute (if any) can be edited.

Close account

To close a customer account, click Close account. Closing an account is almost the same as deleting it; however, it does not get deleted immediately. A separate background job does the actual deletion after an account has been closed for a predefined period.

Information:

By clicking Close account, Monetization deactivates the accounts that do not have any active subscriptions or purchases. Deactivated accounts are automatically closed and removed after a configurable period.

Note: A customer with the status of inactive cannot purchase a product or subscribe to a plan.

Contact information

This section shows part of the information that was inputted during the onboarding process of the customer under the account info section. It includes the first name, last name, email address, phone number, organization, address, country, state, city, and zip code.

In addition, the contact information includes a tag. The tag is used to identify specific contact information of the customer, as there could be more than one contact information.

For example, if there are multiple contact information for a customer, and an email is to be sent to the customer, the tag can be used to reference a particular contact information email address.

Note:

The pattern for the tag can be configured. However, the following order can be followed Primary, Secondary, etc.

Three actions can be performed under this section:

Add contact information
Edit contact information
Delete contact information

Add contact information

To add another contact information for the customer, click Add contact information. The input fields remain the same as when the initial contact information for the customer was inputted.

However, in addition, include a tag, which can be used to quickly refer to the contact information in other parts of Monetization.

Edit contact information

To edit the contact information of the customer, select the appropriate contact information tag, then click Edit contact information.

Delete contact information

To delete the contact information of the customer, select the appropriate contact information tag, then click Delete contact information.

Note:

Deleting all the customer’s contact information in Monetization is not allowed: there must be at least one contact information.

Payment information

This section shows the payment information that was inputted during the onboarding process of the customer under the payment info section. It includes the billing address, tax identification (if any), and payment method the customer uses.

A single action can be performed under this section:

Edit payment information

Edit payment information

To edit the payment information of the customer, click Edit payment information.

You can choose an invoice, credit card, or direct debit as the payment method. Additionally, you can change the billing address and include/remove a tax identification number.

Subscriptions

This section shows the customer’s subscriptions. A subscription is the customer’s commitment to having a plan. A plan can come with specific bundles, and those bundles will have specific products and discounts.

Note:

A subscription links the customer to a plan from your offering catalog. Each customer can have an unlimited number of subscriptions.

Information:

Customers have billing profiles, billing profiles have balance groups, and balance groups are connected to subscriptions.

Adding subscriptions

To add a new subscription, click Add subscription. You are required to select a balance group and plan. Optionally, you can give the customer a special deal offer(s) by adding a promotion code(s), which could be coupons or/and vouchers.

Information:

Typically, only coupons are used during this section.

Note:

If you want to create a balance group while adding a new subscription, click Add balance group; choose the billing day, and select the payment type and interval.

Add-on bundle

On each subscription, additional bundles (add-ons) can be purchased on top of the plan; they are not part of the initial purchased plan. To achieve this, click Add bundle, and select the bundle. Once the bundle is selected, the quantity, value, and validity period can be edited for each product found under the bundle.

Information:

Note:

Additionally, the optional promotion code(s) can be included, which is used to give special deal offers to customers. They can constitute coupons or/and vouchers.

Information:

Typically, only coupons are used during this section.

Editing and canceling products

Under a subscription, each product in the bundle can be edited or canceled. To achieve this, click Edit product or Cancel product respectively.

Note:

Only the service identifier and validity period can be edited for the product.

To apply a voucher on a subscription, click Use voucher. Then, you enter a voucher code (or multiple), and Monetization will apply the voucher code to that subscription. Each voucher results in one bundle purchase.

Information:

The voucher code is generated in Monetization, under Business configuration Voucher.

To upgrade or downgrade the customer plan to another, click Plan transition; choose the new plan and configure the validity period.

Note:

The migration does not happen immediately. Instead, it will run at a specific period configured under the plan transition job.

To cancel a subscription manually, click Cancel subscription.

Note:

Subscriptions can be closed manually by clicking Cancel subscription or automatically by a purchase verification job, after which they become invalid, and their products no longer renew.

Some subscriptions have predefined duration terms; for example, a two years commitment contract.

There are three subsections under each subscription, namely:

Balances and notifications
Usage
Services

Balances and notifications

Resources depicts which balances can exist in Monetization. Based on the configured resources, a balance for that resource can be created in a customer’s balance group.

Resources also have different balance consumption order configured. This dictates how the balance of each resource should behave when impacted: if multiple balances of the same resource exist.

Balances

A subscription is linked to a balance group. This section shows the total valid amount of the balance of each resource from the balance group.

Information:

The total valid amount means the amount in which the validity period is still active.

Note:

Multiple subscriptions can be linked to the same balance group. Hence, the balances will capture the total valid amount of balance of each resource from the balance group, which could be that of many subscriptions and not just one subscription. However, you can link a single subscription to a balance group.

The total valid amount shown for each resource in the balance group can be positive or negative. A negative balance indicates that the customer is consuming out of a free resource.

Typically, a free resource initially gives the customer a certain amount of balance for the resource. The balance also moves to zero as the customer consumes the free resource. Once the balance equals zero, the free resource has been exhausted.

Furthermore, a negative balance can also mean the customer has a prepaid payment type. Therefore, when the customer subscribes to a plan, they pay in advance. Hence, they are given some amount of balance of resources. The resource balance will also be represented as a negative balance, which they can consume to zero.

A positive balance means that as the customer consumes a particular resource, the amount balance of the resource increases.

Information:

For a monetary resource with a positive balance, the customer will be required to pay at the end of their billing cycle.

A balance can be monetary, indicating how much the customer has spent or how much is left. A balance can also be non-monetary, indicating other resources such as free resources or credit.

Note:

There must be at least one monetary resource for one balance group. The monetary resource is required because every billing profile needs to have a monetary resource specified for Monetization to know which resource balance in the balance group to treat as money when applying charges to the bill/invoice.

To view the balance details of each resource in the balance group, click on the resource name. It shows the validity period, resource name, amount, and when the resource balance was created, all in a tabular format.

Note:

Under the balance details for each resource, there could be more than one balance detail.

To perform adjustments on the resource balance detail, under Actions, click Adjustment. The amount and bill item can be modified. Furthermore, tax can be included. To achieve this, enable the with tax toggle switch and provide the tax, tax supplier, and general ledger.

Creating a balance

Information:

Balances in Monetization are impacted by purchasing products, discounts, or service usage events (usage-based charges). Once a charge occurs, Monetization will find the appropriate balance to impact or create a new one if no valid balances exist. The impact will either increase (Debit) the balance or decrease (Credit) the balance.

You can also create a resource balance manually in Monetization. To achieve this, click Create a new balance. Select the resource, insert the amount, and specify how the balance should be represented (either as a positive or negative charge).

For a negative charge, select Credit; it means the customer is getting something (lowering the charge). For a positive charge, select Debit; it means the customer is being charged (that is, increasing the charge).

Furthermore, the validity period for the resource balance can be changed from the current cycle to another date or an infinite date. The current cycle means the resource balance will only be valid during the customer’s current billing cycle.

Notifications

A notification occurs as a result of the customer bridging a threshold that is configured for a resource by a credit profile through a credit limit. This section shows the time the notification was triggered, the type of notification, the breached threshold value, and the resource.

Customers can be alerted via email or text message that they have breached a threshold. Third-party APIs can also be called via JSON requests to notify other components in Monetization.

For instance, suppose a customer has some free MBs allocated; if the customer has consumed almost all their free MBs, a text message/email can be sent to them urging them to purchase an add-on.

Alternatively, suppose the customer payment type is configured to be prepaid and consumes all their account credit. In that case, a text message/email can be sent to them stating that the account is running low and they need to top up to continue using the services.

Usage

This section shows the usage event for a service from the customer’s subscription for a specific period. It can measure how the customer is consuming a particular service.

Information:

You can filter usage events by service and date-time. To achieve this, choose the service and input a start and end date-time, then click Search.

To generate the usage events in a spreadsheet, click CSV. To print, click Print, and to copy, click Copy.

Note:

They are generated, printed, and copied per paginated page.

The event ID, created at, and the amount, shown as table headings for the usage event, apply to every service usage event. Additional parameters are determined by the mandatory, optional, and rating set fields for the service, which is configured by the service type in Monetization.

For instance, the usage event for a voice call service, apart from the event ID, created at, and amount, can include the following mandatory/optional/rating set fields:

Start time: This denotes the date-time the call started.
End time: This denotes the date-time the call ended.
Origin: This denotes the location of the caller—for example, Slovenia.
Destination: This denotes the location of the recipient of the call—for example, Italy.
From: This denotes the person calling.
To: This denotes the person receiving the call.

The table below shows a usage event for a voice call service from the information above:

Event ID	Created at	Start time	End time	From	To	Origin	Destination	Amount
1	29/09/2020, 11:57	29/09/2020, 11:59	29/09/2020, 12:19	08094349013	08149110574	Slovenia	Italy	50

To adjust an individual usage event, click Adjustment; only the amount can be adjusted. In addition, to include tax, enable the with tax toggle switch, and provide the tax, tax supplier, and general ledger.

Create event

To create a usage event manually for a service, click Create event, select the service, and insert the start time for the event. The service represents a service type in Monetization.

Each service can have several fields. The field(s) represents a service field in Monetization. For more information on creating a service in Monetization, see Service Design.

Under Fields, the value for each field must be included. The field represents the mandatory field(s) from the service. In addition, each service that has an optional field(s) or rating set fields can be included; to achieve this, click Add.

Services

A service enables a customer to receive usage or consumption-based events. For instance, a voice call service created in Monetization will allow voice call events to be processed. Then, the voice call events can be rated based on the service event parameters and rate plan. In Monetization, a service type represents a service.

Note:

In this section, Monetization shows only the service(s) that come with the customer’s purchased product.

Information:

Each service has a unique identifier for one customer and allows customers to receive usage events intended for that service type.

Services are configured under Business configuration Service design Service types. For more information, see Service types.

Under Actions, the customer’s configuration for one service can be edited. To achieve this, click Edit. The service identifier, validity period, devices, and event generators can be edited. Additionally, the service status can be changed.

Note:

A service can have a status of active, inactive, or released. The service with a released status can be assigned to another customer, which will then be transferred to the new customer as an active service. To achieve this, specify the same service identifier for the new customer.

For example, a phone number that is no longer in use and has been quarantined for long enough to be reused by another customer.

Service Identifier Definition

The only restriction for alphanumeric service identifier is that it needs to be unique among the service entries. It can be any alphanumeric character string.

While customers are onboarded by the mobile application, identifier is assigned by the instantaneous timestamp, so if you are doing an onboarding in alternative way by the web dashboard, you can use the consistent principle by taking the current timestamp value from the Epoch Converter. Otherwise, you can apply your own identification definition rules.

Billing profiles

A billing profile shows the customer’s bills and corresponding invoices. The following information is depicted on a billing profile:

Billing day for the bills
Payment type
Resource
Event type
Event generators
Validity period
Total pending due bill (if any)
Credit balance — It refers to the amount of money overpaid on the previous bills. This amount can then be used to cover the next bill.
Payment information

Note:

The payment information which constitutes the customer’s payment method can be updated. To acheive this, click Edit payment information.

To create a new billing profile, click Add billing profile. Provide a name, payment type, monetary resource, event type (represented by interval), billing day, and validity period.

Information:

The interval/cycle, which could be weekly, monthly, bi-monthly, etc., is configured in Monetization. For more information, see Event types.

Note: If the billing profile’s payment type is Pay now, the interval cannot be set, and the customer can be billed anytime. Another name for the Pay now payment type is Pay as you go; therefore, the customer is being billed as they consume the service.

Note:

Multiple subscriptions for the customer can be linked to the same balance group. Also, numerous balance groups can be connected to the same billing profile.

There are two main sections under the billing profile, namely:

Bills
Invoices
- Invoice details
- Offline invoice payment

Bills

Bills represent all the customer charges accumulated during a billing cycle. The invoice(s) are generated from the bills.

Note:

Invoices are created in Monetization by a business operation known as the invoicing job. Therefore, the invoices are not automatically created even if billing is executed. In addition, invoices cannot be made if the bill amount is zero.

The bills are displayed in a tabular format, which includes the bill ID, status, validity period, total amount, due amount, and the corresponding invoice.

Information:

The due amount refers to how much the customer still owes; this amount is lowered/cleared once the customer pays the bill.

The bill status

A bill can have the following status:

Inactive — An inactive bill is only an existing reference to the next bill that the customer will have. It is like a future empty bill prepared in advance to enable Monetization to switch to it when the billing cycle changes, instead of creating the bill at that time—this improves performance.
Active — An active bill refers to the current bill. Once the billing cycle is over, the active bill goes into the billing status.
Billing — When the bill is in the billing status, it means the customer has not fully paid the bill.
Closed — When the bill is closed, it means the customer has paid the bill in full.

For example:

Inactive bill ID is 111
Active bill ID is 110 (this is the current bill)

Once the billing cycle is over, the active bill (110) will go into the billing status, meaning it is waiting to be paid. In contrast, the previously inactive bill (111) will become active as the current bill and a new inactive bill (112) will be prepared for the next cycle.

The billing process

Billing is the operation in Monetization where the customer is moved to their next billing cycle. As a result, the previous bills will be moved to the billing status and becomes due. Consequently, the bill with an inactive status will be moved to an active status—this is now the current bill.

Furthermore, Monetization will create a new inactive bill as an existing reference to the next bill the customer will have. It is like a future empty bill prepared in advance to enable Monetization to switch to it when the billing cycle changes instead of creating the bill at that time—this improves performance.

Under each bill, these actions can be performed:

Adjusting a bill: To manually change the amount, balance group, and bill item of a bill, click Adjustment. Furthermore, tax can be included by enabling the with tax toggle switch and providing the tax, tax supplier, and general ledger.

Note:
Debit means the customer is being charged (increasing the charge), while credit means giving something to the customer (lowering the charge).
Show bill items: To see the bill items for each bill, click Info. Each bill item can also be separately adjusted; to achieve this, click Adjustment.

Run billing

Under the bills, to run billing, select and click Run billing. Run billing will execute the normal billing process, which is to:

Shift the billing cycle
Move the current active bill to the billing status
Activate the next bill in line (which was previously an inactive bill)
Create a new inactive bill

Note:

Run billing will not work if the customer is still in their previous billing cycle; that is, run billing can only be initiated for November when it is already December (for monthly customers)—the previous cycle needs to be over to run billing.

Bill now

Under the bills, to bill the customer at the moment, select and click Bill now. The bill now will bypass the billing process and pull charges/bill items on the current active bill to an entirely new bill, which will be transferred immediately to the billing status.

Information:

A practical example is a customer leaving in the middle of the cycle and requesting an immediate bill for anything they have accumulated. Since run billing operation cannot be performed yet, bill now will be used to generate a new bill with all the charges, which can then be immediately issued.

Billing cycle

A billing cycle in Monetization is an interval during which all charges are collected on one bill/invoice. It is based on the event type and billing day of a billing profile of the customer.

For instance, if the billing profile has a monthly event type with the billing day set to the first day of the month, the billing cycle will constantly shift on the first day of the month while collecting the charges accrued for the previous month.

Information:

The billing process takes care of shifting any billing cycles that are waiting to be billed.

The charges can be collected automatically by scheduled payment collection job. Customers can also pay their bills manually via the self-care portal.

Additionally, Monetization can produce a SEPA Direct Debit file for customers with SEPA mandates. It represents a list of transactions that can be uploaded to the bank to take money from the customer’s bank account. The resulting file is then imported to Monetization, which will log the successful payments.

Invoices

An invoice in Monetization is a representation of the bill object that is presented to the customer.

Note:

A separate background job is responsible for generating the invoices. For more information, see Invoicing job.

Information:

Invoices can be filtered by date-time, invoice ID, bill ID, or/and status.

To generate the invoices in a spreadsheet, click CSV. To print, click Print, and to copy, click Copy.

Note:

They are generated, printed, or copied per paginated page.

The Invoice amount refers to the total amount of the bill. The Due amount refers to the remaining amount yet to be paid by the customer.

The Due date represents the last date-time the customer has to pay in full amount for the invoice.

Note:

Once the customer pays for the invoice fully, the bill is marked as Closed.

Under the invoice section, a bill can have the following status:

Billing — When the bill is in the billing status, it means the customer has not fully paid the bill.
Closed — When the bill is closed, it means the customer has paid the bill in full.

Invoice details

To preview a particular invoice with a template, click Details. Once previewed, it can be saved as PDF, HTML, or JSON.

Note:

You can change from one template to another.

Information:

The template for an invoice is configured in Monetization under Business configuration Template Document templates. For more information, see Document templates.

Offline invoice payment

To manually enter the payment for a particular invoice, click Wallet. If you have already received the payment through another channel (like cash or wire transfer), you can enter it manually here.

The amount can be configured to be a charge or a refund. Monetization provides three payment methods: cash, credit card, and transfer.

Information:

The transfer payment method means a bank transaction.

The provider typifies the payment provider—for example, Stripe, Bank, Paypal, etc. You may also include a payment reference and a note.

Preview invoice

Under bills, the preview invoice will execute a test billing to show you what the next upcoming invoice will look like—it does not show any of the existing bills. The preview invoice with details will include the event history; it is much heavier performance-wise.

To achieve these two functionalities, under bills, select and click Preview invoice or Preview invoice with details.

Balance groups

A balance group holds all the balances of the customer. Monetization ties a subscription to a balance group, meaning any impacts resulting from rating service products from the subscription can only impact the balances from that balance group.

Note:

Multiple subscriptions for the customer can be linked to the same balance group. Also, numerous balance groups can be connected to the same billing profile.

To create a new balance group, click Add balance group; provide a name and validity period. Additionally, select the billing profile.

This section allows for the configuration of the transfer charges in real-time. The customer can either be a member or the owner of a sharing group. Then, if the owner has some resources, by extension, these resources are shared with the members because charges are transferred.

To enable the transfer of resources between customers, click Add sponsorship.

Select owner mode to make the customer the owner of a sharing group. Provide a group name, validity period, subscription, and policy. Additionally, choose the status.

Members joining the sharing group will be able to use the resources from the selected subscription in real-time; however, subject to the configured policy.

Information:

The policy consists of a name and discounts.

Note:

The discount refers to the purchased discount. Hence, it needs to be a purchased discount on the selected subscription.

Essentially, the discount’s configuration acts as a policy on which charges are transferred over. For instance, if you create a discount that targets only VOICE usage events and their monetary impacts and then use this discount as a policy. Only the monetary impacts for voice events will be transferred to the owner.

Once the group is created, the owner can edit the status and validity period or cancel the group. To achieve this, click Edit sharing or Cancel sharing respectively.

Information:

Members of the sharing group will also be visible to the group owner.

To add the customer to an existing group, search for the group owner customer account by full name, then select the group.

Information:

The dropdown offers some suggestions, and they get filtered as you type.

Once the customer is added as a member of the sharing group, the resources from the subscription of the group owner are consumed by the group members in real-time. However, this is subject to the policy configured on the group.

For instance, if the owner of a sharing group has free 1000 megabytes of data, members of the group are all-consuming from the free available 1000 megabytes.

The customer, as a member of the group, can as well edit the status and validity period of the group or remove themselves from the group. To achieve this, click Edit sharing or Remove from sharing respectively.

Hierarchy

Under this section, you can transfer the impacts/charges from consuming a service to the owner of a hierarchy group. The customer can either be a member or the owner of a hierarchy group.

Note:

To enable the transfer of the impacts/charges from consuming a service to the owner of a hierarchy group, click Add hierarchy.

Owner of a hierarchy group

Select owner mode to make the customer the owner of the hierarchy group. Provide a group name, validity period, and status.

Additionally, the group needs to be connected to a billing profile from the customer account because the entire bill from the members of the hierarchy group is transferred at billing time.

Once the group is created, the owner can edit the status and validity period or cancel the group. To achieve this, click Edit hierarchy or Cancel hierarchy respectively.

Information:

Members of the hierarchy group will also be visible to the group owner.

Member of a hierarchy group

To add the customer to an existing group, search for the group owner customer account by full name, then select the group.

Information:

The dropdown offers some suggestions, and they get filtered as you type.

The customer, as a member of the group, can as well edit the status and validity period of the group or remove themselves from the group. To achieve this, click Edit hierarchy or Remove from hierarchy respectively.

Docs: Payment Types

Mon, 01 Jan 0001 00:00:00 +0000

There are three payment approaches in Monetization, which are:

Prepaid payment type
Pay now payment type
Postpaid payment type

Prepaid payment type

The prepaid payment type involves the customer paying in advance before they can use the product service. Prepaid customers do not receive invoices; instead, they have account balance(s) that enables them to use the product service as long as the account balance is not empty.

Note:

A prepaid customer can receive monthly statements for their consumption but not invoices.

Information:

The customer account balance can be topped up by voucher code, credit/debit card, or API integration.

Pay now payment type

Another name for the pay now payment type is called pay-as-you-go. Customers with a pay now payment type do not have a RECURRING billing cycle; instead, they are billed on demand—for example, customers that use a car sharing service, or taxi fare, etc.

Postpaid payment type

A postpaid customer does not pay before or immediately after consuming a product service; instead, they have a billing cycle. The customer’s invoice is generated after the billing cycle shifts. However, the payment collection is determined based on the invoice’s due date.

Information:

Monetization creates one invoice per bill for every bill from the previous cycle.