Cancel Subscription with ReCharge API on New Payment Failure from Zoho Billing API

Pipedream makes it easy to connect APIs for ReCharge, Zoho Billing and 2,700+ other apps remarkably fast.

Trigger workflow on

New Payment Failure from the Zoho Billing API

Next, do this

Cancel Subscription with the ReCharge API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Zoho Billing trigger and ReCharge action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Payment Failure trigger
1. Connect your Zoho Billing account
2. Configure Polling interval
3. Select a Organization Id
Configure the Cancel Subscription action
1. Connect your ReCharge account
2. Select a Subscription ID
3. Configure Cancellation Reason
4. Optional- Configure Cancellation Reason Comment
5. Optional- Configure Send Email
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Payment Failure on Zoho Billing

Description:Emit new event when a payment fails to process.

Version:0.0.2

Key:zoho_subscriptions-payment-failure

View on GitHub

Zoho Billing Overview#

The Zoho Subscriptions API allows you to manage various aspects of subscription-based billing services. With this API, you can automate tasks such as creating subscriptions, handling customer billing info, and managing invoices. In Pipedream, you can harness this API to build workflows that respond to events in Zoho Subscriptions or to perform actions based on triggers from other apps. This enables seamless automation of billing operations and integration with your broader app ecosystem.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import moment from "moment";
import zohoSubscriptions from "../../zoho_subscriptions.app.mjs";

export default {
  key: "zoho_subscriptions-payment-failure",
  name: "New Payment Failure",
  version: "0.0.2",
  description: "Emit new event when a payment fails to process.",
  type: "source",
  dedupe: "unique",
  props: {
    zohoSubscriptions,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the Zoho Subscriptions on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    organizationId: {
      propDefinition: [
        zohoSubscriptions,
        "organizationId",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate");
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent(maxResults) {
      const lastDate = this._getLastDate();
      let responseArray = [];

      const items = this.zohoSubscriptions.paginate({
        fn: this.zohoSubscriptions.listEvents,
        params: {
          event_type: "payment_declined",
          date_start: lastDate || "1970-01-01",
          date_end: moment().format("YYYY-MM-DD"),
        },
        organizationId: this.organizationId,
        maxResults,
      });

      for await (const item of items) {
        responseArray.push(item);
      }

      if (responseArray[0]) {
        this._setLastDate(responseArray[0].event_time);
      }

      for (const responseItem of responseArray.reverse()) {
        const event = await this.zohoSubscriptions.getEvent({
          eventId: responseItem.event_id,
          organizationId: this.organizationId,
        });

        this.$emit(
          event,
          {
            id: responseItem.event_id,
            summary: `New event with id: "${responseItem.event_id}" was created!`,
            ts: new Date(),
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Zoho Billing	`zohoSubscriptions`	`app`	This component uses the Zoho Billing app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Zoho Subscriptions on this schedule
Organization Id	`organizationId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Zoho Billing uses OAuth authentication. When you connect your Zoho Billing account, Pipedream will open a popup window where you can sign into Zoho Billing and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Zoho Billing API.

Pipedream requests the following authorization scopes when you connect your account:

ZohoSubscriptions.fullaccess.all

About Zoho Billing#

Subscription billing software, crafted for growing businesses.

Action#

Cancel Subscription on ReCharge

Description:Cancels an existing subscription. [See the documentation](https://developer.rechargepayments.com/2021-11/subscriptions/subscriptions_cancel)

Version:0.0.1

Key:recharge-cancel-subscription

View on GitHub

ReCharge Overview#

The ReCharge API offers a programmatic entrance to the ReCharge ecosystem, a place where subscription-based e-commerce is managed with ease. Whether you're looking to synchronize customer data, manage subscriptions, or automate notifications, the API's endpoints enable you to seamlessly integrate subscription data into your business processes. With Pipedream's serverless execution model, you can craft workflows that respond to events in ReCharge, manipulate and route data, and trigger actions across your entire software stack. This opens doors to personalized customer experiences, streamlined operations, and data-driven decision-making.

Action Code#

import recharge from "../../recharge.app.mjs";

export default {
  key: "recharge-cancel-subscription",
  name: "Cancel Subscription",
  description: "Cancels an existing subscription. [See the documentation](https://developer.rechargepayments.com/2021-11/subscriptions/subscriptions_cancel)",
  version: "0.0.1",
  type: "action",
  props: {
    recharge,
    subscriptionId: {
      propDefinition: [
        recharge,
        "subscriptionId",
      ],
    },
    cancellationReason: {
      type: "string",
      label: "Cancellation Reason",
      description: "Reason for subscription cancellation.",
    },
    cancellationReasonComment: {
      type: "string",
      label: "Cancellation Reason Comment",
      description: "Cancellation reason comment. Maximum length is 1024 characters.",
      optional: true,
    },
    sendEmail: {
      type: "boolean",
      label: "Send Email",
      description: "If set to `false`, subscription cancelled email will not be sent to customer and store owner.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.recharge.cancelSubscription({
      $,
      subscriptionId: this.subscriptionId,
      data: {
        cancellation_reason: this.cancellationReason,
        cancellation_reason_comments: this.cancellationReasonComment,
        send_email: this.sendEmail,
      },
    });
    $.export("$summary", `Successfully cancelled subscription ${this.subscriptionId}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
ReCharge	`recharge`	`app`	This component uses the ReCharge app.
Subscription ID	`subscriptionId`	`string`	Select a value from the drop down menu.
Cancellation Reason	`cancellationReason`	`string`	Reason for subscription cancellation.
Cancellation Reason Comment	`cancellationReasonComment`	`string`	Cancellation reason comment. Maximum length is 1024 characters.
Send Email	`sendEmail`	`boolean`	If set to `false`, subscription cancelled email will not be sent to customer and store owner.

Cancel Subscription with ReCharge API on New Payment Failure from Zoho Billing API

Pipedream makes it easy to connect APIs for ReCharge, Zoho Billing and 2,700+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular