Sherweb icon

Sherweb

Interact with Sherweb API

Actions19

Overview

This node integrates with the Sherweb API to manage subscriptions, specifically allowing users to cancel one or more subscriptions for a given customer. It supports two API types: the Service Provider API and the Distributor API, enabling flexibility depending on the user's role or access level.

Typical use cases include:

  • Automating subscription cancellations when customers decide to terminate services.
  • Managing subscription lifecycle events in bulk by cancelling multiple subscriptions at once.
  • Integrating subscription management into broader workflows such as billing or customer support automation.

For example, a user can input a customer ID along with a list of subscription IDs to cancel those subscriptions programmatically without manual intervention.

Properties

Name Meaning
API Type Selects which Sherweb API to use: "Service Provider API" or "Distributor API".
Customer ID The unique identifier of the customer whose subscriptions are to be cancelled.
Subscription IDs Comma-separated string of subscription IDs that should be cancelled for the specified customer.

Output

The node outputs JSON data representing the result of the cancellation request(s). This typically includes confirmation details about the cancelled subscriptions, such as their IDs and status updates. The exact structure depends on the Sherweb API response but generally confirms successful cancellation or provides error information if any subscription could not be cancelled.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API authentication token credential configured in n8n to authorize requests to the Sherweb API.
  • The base URL for API requests is https://api.sherweb.com.
  • The node sets necessary HTTP headers including Accept: application/json, Content-Type: application/json, and a subscription key header sourced from credentials.

Troubleshooting

  • Invalid Customer ID or Subscription IDs: If the provided IDs do not exist or are incorrect, the API will return errors. Verify IDs before running the node.
  • Authentication Errors: Ensure the API authentication token and subscription key are correctly configured and have sufficient permissions.
  • API Type Mismatch: Selecting the wrong API type (Service Provider vs Distributor) may cause the request to fail. Confirm which API your account uses.
  • Empty or Malformed Subscription IDs: The subscription IDs must be provided as a non-empty string, typically comma-separated if multiple. Improper formatting can lead to errors.
  • Network Issues: Connectivity problems or Sherweb API downtime will prevent successful execution.

Links and References

Discussion