Create Subscription with ReCharge API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Create a workflow to Create Subscription with the ReCharge 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 ReCharge account
2. Select a Address ID
3. Configure Charge Interval Frequency
4. Configure Next Charge Scheduled At
5. Configure Order Interval Frequency
6. Select a Order Interval Unit
7. Configure Quantity
8. Select a External Variant ID
9. Configure Additional Options
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 ReCharge API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + ReCharge

Try it

Create Subscription with ReCharge API on New Submission from Typeform API

Typeform + ReCharge

Try it

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

Jotform + ReCharge

Try it

Create Subscription with ReCharge API on New Scheduled Tasks from Pipedream API

Pipedream + ReCharge

Try it

Create Subscription with ReCharge API on npm Download Counts from npm API

npm + ReCharge

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 ReCharge

Description:Creates a new subscription allowing a customer to subscribe to a product. [See the documentation](https://developer.rechargepayments.com/2021-11/subscriptions/subscriptions_create)

Version:0.0.1

Key:recharge-create-subscription

View on GitHub

Code#

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

export default {
  key: "recharge-create-subscription",
  name: "Create Subscription",
  description: "Creates a new subscription allowing a customer to subscribe to a product. [See the documentation](https://developer.rechargepayments.com/2021-11/subscriptions/subscriptions_create)",
  version: "0.0.1",
  type: "action",
  props: {
    recharge,
    addressId: {
      propDefinition: [
        recharge,
        "addressId",
      ],
    },
    chargeIntervalFrequency: {
      type: "integer",
      label: "Charge Interval Frequency",
      description: "The number of units, specified in `Order Interval Unit`, between each charge.",
    },
    nextChargeScheduledAt: {
      type: "string",
      label: "Next Charge Scheduled At",
      description: "This will set the first charge date of a new subscription. Can be a date string such as `2021-12-17`.",
    },
    orderIntervalFrequency: {
      type: "integer",
      label: "Order Interval Frequency",
      description: "The number of units, specified in `Order Interval Unit`, between each order.",
    },
    orderIntervalUnit: {
      type: "string",
      label: "Order Interval Unit",
      description: "The frequency unit used to determine when a subscription order is created.",
      options: [
        "day",
        "week",
        "month",
      ],
    },
    quantity: {
      type: "integer",
      label: "Quantity",
      description: "The quantity of the product.",
    },
    externalVariantId: {
      propDefinition: [
        recharge,
        "externalVariantId",
      ],
    },
    additionalOptions: {
      type: "object",
      label: "Additional Options",
      description: "Additional parameters to be passed in the request. [See the documentation](https://developer.rechargepayments.com/2021-11/subscriptions/subscriptions_create) for all available parameters.",
    },
  },
  async run({ $ }) {
    const response = await this.recharge.createSubscription({
      $,
      data: {
        address_id: this.addressId,
        charge_interval_frequency: this.chargeIntervalFrequency,
        next_charge_scheduled_at: this.nextChargeScheduledAt,
        order_interval_frequency: this.orderIntervalFrequency,
        order_interval_unit: this.orderIntervalUnit,
        quantity: this.quantity,
        external_variant_id: this.externalVariantId && {
          ecommerce: this.externalVariantId,
        },
        ...Object.fromEntries(Object.entries(this.additionalOptions).map(([
          key,
          value,
        ]) => {
          try {
            value = JSON.parse(value);
          } catch (e) {
            e; // JSON parsing is optional
          }

          return [
            key,
            value,
          ];
        })),
      },
    });

    $.export("$summary", `Successfully created a new subscription with ID ${response?.subscription?.id}`);
    return response;
  },
};

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
ReCharge	`recharge`	`app`	This component uses the ReCharge app.
Address ID	`addressId`	`string`	Select a value from the drop down menu.
Charge Interval Frequency	`chargeIntervalFrequency`	`integer`	The number of units, specified in `Order Interval Unit`, between each charge.
Next Charge Scheduled At	`nextChargeScheduledAt`	`string`	This will set the first charge date of a new subscription. Can be a date string such as `2021-12-17`.
Order Interval Frequency	`orderIntervalFrequency`	`integer`	The number of units, specified in `Order Interval Unit`, between each order.
Order Interval Unit	`orderIntervalUnit`	`string`	Select a value from the drop down menu:`dayweekmonth`
Quantity	`quantity`	`integer`	The quantity of the product.
External Variant ID	`externalVariantId`	`string`	Select a value from the drop down menu.
Additional Options	`additionalOptions`	`object`	Additional parameters to be passed in the request. See the documentation for all available parameters.