Churn Subscription with ProfitWell API on New Subscription Cancelled from Lemon Squeezy API

Pipedream makes it easy to connect APIs for ProfitWell, Lemon Squeezy and 2,400+ other apps remarkably fast.

Trigger workflow on

New Subscription Cancelled from the Lemon Squeezy API

Next, do this

Churn Subscription with the ProfitWell 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 Lemon Squeezy trigger and ProfitWell action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Subscription Cancelled trigger
1. Connect your Lemon Squeezy account
2. Configure timer
Configure the Churn Subscription action
1. Connect your ProfitWell account
2. Configure Subscription ID or Alias
3. Configure Effective Date
4. Select a Churn Type
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 Subscription Cancelled on Lemon Squeezy

Description:Emit new event when a new subscription is cancelled.

Version:0.0.1

Key:lemon_squeezy-subscription-cancelled

View on GitHub

Lemon Squeezy Overview#

The Lemon Squeezy API lets you manage and sell digital products with ease. On Pipedream, you can integrate Lemon Squeezy with your sales, marketing, and support tools to automate tasks like customer follow-ups, license management, and sales reporting. With Pipedream's serverless platform, you can create workflows that trigger on Lemon Squeezy events or schedule tasks, process data, and connect to a vast array of other apps and services without writing backend infrastructure.

Trigger Code#

import { defineSource } from "@pipedream/types";
import moment from "moment";
import common from "../common/base.mjs";
export default defineSource({
    ...common,
    key: "lemon_squeezy-subscription-cancelled",
    name: "New Subscription Cancelled",
    description: "Emit new event when a new subscription is cancelled.",
    version: "0.0.1",
    type: "source",
    dedupe: "unique",
    methods: {
        ...common.methods,
        setLastEnd(lastEnd) {
            this.db.set("lastEnd", lastEnd);
        },
        getLastEnd() {
            return this.db.get("lastEnd") || 0;
        },
        async startEvent(maxResults) {
            const lastEnd = this.getLastEnd();
            const responseArray = [];
            let tempLastEnd = lastEnd;
            const items = this.lemonSqueezy.paginate({
                fn: this.lemonSqueezy.listSubscriptions,
                params: {
                    sort: "-endsAt",
                },
                maxResults,
            });
            for await (const item of items) {
                const newLastEnd = item.attributes.ends_at;
                if (item.attributes.ends_at
                    && moment(newLastEnd).isAfter(lastEnd)
                    && item.attributes.cancelled) {
                    responseArray.push(item);
                    if (moment(newLastEnd).isAfter(tempLastEnd)) {
                        tempLastEnd = newLastEnd;
                    }
                }
                else {
                    break;
                }
            }
            if (!moment(lastEnd).isSame(tempLastEnd))
                this.setLastEnd(tempLastEnd);
            for (const responseItem of responseArray.reverse()) {
                this.$emit(responseItem, {
                    id: responseItem.id,
                    summary: `A new subscription with id ${responseItem.id} was cancelled!`,
                    ts: responseItem.createdAt,
                });
            }
        },
    },
});

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
Lemon Squeezy	`lemonSqueezy`	`app`	This component uses the Lemon Squeezy app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

To connect Pipedream with your Lemon Squeezy account,

Sign in to your Lemon Squeezy account
Create a new API key here
Paste that below

About Lemon Squeezy#

Lemon Squeezy is the all-in-one platform for running your SaaS business. Payments, subscriptions, global tax compliance, fraud prevention, multi-currency support, failed payment recovery, PayPal integration and more. We make running your software business easy peasy.

Action#

Churn Subscription on ProfitWell

Description:Churn a subscription [See docs here](https://profitwellapiv2.docs.apiary.io/#/reference/manually-added-customers/updating-subscriptions/churn-a-subscription)

Version:0.0.1

Key:profitwell-churn-subscription

View on GitHub

ProfitWell Overview#

The ProfitWell API provides programmatic access to metrics and data related to subscription-based businesses. By integrating with Pipedream, you can automate complex workflows involving your financial metrics, customer insights, and growth tracking. Whether it's syncing subscriber data with marketing platforms, triggering alerts based on revenue milestones, or creating custom analytics dashboards, Pipedream's serverless platform enables you to connect ProfitWell with a plethora of other services without writing extensive code.

Action Code#

import profitwell from "../../app/profitwell.app.mjs";
import { defineAction } from "@pipedream/types";
import { EffectiveDateDescription } from "../../common/propDescriptions.mjs";
export default defineAction({
    name: "Churn Subscription",
    description: "Churn a subscription [See docs here](https://profitwellapiv2.docs.apiary.io/#/reference/manually-added-customers/updating-subscriptions/churn-a-subscription)",
    key: "profitwell-churn-subscription",
    version: "0.0.1",
    type: "action",
    props: {
        profitwell,
        subscriptionIdOrAlias: {
            propDefinition: [
                profitwell,
                "subscriptionIdOrAlias",
            ],
        },
        effectiveDate: {
            propDefinition: [
                profitwell,
                "effectiveDate",
            ],
            description: EffectiveDateDescription("the subscription churns"),
        },
        churnType: {
            type: "string",
            label: "Churn Type",
            options: [
                "voluntary",
                "delinquent",
            ],
            default: "voluntary",
        },
    },
    async run({ $ }) {
        const params = {
            $,
            subscriptionIdOrAlias: this.subscriptionIdOrAlias,
            params: {
                churn_type: this.churnType,
                effective_date: this.profitwell.getUnixTimestamp(this.effectiveDate),
            },
        };
        const data = await this.profitwell.churnSubscription(params);
        const label = this.profitwell.getSubscriptionLabel(data);
        $.export("$summary", `Successfully churned subscription ${label}`);
        return data;
    },
});

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
ProfitWell	`profitwell`	`app`	This component uses the ProfitWell app.
Subscription ID or Alias	`subscriptionIdOrAlias`	`string`	Either the `subscription_id` or `subscription_alias` of the subscription
Effective Date	`effectiveDate`	`string`	UNIX timestamp (in seconds) of when the subscription churns. You can also provide a valid date/time string and Pipedream will automatically convert it to a UNIX timestamp. Examples: `1644933600` `2022-02-15` `2022-02-15T14:00Z`
Churn Type	`churnType`	`string`	Select a value from the drop down menu:`voluntarydelinquent`

Action Authentication#

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

To retrieve your API token,