SAP Subscription Billing
The SAP Subscription Billing forwarder function is used to send previously processed records or usage records to the SAP Subscription Billing system using the Batch/usage-records API. Usage records are sent in batches, with each batch containing 500 records.
You can configure this function with the following settings:
Environment
To activate this feature, enter the required SAP credentials into the Environment section.
Field | Description |
|---|---|
Tenant | The SAP Subscription Billing tenant name. |
Region | The SAP Subscription Billing region. |
Authentication
Setting | Description |
|---|---|
Environment | |
Tenant | Enter the SAP Subscription Billing tenant name. |
Region | Enter the SAP Subscription Billing region. |
Authentication | |
Select from secrets wallet | Note! This Secrets wallet toggle is enabled by default. Select a secret with the SAP Subscription Billing secret type. |
OAuth client ID OAuth client Secret | Note! These fields only appear when the Secrets wallet toggle is disabled. OAuth client ID and OAuth client Secret fields Enter the following:
Note! The OAuth client Secret field only accepts parameter reference and requires you to use Global parameters. |
Required fields
The following mandatory fields in the Required fields section must be filled for the forwarder to function correctly:
Field | Description |
|---|---|
userTechnicalId | The identifier of the customer |
startedAt | The start date of the period of usage consumption |
endedAt | The end date of the period of usage consumption |
metricId | The identifier of the metrics of usage, for example, MB or number of downloads |
quantity | The number of usage units |
Optional fields
You may add optional fields to store additional values. All values can be mapped to custom parameters, depending on the desired end result. This can be used in cases when the SAP Subscription Billing system requires custom naming of the expected data.
Under Optional fields, you can provide a mapping of your own choice. Click on Add field mapping, and select a target field and source field.
Existing optional fields can be removed by clicking on the Delete button on the same line.
Items
Optionally, you can define the Items parameters by clicking the Add item button. Expand the newly-created drop-down list to expand the parameters entry screen and fill in the necessary codes and values.
Note!
You can create multiple Items, each containing several fieldCode fields to address your specific use cases.
Example - Item with multiple fieldCode
Example - Multiple items with one fieldCode
Field | Description |
|---|---|
fieldCode | Specify the code representing the pricing-relevant field. Expected format: string = |
dateValue | The date value of the pricing-relevant field Expected format: |
quantityValue - value | The quantity value of the pricing-relevant field. Expected format: |
quantityValue - unit | The unit of the quantity Expected format: string |
stringValue | The string value of the pricing-relevant field Expected format: string |
ratioValue - denominator | The denominator of the ratio value of the pricing-relevant field. Expected format: number |
ratioValue - numerator | The numerator of the ratio value of the pricing-relevant field. Expected format: number |
Existing items can be removed by clicking on the Delete button on the same line.
Custom reference fields
In SAP Subscription Billing, you can define custom reference fields for storing references to related data, such as external documents.
Add the custom references by following these steps:
Click Add custom reference.
Select the typecode value from the drop-down menu to reference the source field name.
Select the id value from the drop-down menu to reference the source field name.
Existing custom reference fields can be removed by clicking on the Delete button on the same line.
Operational settings
In Operational settings, you can configure how you want the function to behave.
You can toggle Retry on fail to let the service retry each request when the server returns error codes such as 429, 500, or 503 because of intermittent server issues or rate limiting.
You can specify the number of retries in the Number of retries box, and the service performs those retries within a dynamically adjusted retry period. This retry behavior applies only to 5xx and 429(Too many requests) error codes.
Note!
The maximum number of allowed retries is 12 and all retries will be attempted in a total span of a maximum of 68 minutes.
You can choose to either Ignore or Stop the stream when requests still fail after specified retries have been executed.
Action on retry options | Description |
|---|---|
Ignore | Select to ignore the error and the stream keeps on running. |
Stop the stream | Select to stop the stream. |
The default value is Ignore.
Response handling
Toggling the Response handling on will allow you to Select Interconnect receiver.
The SAP Subscription Billing forwarder allows you to select an existing Interconnect receiver which will forward the response details (ID, Status, Body), and the request body (ID, Body) to the SAP Subscription Billing system. A second stream can use the Interconnect Receiver to accept the response details (ID, Status, and Body), and the request body (ID, and payload) forwarded by the SAP Subscription Billing forwarder, to track the status of the record in SAP Subscription Billing. If the stream fails for any reason, the SAP Subscription Billing forwarder will not send anything through the Interconnect sender.
Note!
It is recommended to enable response handling if you want to review individual responses of the requests sent in the batch(es).