ProAbono icon

ProAbono

Interact with ProAbono API

Actions19

Overview

The node integrates with the ProAbono API to manage subscription upgrades. Specifically, the "Upgrade a Subscription" operation allows users to change an existing subscription's offer to a new one. This is useful in scenarios where customers want to move to a higher-tier plan or add more features without creating a new subscription from scratch.

Practical examples include:

  • Upgrading a customer's monthly subscription to a premium plan immediately.
  • Scheduling an upgrade to take effect at the end of the current billing period.
  • Overriding minimum commitment restrictions to allow early upgrades.

Properties

Name Meaning
Offer Name or ReferenceOffer Select the new offer to upgrade the subscription to. Options are loaded dynamically from available offers. Can also be set via expression.
Subscription ID The unique numeric identifier of the subscription to upgrade.
When to Apply the Upgrade? Choose whether the upgrade should be applied immediately or at the end of the current term. Options: "Immediately", "At the End of the Current Term".
Ignore Minimum Commitment? Decide if the upgrade should bypass any minimum commitment period restrictions. Options: "Yes, Ignore Any Commitment", "No, Respect the Commitment Period".
When to Bill the Upgrade? Choose when the billing for the upgrade should occur. Options: "Immediately", "At the End of the Current Term".

Output

The node outputs JSON data representing the result of the subscription upgrade request as returned by the ProAbono API. This typically includes details about the updated subscription status, the new offer applied, billing information, and any relevant metadata.

If the API supports binary data (e.g., invoices or receipts), it would be included accordingly, but this operation primarily deals with JSON responses related to subscription state changes.

Dependencies

  • Requires connection to the ProAbono API.
  • Needs an API authentication token and agent key configured in n8n credentials.
  • The base URL for API requests depends on the business ID provided in credentials.
  • Dynamic loading of offers requires the getOffers method to fetch available plans.

Troubleshooting

  • Invalid Subscription ID: If the subscription ID does not exist or is incorrect, the API will return an error. Verify the subscription ID before running the node.
  • Offer Not Found: Selecting an invalid or unavailable offer will cause the upgrade to fail. Use the dynamic options list or verify offer references.
  • Commitment Period Restrictions: Attempting to upgrade during a minimum commitment period without setting "Ignore Minimum Commitment" to true may result in rejection.
  • Authentication Errors: Ensure that API keys and agent keys are correctly set in credentials; otherwise, authentication will fail.
  • Billing Timing Conflicts: Misconfiguration of billing timing options might lead to unexpected billing behavior; confirm the desired billing schedule.

Links and References

Discussion