Sherweb icon

Sherweb

Interact with Sherweb API

Actions19

Overview

This node interacts with the Sherweb API to manage subscription amendments for customers. Specifically, the "Create Subscriptions Amendment" operation allows users to modify existing subscriptions by adjusting parameters such as quantity. This is useful in scenarios where a customer’s subscription needs to be updated due to changes in service usage, scaling requirements, or billing adjustments.

Practical examples include:

  • Increasing or decreasing the number of licenses or seats in a subscription.
  • Adjusting subscription quantities after a contract renegotiation.
  • Automating subscription updates based on customer lifecycle events.

Properties

Name Meaning
API Type Selects which Sherweb API to use: either the "Service Provider API" or the "Distributor API".
Customer ID The unique identifier of the customer whose subscription is being amended.
Subscription Amendment Parameters JSON array specifying amendment details. Each object includes subscriptionId (string) and newQuantity (number).

Example of Subscription Amendment Parameters JSON:

[
  {
    "subscriptionId": "string",
    "newQuantity": 0
  }
]

Output

The node outputs JSON data representing the result of the subscription amendment request. This typically includes confirmation of the updated subscription details, status messages, or error information if the amendment failed.

If binary data were involved (e.g., documents or files), it would be summarized here, but this node focuses on JSON responses from the Sherweb API.

Dependencies

  • Requires an API key credential for authentication with the Sherweb API.
  • Needs network access to https://api.sherweb.com.
  • The user must configure the node with valid credentials that provide access to the Sherweb platform.
  • The node supports two API types: Service Provider API and Distributor API, selectable via the "API Type" property.

Troubleshooting

  • Invalid Customer ID: If the provided customer ID does not exist or is incorrect, the API will return an error. Verify the customer ID before running the node.
  • Malformed JSON in Amendment Parameters: Ensure the JSON structure for subscription amendments is correctly formatted and includes required fields (subscriptionId and newQuantity).
  • Authentication Errors: Check that the API key credential is valid and has sufficient permissions.
  • Network Issues: Confirm connectivity to the Sherweb API endpoint.
  • API Limits or Quotas: If requests are throttled or denied, review API usage limits and adjust accordingly.

Links and References

Discussion