Create Subscription with ProfitWell API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create 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#

Create a workflow to Create Subscription with the ProfitWell API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Subscription action
1. Connect your ProfitWell account
2. Optional- Configure User ID
3. Optional- Configure User Alias
4. Optional- Configure Subscription Alias
5. Configure Email Address
6. Configure Plan ID
7. Select a Plan Interval
8. Optional- Configure Plan Currency
9. Optional- Select a Status
10. Configure Value
11. Configure Effective Date
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Subscription with ProfitWell API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ProfitWell

Try it

Create Subscription with ProfitWell API on New Message in Channel from Discord Bot API

Discord Bot + ProfitWell

Try it

Create Subscription with ProfitWell API on New Submission from Typeform API

Typeform + ProfitWell

Try it

Create Subscription with ProfitWell API on Custom Events from Zoom API

Zoom + ProfitWell

Try it

Create Subscription with ProfitWell API on New Submission (Instant) from Jotform API

Jotform + ProfitWell

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Subscription on ProfitWell

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

Version:0.0.1

Key:profitwell-create-subscription

View on GitHub

Code#

import profitwell from "../../app/profitwell.app.mjs";
import { defineAction } from "@pipedream/types";
import { EffectiveDateDescription } from "../../common/propDescriptions.mjs";
export default defineAction({
    name: "Create Subscription",
    description: "Create a subscription [See docs here](https://profitwellapiv2.docs.apiary.io/#/reference/manually-added-customers/creating-subscriptions/create-a-subscription)",
    key: "profitwell-create-subscription",
    version: "0.0.1",
    type: "action",
    props: {
        profitwell,
        userId: {
            type: "string",
            label: "User ID",
            description: "Only use if you are referencing an existing user for whom you need to create an additional subscription.",
            optional: true,
        },
        userAlias: {
            type: "string",
            label: "User Alias",
            description: "For a new user, you can include your own identifier here. If creating a subscription for an existing user, this can be used instead of `User ID`.",
            optional: true,
        },
        subscriptionAlias: {
            type: "string",
            label: "Subscription Alias",
            description: `If included, you can use this to reference the subscription later, instead of its ID.
        \\
        Note that this alias must be **unique** across all users in your company, and cannot contain more than **36 characters**.`,
            optional: true,
        },
        email: {
            type: "string",
            label: "Email Address",
            description: "The email address of the user. This will be the display text that is used on the Customers tab.",
        },
        planId: {
            propDefinition: [
                profitwell,
                "planId",
            ],
        },
        planInterval: {
            propDefinition: [
                profitwell,
                "planInterval",
            ],
        },
        planCurrency: {
            type: "string",
            label: "Plan Currency",
            description: "The currency in which users of this plan are charged. [See the docs](https://profitwellapiv2.docs.apiary.io/#/reference/manually-added-customers/creating-subscriptions/create-a-subscription) for the full list of accepted currency codes.",
            optional: true,
            default: "usd",
        },
        status: {
            type: "string",
            label: "Status",
            optional: true,
            options: [
                "active",
                "trialing",
            ],
            default: "active",
        },
        value: {
            propDefinition: [
                profitwell,
                "value",
            ],
        },
        effectiveDate: {
            propDefinition: [
                profitwell,
                "effectiveDate",
            ],
            description: EffectiveDateDescription("the subscription starts"),
        },
    },
    async run({ $ }) {
        const params = {
            $,
            data: {
                effective_date: this.profitwell.getUnixTimestamp(this.effectiveDate),
                email: this.email,
                plan_id: this.planId,
                plan_interval: this.planInterval,
                value: this.value,
                plan_currency: this.planCurrency,
                status: this.status,
                subscription_alias: this.subscriptionAlias,
                user_alias: this.userAlias,
                user_id: this.userId,
            },
        };
        const data = await this.profitwell.createSubscription(params);
        const label = this.profitwell.getSubscriptionLabel(data);
        $.export("$summary", `Successfully created subscription ${label}`);
        return data;
    },
});

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
ProfitWell	`profitwell`	`app`	This component uses the ProfitWell app.
User ID	`userId`	`string`	Only use if you are referencing an existing user for whom you need to create an additional subscription.
User Alias	`userAlias`	`string`	For a new user, you can include your own identifier here. If creating a subscription for an existing user, this can be used instead of `User ID`.
Subscription Alias	`subscriptionAlias`	`string`	If included, you can use this to reference the subscription later, instead of its ID. Note that this alias must be unique across all users in your company, and cannot contain more than 36 characters.
Email Address	`email`	`string`	The email address of the user. This will be the display text that is used on the Customers tab.
Plan ID	`planId`	`string`	The ID of the plan that the user is on. For the sake of consistency (and the ability to later segment your data), this name should be consistent across everyone who is on this plan.
Plan Interval	`planInterval`	`string`	Select a value from the drop down menu:`monthyear`
Plan Currency	`planCurrency`	`string`	The currency in which users of this plan are charged. See the docs for the full list of accepted currency codes.
Status	`status`	`string`	Select a value from the drop down menu:`activetrialing`
Value	`value`	`integer`	The amount that you bill your user, per billing period, in cents.
Effective Date	`effectiveDate`	`string`	UNIX timestamp (in seconds) of when the subscription starts. 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`

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,