Actions6
Overview
This node integrates with a recurring and one-time payments platform to manage subscriptions. Specifically, the Subscription - Create operation allows users to create or update a subscription for a client (contact) with a specified product and billing details.
Typical use cases include:
- Automating subscription creation when a new customer signs up.
- Updating subscription details programmatically based on external triggers.
- Managing billing cycles and recurring payment settings for products linked to customers.
For example, you might use this node to create a monthly subscription for a customer who purchased a software license, specifying whether the billing is recurring and the payment period type.
Properties
| Name | Meaning |
|---|---|
| Contact ID | The unique identifier of the client in the system. Used to associate the subscription with the correct contact. |
| Product ID | The unique identifier of the product to subscribe to. |
| External Contact ID | An alternative contact identifier used to look up the correct contact if Contact ID is not available. |
| Product Code | A unique code identifying the product. Must be accurate to find the correct product. |
| Payment Period Type | The billing period for the subscription. Options: Monthly, Annual, LifeTime. |
| Is It Recurring Billing | Indicates if the subscription has recurring billing enabled. Options: Yes (true), No (false). |
Output
The output JSON contains the response from the API after attempting to create or update the subscription. This typically includes confirmation details about the subscription such as status, identifiers, and any relevant metadata returned by the service.
The node does not output binary data.
Dependencies
- Requires an API key credential for authenticating requests to the external payment/subscription service.
- The node uses HTTP requests to interact with the service's REST API endpoints.
- Proper configuration of the API credential within n8n is necessary for successful execution.
Troubleshooting
Common issues:
- Incorrect or missing Contact ID or Product Code can cause the API to fail to locate the correct entities.
- Mismatched Payment Period Type that does not align with the product’s configured periods on the service side.
- Network or authentication errors due to invalid API credentials.
Error messages:
- Errors indicating "Contact not found" or "Product not found" suggest verifying the IDs and codes provided.
- Authentication failures require checking the API key credential setup.
- Validation errors related to required fields mean some mandatory properties are missing or incorrectly formatted.
Resolving these usually involves double-checking input parameters and ensuring the API credentials are valid and have sufficient permissions.
Links and References
- ChargeKeep Official Website (for general product info)
- API documentation should be consulted for detailed field requirements and error codes (not included here due to static analysis constraints).