Actions28
- Companies Actions
- Products Actions
- Orders Actions
- Subscriptions Actions
- Contacts Actions
- Invoices Actions
- Usage Summaries Actions
Subscriptions → Find Subscription By Subscription Id
AI-generatedOverview
This node is designed to retrieve detailed information about a specific subscription by its unique Subscription Id. It is useful in scenarios where you need to fetch the current status, details, or metadata of a particular subscription within a system that manages subscriptions, such as billing platforms, SaaS management tools, or partner portals.
Practical examples include:
- Verifying subscription details before processing an update or cancellation.
- Displaying subscription information in a dashboard or report.
- Automating workflows that depend on subscription status or attributes.
Properties
| Name | Meaning |
|---|---|
| Subscription Id | The unique identifier of the subscription you want to find. This must be provided as a string. |
Output
The node outputs JSON data representing the subscription object corresponding to the given Subscription Id. This JSON typically includes all relevant subscription details such as identifiers, status, associated customer or account info, plan details, and timestamps.
If the node supports binary data output (not indicated here), it would represent any file or media related to the subscription, but based on the code and properties, the output is purely JSON.
Dependencies
- Requires an API key credential for authenticating requests to the external Pax8 Partner API service.
- The node makes HTTP requests to the Pax8 API endpoint at
https://api.pax8.com/v1. - Proper configuration of this API credential within n8n is necessary for successful execution.
Troubleshooting
Common issues:
- Invalid or missing Subscription Id will cause the API call to fail or return no results.
- Incorrect or expired API credentials will result in authentication errors.
- Network connectivity problems can prevent reaching the Pax8 API endpoint.
Error messages:
- Authentication errors typically indicate invalid API keys; verify and update credentials.
- "Subscription not found" or similar indicates the Subscription Id does not exist or is mistyped.
- Timeout or connection errors suggest network issues or API downtime.
Resolving these usually involves verifying input values, checking API credentials, and ensuring network access.
Links and References
- Pax8 API Documentation (for detailed API usage and subscription resource info)
- n8n documentation on API Credentials