Cancel Subscription with ReCharge API on New Tracking Event (Instant) from Shipengine API

Pipedream makes it easy to connect APIs for ReCharge, Shipengine and 2,500+ other apps remarkably fast.

Trigger workflow on

New Tracking Event (Instant) from the Shipengine 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 Shipengine 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 Tracking Event (Instant) trigger
1. Connect your Shipengine account
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 Tracking Event (Instant) on Shipengine

Description:Emit new event when a new event is tracked. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/create_webhook).

Version:0.0.2

Key:shipengine-new-tracking-event

View on GitHub

Shipengine Overview#

The Shipengine API enables robust automation possibilities for shipping logistics. From label creation, rate comparison, to tracking shipments, the API provides the tools to streamline e-commerce and shipping workflows. By harnessing Shipengine's capabilities through Pipedream, you can build seamless integrations that connect your shipping operations with other business processes, enhancing efficiency and reducing manual overhead.

Trigger Code#

import common from "../common/webhook.mjs";

export default {
  ...common,
  key: "shipengine-new-tracking-event",
  name: "New Tracking Event (Instant)",
  description: "Emit new event when a new event is tracked. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/create_webhook).",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEvent() {
      return "track";
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.occurred_at);
      return {
        id: ts,
        ts,
        summary: `New Tracking Event at ${resource.occurred_at}`,
      };
    },
    processEvents(response) {
      const {
        events: resources,
        ...otherProps
      } = response;

      resources
        .reverse()
        .forEach((resource) =>
          this.$emit({
            ...otherProps,
            ...resource,
          }, this.generateMeta(resource)));
    },
  },
};

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
Shipengine	`app`	`app`	This component uses the Shipengine app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

Shipengine uses API keys for authentication. When you connect your Shipengine account, Pipedream securely stores the keys so you can easily authenticate to Shipengine APIs in both code and no-code steps.

Get your API key in the API Management section

About Shipengine#

Shipping API & multi carrier shipping system

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.

Action Authentication#

ReCharge uses API keys for authentication. When you connect your ReCharge account, Pipedream securely stores the keys so you can easily authenticate to ReCharge APIs in both code and no-code steps.

ReCharge uses API keys to authenticate requests. See docs.
Scopes can be set up from the API token edit page to control the level of access.

About ReCharge#

Subscriptions & Recurring Payments for Ecommerce

More Ways to Connect ReCharge + Shipengine#

Other Popular Integrations#

Cancel Subscription with ReCharge API on New Shipping Label Created from Shipengine API

Shipengine + ReCharge

Cancel Subscription with ReCharge API on New Tracking Event (Instant) from Shipengine API

Pipedream makes it easy to connect APIs for ReCharge, Shipengine and 2,500+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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