SAP Subscription Billing

The SAP Subscription Billing Forwarder-type Function is used to send usage records to SAP Subscription Billing system using the POST /usage-records API. The following information is required from your SAP account:

Field

Description

TenantThe SAP Subscription Billing tenant name
RegionThe SAP SB Subscription Billing region
OAuth Client IDThe client identifier issued to the client during registration
OAuth Client SecretThe client secret used by the client for authentication

To activate this feature, enter the required SAP credentials into the Parameters section. Alternatively, Secrets Wallet can be used to enter already-defined credentials. Preceding processed records will be sent to the SAP Subscription Billing system. 

SAP SB Credentials Entry in the Parameters Section

Configuration

The Function can be renamed by editing the name in the Configuration section. The following mandatory fields must be filed for the forwarder to function correctly: 

FieldDescription
startedAtThe start date of the period of usage consumption
endedAtThe end date of the period of usage consumption
metricId

The identifier of the metrics of usage, for example, MB or number of downloads

quantityThe number of usage units
userTechnicalIdThe identifier of the customer

Field Mapping

You can use the Field Mapping Function to provide a mapping of your own choice. Click on Add Field Mapping under Optional Fields.

All of the values can be mapped to custom parameters, depending on the desired end result. This can be used in cases when SAP Subscription Billing system requires custom naming of the expected data.

Items

Optionally, you can define the items parameters by clicking the Add Item button under Items. Click on the newly-created Item dropdown list to expand the parameters entry screen and fill in the necessary codes and values.

FieldDescription
fieldCode

Specify The code representing the pricing-relevant field.

Expected format: 

string =

dateValue

The date value of the pricing-relevant field

Expected format: 
string($date)

The quantity value of the pricing-relevant field.

Expected format: 
number
minimum: 0

maximum: 9999999999.999

multipleOf: 0.001

The unit of the quantity

Expected format: 

string
pattern: ^[A-Za-z0-9]{1,3}$

stringValue

The string value of the pricing-relevant field

Expected format: 

string
maxLength: 255

The denominator of the ratio value of the pricing-relevant field.

Expected format: 

number
minimum: 0

maximum: 99999999999.99998

multipleOf: 0.00001

The numerator of the ratio value of the pricing-relevant field.

Expected format: 

number
minimum: 0

maximum: 99999999999.99998

multipleOf: 0.00001

Custom References

Custom References is an optional feature that can be toggled by clicking on the Add custom reference fields checkbox. It allows users to add one or many typeCode and id into the usage records. Once enabled follow these steps to add the references: 

  1. Select the Type Code value from the dropdown menu to reference the source field name.
  2. Select the ID value from the dropdown menu to reference the source field name.
  3. To add a new entry click on the Add Custom References.
  4. Existing entries can be removed by clicking on the minus sign on the same line.