Create Or Update Subscription with SegMetrics API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Create Or Update Subscription action
1. Connect your SegMetrics account
2. Configure Integration ID
3. Configure Subscription Id
4. Configure Contact's Email
5. Configure Subscription Total in Cents
6. Configure Product ID
7. Configure Start Date
8. Configure Last Bill Date
9. Select a Billing Cycle
10. Configure Billing Frequency
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 Or Update Subscription with SegMetrics API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + SegMetrics

Try it

Create Or Update Subscription with SegMetrics API on New Submission from Typeform API

Typeform + SegMetrics

Try it

Create Or Update Subscription with SegMetrics API on Custom Events from Zoom API

Zoom + SegMetrics

Try it

Create Or Update Subscription with SegMetrics API on New Submission (Instant) from Jotform API

Jotform + SegMetrics

Try it

Create Or Update Subscription with SegMetrics API on New Scheduled Tasks from Pipedream API

Pipedream + SegMetrics

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 Or Update Subscription on SegMetrics

Description:Create or update a subscription. [See documentation here](https://developers.segmetrics.io/#subscriptions)

Version:0.0.3

Key:segmetrics-create-or-update-subscription

View on GitHub

Code#

import app from "../../segmetrics.app.mjs";
import constants from "../common/constants.mjs";

export default {
  name: "Create Or Update Subscription",
  version: "0.0.3",
  key: "segmetrics-create-or-update-subscription",
  description: "Create or update a subscription. [See documentation here](https://developers.segmetrics.io/#subscriptions)",
  type: "action",
  props: {
    app,
    integrationId: {
      label: "Integration ID",
      description: "The ID of the integration from your Account Settings Page",
      type: "string",
    },
    subscriptionId: {
      label: "Subscription Id",
      description: "Unique identifier for the subscription",
      type: "string",
    },
    email: {
      label: "Contact's Email",
      description: "Email address of the contact",
      type: "string",
    },
    amount: {
      label: "Subscription Total in Cents",
      description: "Total amount of the subscription in cents",
      type: "integer",
    },
    productId: {
      label: "Product ID",
      description: "Product Id that the subscription applies to",
      type: "string",
    },
    startDate: {
      type: "string",
      label: "Start Date",
      description: "DateTime when the subscription started. E..g `2019-12-03 11:14:32`",
    },
    lastBillDate: {
      label: "Last Bill Date",
      description: "DateTime when the subscription was last billed. E.g. `2019-12-03 11:14:32`",
      type: "string",
    },
    billingCycle: {
      label: "Billing Cycle",
      description: "The frequency with which a subscription should be billed.",
      type: "string",
      options: constants.BILLING_CYCLES,
    },
    frequency: {
      label: "Billing Frequency",
      description: "The number of intervals (specified in the billing_cycle property) between subscription billings. For example, billing_cycle=month and frequency=3 bills every 3 months.",
      type: "integer",
    },
  },
  async run({ $ }) {
    const response = await this.app.createOrUpdateSubscription({
      $,
      integrationId: this.integrationId,
      data: {
        id: this.subscriptionId,
        email: this.email,
        amount: this.amount,
        product_id: this.productId,
        start_date: this.startDate,
        last_bill_date: this.lastBillDate,
        billing_cycle: this.billingCycle,
        frequency: this.frequency,
      },
    });

    if (response) {
      $.export("$summary", `Successfully created or updated 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
SegMetrics	`app`	`app`	This component uses the SegMetrics app.
Integration ID	`integrationId`	`string`	The ID of the integration from your Account Settings Page
Subscription Id	`subscriptionId`	`string`	Unique identifier for the subscription
Contact's Email	`email`	`string`	Email address of the contact
Subscription Total in Cents	`amount`	`integer`	Total amount of the subscription in cents
Product ID	`productId`	`string`	Product Id that the subscription applies to
Start Date	`startDate`	`string`	DateTime when the subscription started. E..g `2019-12-03 11:14:32`
Last Bill Date	`lastBillDate`	`string`	DateTime when the subscription was last billed. E.g. `2019-12-03 11:14:32`
Billing Cycle	`billingCycle`	`string`	Select a value from the drop down menu:`{ "label": "Year", "value": "year" }{ "label": "Month", "value": "month" }{ "label": "Week", "value": "week" }{ "label": "Day", "value": "day" }`
Billing Frequency	`frequency`	`integer`	The number of intervals (specified in the billing_cycle property) between subscription billings. For example, billing_cycle=month and frequency=3 bills every 3 months.

Authentication#

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

To get your Account ID and API Key