← Stripe

Create a Usage Record with Stripe API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create a Usage Record with the Stripe API
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

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

  1. Configure the Create a Usage Record action
    1. Connect your Stripe account
    2. Optional- Select a Customer ID
    3. Optional- Select a Price ID
    4. Select a Subscription ID
    5. Select a Subscription Item ID
    6. Optional- Configure Timestamp
    7. Configure Quantity
    8. Optional- Select a Action
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source 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 a Usage Record on Stripe
Description:With metered billing, you charge your customers based on their consumption of your service during the billing cycle, instead of explicitly setting quantities. Use this action to create a usage record for metered billing. [See the docs](https://stripe.com/docs/api/usage_records/create) for more information
Version:0.0.2
Key:stripe-create-usage-record

Code

const pick = require("lodash.pick");
const { STRIPE_PRICE_TYPE } = require("../../constants.js");
const stripe = require("../../stripe.app.js");

module.exports = {
  key: "stripe-create-usage-record",
  name: "Create a Usage Record",
  type: "action",
  version: "0.0.2",
  description: "With metered billing, you charge your customers based on their consumption of " +
    "your service during the billing cycle, instead of explicitly setting quantities. Use this " +
    " action to create a usage record for metered billing. [See the " +
    "docs](https://stripe.com/docs/api/usage_records/create) for more information",
  props: {
    stripe,
    // Used to filter subscription
    customer: {
      "propDefinition": [
        stripe,
        "customer",
      ],
    },
    // Used to filter subscription
    price: {
      "propDefinition": [
        stripe,
        "price",
        () => ({
          // Only `recurring` prices can be used to filter subscriptions
          type: STRIPE_PRICE_TYPE.RECURRING,
        }),
      ],
    },
    // Required to select subscription item
    subscription: {
      "propDefinition": [
        stripe,
        "subscription",
        ({
          customer, price,
        }) => ({
          customer,
          price,
        }),
      ],
      "optional": false,
    },
    id: {
      "propDefinition": [
        stripe,
        "subscription_item",
        ({ subscription }) => ({
          subscription,
        }),
      ],
      "optional": false,
    },
    timestamp: {
      "propDefinition": [
        stripe,
        "timestamp",
      ],
      "optional": true,
      "description": "The timestamp for the usage event. This timestamp must be within the " +
        "current billing period of the subscription of the provided subscription item. When " +
        "passing `now`, Stripe records usage for the current time. Default is `now` if a value " +
        "is not provided.",
    },
    quantity: {
      "propDefinition": [
        stripe,
        "quantity",
      ],
      "optional": false,
      "description": "The usage quantity for the specified timestamp",
    },
    action: {
      propDefinition: [
        stripe,
        "usage_record_action",
      ],
    },
  },
  async run({ $ }) {
    const data = pick(this, [
      "timestamp",
      "quantity",
      "action",
    ]);
    const resp = await this.stripe.sdk().subscriptionItems.createUsageRecord(this.id, data);
    $.export("$summary", `Successfully created a new usage record for subscription item, 
    "${resp.subscription_item}", with a usage quantity of ${resp.quantity}`);
    return resp;
  },
};

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.
LabelPropTypeDescription
StripestripeappThis component uses the Stripe app.
Customer IDcustomerstringSelect a value from the drop down menu.
Price IDpricestringSelect a value from the drop down menu.
Subscription IDsubscriptionstringSelect a value from the drop down menu.
Subscription Item IDidstringSelect a value from the drop down menu.
Timestamptimestampinteger

The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided subscription item. When passing now, Stripe records usage for the current time. Default is now if a value is not provided.

Quantityquantityinteger

The usage quantity for the specified timestamp

ActionactionstringSelect a value from the drop down menu:incrementset

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.

Create and retrieve API keys to connect your Stripe account from https://dashboard.stripe.com/apikeys.

About Stripe

Payment Platform

More Ways to Use Stripe

Triggers

Actions

Cancel a Payment Intent with the Stripe API

Cancel a payment intent. Once canceled, no additional charges will be made by the payment intent and any operations on the payment intent will fail with an error. For payment intents with status=requires_capture, the remaining amount_capturable will automatically be refunded. See the docs for more information

 
Try it
Cancel Or Reverse a Payout with the Stripe API

Cancel or reverse a payout. A payout can be canceled only if it has not yet been paid out. A payout can be reversed only if it has already been paid out. Funds will be refunded to your available balance. See the docs for more information

 
Try it

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.