Create Subscription with Stripe API on New Device Return Order from Retriever API

Pipedream makes it easy to connect APIs for Stripe, Retriever and 2,700+ other apps remarkably fast.

Trigger workflow on

New Device Return Order from the Retriever API

Next, do this

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

Select this integration
Configure the New Device Return Order trigger
1. Connect your Retriever account
2. Configure Polling schedule
Configure the Create Subscription action
1. Connect your Stripe account
2. Select a Customer ID
3. Select one or more Price ID
4. Optional- Select a Country
5. Optional- Select a Currency
6. Optional- Configure Description
7. Optional- Select a Collection Method
8. Optional- Configure Days Until Due
9. Optional- Select a Payment Method Types
10. Optional- Select a Default Payment Method
11. Optional- Configure Metadata
12. Optional- Configure Automatic Tax Enabled
13. Optional- Select a Automatic Tax - Liability - Type
14. Optional- Configure Automatic Tax - Liability - Account
15. Optional- Select a Payment Behavior
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 Device Return Order on Retriever

Description:Triggers when a new device return order is created. [See the documentation](https://app.helloretriever.com/api/v1/docs/#tag/Device-Return-Orders/operation/List%20Orders)

Version:0.0.1

Key:retriever-new-device-return-order

View on GitHub

Retriever Overview#

The Retriever API is designed for automating contact information retrieval, enriching your CRM data, or building lead generation tools. By integrating it with Pipedream, you can strategically extract valuable data and automate workflows for marketing, sales, or customer support. Pipedream’s serverless platform enables you to connect Retriever with hundreds of other apps, triggering actions based on new data, or updating systems in real-time.

Trigger Code#

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

export default {
  ...common,
  key: "retriever-new-device-return-order",
  name: "New Device Return Order",
  description: "Triggers when a new device return order is created. [See the documentation](https://app.helloretriever.com/api/v1/docs/#tag/Device-Return-Orders/operation/List%20Orders)",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourceName() {
      return "results";
    },
    getResourceFn() {
      return this.app.listOrders;
    },
    getResourceFnArgs() {
      return;
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Order: ${resource.id}`,
        ts: Date.parse(resource.created_at),
      };
    },
  },
};

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
Retriever	`app`	`app`	This component uses the Retriever app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling schedule	`timer`	`$.interface.timer`	How often to poll the API

Trigger Authentication#

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

About Retriever#

Easy laptop and monitor returns for employee offboarding, upgrades, and repairs.

Action#

Create Subscription on Stripe

Description:Create a subscription. [See the documentation](https://stripe.com/docs/api/subscriptions/create).

Version:0.1.4

Key:stripe-create-subscription

View on GitHub

Stripe Overview#

The Stripe API is a powerful tool for managing online payments, subscriptions, and invoices. With Pipedream, you can leverage this API to automate payment processing, monitor transactions, and sync billing data with other services. Pipedream's no-code platform allows for quick integration and creation of serverless workflows that react to Stripe events in real-time. For instance, you might automatically update customer records, send personalized emails after successful payments, or escalate failed transactions to your support team.

Action Code#

import app from "../../stripe.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "stripe-create-subscription",
  name: "Create Subscription",
  type: "action",
  version: "0.1.4",
  description: "Create a subscription. [See the documentation](https://stripe.com/docs/api/subscriptions/create).",
  props: {
    app,
    customer: {
      propDefinition: [
        app,
        "customer",
      ],
      optional: false,
    },
    items: {
      propDefinition: [
        app,
        "price",
      ],
      optional: false,
      type: "string[]",
    },
    country: {
      propDefinition: [
        app,
        "country",
      ],
      optional: true,
    },
    currency: {
      propDefinition: [
        app,
        "currency",
        ({ country }) => ({
          country,
        }),
      ],
      optional: true,
    },
    description: {
      propDefinition: [
        app,
        "description",
      ],
    },
    collectionMethod: {
      description: "Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active. Defaults to charge_automatically.",
      propDefinition: [
        app,
        "collectionMethod",
      ],
    },
    daysUntilDue: {
      description: "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.",
      propDefinition: [
        app,
        "daysUntilDue",
      ],
    },
    paymentType: {
      type: "string",
      propDefinition: [
        app,
        "paymentMethodTypes",
      ],
      optional: true,
    },
    defaultPaymentMethod: {
      propDefinition: [
        app,
        "paymentMethod",
        (c) => ({
          customer: c.customer,
          type: c.paymentType,
        }),
      ],
      label: "Default Payment Method",
      description: "Must belong to the customer associated with the invoice. If not set, " +
        "defaults to the subscription’s default payment method, if any, or to the default " +
        "payment method in the customer’s invoice settings.",
    },
    metadata: {
      propDefinition: [
        app,
        "metadata",
      ],
    },
    automaticTaxEnabled: {
      type: "boolean",
      label: "Automatic Tax Enabled",
      description: "Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.",
      optional: true,
    },
    automaticTaxLiabilityType: {
      type: "string",
      label: "Automatic Tax - Liability - Type",
      description: "Type of the account referenced in the request.",
      optional: true,
      options: [
        "account",
        "self",
      ],
    },
    automaticTaxLiabilityAccount: {
      type: "string",
      label: "Automatic Tax - Liability - Account",
      description: "The connected account being referenced when **Automatic Tax - Liability - Type** is account.",
      optional: true,
    },
    paymentBehavior: {
      type: "string",
      label: "Payment Behavior",
      description: "Specifies whether to create the subscription in the incomplete or active state. Only applies to subscriptions when **Collection Method** is set to `charge_automatically`. [See the documentation](https://docs.stripe.com/api/subscriptions/create#create_subscription-payment_behavior).",
      optional: true,
      options: [
        "allow_incomplete",
        "default_incomplete",
        "error_if_incomplete",
        "pending_if_incomplete",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      customer,
      items,
      currency,
      description,
      collectionMethod,
      daysUntilDue,
      defaultPaymentMethod,
      metadata,
      automaticTaxEnabled,
      automaticTaxLiabilityType,
      automaticTaxLiabilityAccount,
      paymentBehavior,
    } = this;

    const resp = await app.sdk().subscriptions.create({
      customer,
      default_payment_method: defaultPaymentMethod,
      collection_method: collectionMethod,
      days_until_due: daysUntilDue,
      payment_behavior: paymentBehavior,
      metadata: utils.parseJson(metadata),
      description,
      currency,
      ...(automaticTaxEnabled
        ? {
          automatic_tax: {
            enabled: automaticTaxEnabled,
            ...(automaticTaxLiabilityType && {
              liability: {
                type: automaticTaxLiabilityType,
                ...(automaticTaxLiabilityAccount && {
                  account: automaticTaxLiabilityAccount,
                }),
              },
            }),
          },
        }
        : {}),
      items: utils.parseArray(items).map((price) => ({
        price,
      })),
    });

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

    return resp;
  },
};

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
Stripe	`app`	`app`	This component uses the Stripe app.
Customer ID	`customer`	`string`	Select a value from the drop down menu.
Price ID	`items`	`string[]`	Select a value from the drop down menu.
Country	`country`	`string`	Select a value from the drop down menu.
Currency	`currency`	`string`	Select a value from the drop down menu.
Description	`description`	`string`	An arbitrary string that you can attach to a the object eg. customer, invoice, etc.
Collection Method	`collectionMethod`	`string`	Select a value from the drop down menu:`charge_automaticallysend_invoice`
Days Until Due	`daysUntilDue`	`integer`	Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.
Payment Method Types	`paymentType`	`string`	Select a value from the drop down menu:`acss_debitalipayau_becs_debitbancontactcardcard_presentepsgiropayidealinterac_presentp24sepa_debitsofort`
Default Payment Method	`defaultPaymentMethod`	`string`	Select a value from the drop down menu.
Metadata	`metadata`	`object`	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
Automatic Tax Enabled	`automaticTaxEnabled`	`boolean`	Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
Automatic Tax - Liability - Type	`automaticTaxLiabilityType`	`string`	Select a value from the drop down menu:`accountself`
Automatic Tax - Liability - Account	`automaticTaxLiabilityAccount`	`string`	The connected account being referenced when Automatic Tax - Liability - Type is account.
Payment Behavior	`paymentBehavior`	`string`	Select a value from the drop down menu:`allow_incompletedefault_incompleteerror_if_incompletepending_if_incomplete`

Create Subscription with Stripe API on New Device Return Order from Retriever API

Pipedream makes it easy to connect APIs for Stripe, Retriever 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