Upgrade.chat icon

Upgrade.chat

Easy-to-use recurring and one-time payments software for Stripe & PayPal

Actions6

Overview

This node integrates with the Upgrade.chat platform to manage subscriptions related to contacts and products. Specifically, the "Subscription - Create" operation allows users to create or update a subscription for a contact to a product with specified billing details. This is useful in scenarios where businesses want to automate subscription management, such as enrolling customers into recurring payment plans or one-time purchases.

Practical examples include:

  • Automatically subscribing a customer to a monthly or annual service plan.
  • Creating lifetime access subscriptions for special products.
  • Managing whether the subscription involves recurring billing or not.

Properties

Name Meaning
Contact ID The unique identifier of the contact in the system. Used to associate the subscription with a specific client.
Product ID The unique identifier of the product. Optional but can be used to specify the exact product for the subscription.
External Contact ID An external reference ID for the contact. Must be accurate to correctly identify the contact.
Product Code A unique code identifying the product. Required to look up the correct product for the subscription.
Payment Period Type The billing period type for the subscription. Options: Monthly, Annual, LifeTime. Must match the product setup.
Is It Recurring Billing Indicates if the subscription involves recurring billing. Options: Yes (true), No (false).

Output

The node outputs JSON data representing the response from the Upgrade.chat API after attempting to create or update the subscription. This typically includes confirmation details about the subscription status or any errors returned by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Upgrade.chat API.
  • The node makes HTTP PUT requests to the endpoint /api/services/CRM/OrderSubscription/Update on the Upgrade.chat service.
  • Proper configuration of the API credentials within n8n is necessary for successful execution.

Troubleshooting

  • Common Issues:

    • Incorrect or missing Contact ID or Product Code may cause the API to fail to locate the relevant entities.
    • Mismatch between the Payment Period Type and what is configured on the Upgrade.chat product side can lead to errors.
    • Providing invalid values for hasRecurringBilling or omitting required fields will result in request failures.

  • Error Messages:

    • Errors returned from the API usually contain messages indicating missing or invalid parameters.
    • Network or authentication errors may occur if the API key is invalid or not set up properly.

  • Resolutions:

    • Verify that all required fields are correctly filled and correspond to existing records in Upgrade.chat.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Confirm that the product’s billing period settings align with the chosen Payment Period Type.

Links and References

Discussion