SAP SB Query

Owned by Former user (Deleted)
Last updated: May 03, 2023 by Former user (Deleted)
2 min read

The SAP SB (Subscription Billing) Query Function enables the user to query subscriptions, customers, bills, and provisioning requests.

The following information is required from your SAP account:

FieldDescription
TenantThe SAP Subscription Billing tenant name
RegionThe SAP 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 configure the SAP Subscription Billing Query Function, take the following steps:

  1. In SAP Credentials, specify the Tenant, Region, OAuth Client ID and OAuth Client Secret.

    Note!

    You can also use the Secrets Wallet toggle button to select a predefined SAP Subscription Billing secret from your Secrets Wallet.

  2. In SAP API, you can specify the query parameters in Query Option to filter the result. You can select the following options:

    Query OptionDescription
    Subscriptions - AllThe query option to view all subscriptions. The SAP API endpoint is GET /subscription/v1/subscriptions.
    Customers - AllThe query option to view all customers. The SAP API endpoint is GET /business-partner/v3/customers.
    Customers - SpecificThe query option to view a specific customer. The SAP API endpoint is GET /business-partner/v3/customers/{customerNumber}.
    Bills - AllThe query option to view all bills. The SAP API endpoint is GET /bill/v2/bills.
    Provisioning requests - AllThe query option to view all provisioning requests. The SAP API endpoint is GET /provisioning-request/v1/provisioning-requests.
    Provisioning request - SpecificThe query option to view a specific provisioning request. The SAP API endpoint is GET /provisioning-request/v1/provisioning-requests/{identifier}.

  3. In Query Parameters, you can specify the query parameters by selecting a Key and specify a Value. After specifying the key-value pair, click +Add Query Parameter to add the query parameter to the search filter. 

    Note!

    The query parameter keys are always different for different SAP API endpoints.