Create Invoice with Stripe API on New Order Created (Instant) from Shopify API

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

Trigger workflow on

New Order Created (Instant) from the Shopify API

Next, do this

Create Invoice 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 Shopify 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 Order Created (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Create Invoice action
1. Connect your Stripe account
2. Select a Customer ID
3. Optional- Select a Subscription ID
4. Optional- Configure Description
5. Optional- Configure Auto Collect
6. Optional- Select a Collection Method
7. Optional- Configure Payment Terms
8. Optional- Select a Default Payment Method
9. Optional- Configure Metadata
10. Optional- Configure Advanced Options
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 Order Created (Instant) on Shopify

Description:Emit new event for each new order submitted to a store.

Version:0.0.4

Key:shopify_developer_app-new-order-created

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-order-created",
  name: "New Order Created (Instant)",
  type: "source",
  description: "Emit new event for each new order submitted to a store.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.ORDERS_CREATE;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.created_at);
      return {
        id: resource.id,
        summary: `New Order ${resource.id}.`,
        ts,
      };
    },
  },
  hooks: {
    ...common.hooks,
    async deploy() {
      let results = await this.app.getOrders("any", false, null, null, "any", 5, 1);
      for (const order of results) {
        this.$emit(order, this.generateMeta(order));
      }
    },
  },
};

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
Shopify	`app`	`app`	This component uses the Shopify 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.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

Action#

Create Invoice on Stripe

Description:Create an invoice. [See the docs](https://stripe.com/docs/api/invoices/create) for more information

Version:0.1.0

Key:stripe-create-invoice

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 pick from "lodash.pick";
import app from "../../stripe.app.mjs";

export default {
  key: "stripe-create-invoice",
  name: "Create Invoice",
  type: "action",
  version: "0.1.0",
  description: "Create an invoice. [See the docs](https://stripe.com/docs/api/invoices/create) " +
    "for more information",
  props: {
    app,
    customer: {
      propDefinition: [
        app,
        "customer",
      ],
      optional: false,
    },
    subscription: {
      propDefinition: [
        app,
        "subscription",
        ({ customer }) => ({
          customer,
        }),
      ],
    },
    description: {
      propDefinition: [
        app,
        "description",
      ],
    },
    auto_advance: {
      propDefinition: [
        app,
        "invoice_auto_advance",
      ],
    },
    collection_method: {
      propDefinition: [
        app,
        "invoice_collection_method",
      ],
      default: "charge_automatically",
      description: "When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.",
    },
    days_until_due: {
      propDefinition: [
        app,
        "invoice_days_until_due",
      ],
    },
    default_payment_method: {
      propDefinition: [
        app,
        "payment_method",
        ({ customer }) => ({
          customer,
        }),
      ],
      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",
      ],
    },
    advanced: {
      propDefinition: [
        app,
        "metadata",
      ],
      label: "Advanced Options",
      description: "Add any additional parameters that you require here",
    },
  },
  async run({ $ }) {
    const resp = await this.app.sdk().invoices.create({
      ...pick(this, [
        "customer",
        "subscription",
        "auto_advance",
        "description",
        "collection_method",
        "days_until_due",
        "default_payment_method",
        "metadata",
      ]),
      ...this.advanced,
    });

    $.export("$summary", "Successfully created a new invoice");

    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.
Subscription ID	`subscription`	`string`	Select a value from the drop down menu.
Description	`description`	`string`
Auto Collect	`auto_advance`	`boolean`	Attempt to automatically collect the invoice. When disabled, the invoice's state will not automatically advance without an explicit action.
Collection Method	`collection_method`	`string`	Select a value from the drop down menu:`charge_automaticallysend_invoice`
Payment Terms	`days_until_due`	`integer`	The number of days until the invoice is due (valid when collection method is `send_invoice`)
Default Payment Method	`default_payment_method`	`string`	Select a value from the drop down menu.
Metadata	`metadata`	`object`	Associate other information that's meaningful to you with Stripe activity. Metadata will not be shown to customers or affect whether or not a payment is accepted.
Advanced Options	`advanced`	`object`	Add any additional parameters that you require here

Action Authentication#

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

Stripe uses API keys to authenticate requests (more info in their docs here).

To connect Pipedream to your Stripe account,

Create a Stripe API key
Click "Create Restricted Key"
Enter the Restricted API key below.

To help ensure proper security, we recommend you create a Restricted key with scopes relevant to the specific operations you will use in Pipedream.

Create Invoice with Stripe API on New Order Created (Instant) from Shopify API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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