Create Billing Subscription with Pennylane API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Create Billing Subscription action
1. Connect your Pennylane account
2. Optional- Configure Currency
3. Select a Mode
4. Configure Start
5. Select a Payment Conditions
6. Select a Payment Method
7. Select a Recurring Rule Type
8. Configure Day Of Month
9. Select a Day Of Week
10. Optional- Configure Interval
11. Optional- Configure Count
12. Optional- Configure Special Mention
13. Optional- Configure Discount
14. Select a Customer Id
15. Optional- Configure Line Items Sections Attributes
16. Configure Invoice Lines
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 Billing Subscription with Pennylane API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Pennylane

Try it

Create Billing Subscription with Pennylane API on New Submission from Typeform API

Typeform + Pennylane

Try it

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

Jotform + Pennylane

Try it

Create Billing Subscription with Pennylane API on New Scheduled Tasks from Pipedream API

Pipedream + Pennylane

Try it

Create Billing Subscription with Pennylane API on New Download Counts from npm API

npm + Pennylane

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 Billing Subscription on Pennylane

Description:Creates a billing subscription for a customer. [See the documentation](https://pennylane.readme.io/reference/billing_subscriptions-post-1).

Version:0.0.1

Key:pennylane-create-billing-subscription

View on GitHub

Code#

import {
  DAY_OF_WEEK_OPTIONS,
  MODE_OPTIONS,
  PAYMENT_CONDITIONS_OPTIONS,
  PAYMENT_METHOD_OPTIONS,
  RECURRING_RULE_TYPE,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import pennylane from "../../pennylane.app.mjs";

export default {
  key: "pennylane-create-billing-subscription",
  name: "Create Billing Subscription",
  description: "Creates a billing subscription for a customer. [See the documentation](https://pennylane.readme.io/reference/billing_subscriptions-post-1).",
  version: "0.0.1",
  type: "action",
  props: {
    pennylane,
    currency: {
      type: "string",
      label: "Currency",
      description: "Invoice Currency (ISO 4217). Default is EUR.",
      optional: true,
    },
    mode: {
      type: "string",
      label: "Mode",
      description: "Mode in which the new invoices will be created.",
      options: MODE_OPTIONS,
    },
    start: {
      type: "string",
      label: "Start",
      description: "Start date (ISO 8601)",
    },
    paymentConditions: {
      type: "string",
      label: "Payment Conditions",
      description: "Customer payment conditions",
      options: PAYMENT_CONDITIONS_OPTIONS,
    },
    paymentMethod: {
      type: "string",
      label: "Payment Method",
      description: "PaymentMethod",
      options: PAYMENT_METHOD_OPTIONS,
    },
    recurringRuleType: {
      type: "string",
      label: "Recurring Rule Type",
      description: "Type of the billing subscription's recurrence",
      options: RECURRING_RULE_TYPE,
      reloadProps: true,
    },
    dayOfMonth: {
      type: "integer",
      label: "Day Of Month",
      description: "The day of occurrences of the recurring rule",
      hidden: true,
    },
    dayOfWeek: {
      type: "string",
      label: "Day Of Week",
      description: "The day of occurrences of the recurring rule",
      options: DAY_OF_WEEK_OPTIONS,
      hidden: true,
    },
    interval: {
      type: "string",
      label: "Interval",
      description: "The interval of occurrences of the recurring rule",
      optional: true,
    },
    count: {
      type: "integer",
      label: "Count",
      description: "Number of occurrences of the recurring rule",
      optional: true,
    },
    specialMention: {
      type: "string",
      label: "Special Mention",
      description: "Additional details",
      optional: true,
    },
    discount: {
      type: "integer",
      label: "Discount",
      description: "Invoice discount (in percent)",
      optional: true,
    },
    customerId: {
      propDefinition: [
        pennylane,
        "customerId",
      ],
    },
    lineItemsSectionsAttributes: {
      propDefinition: [
        pennylane,
        "lineItemsSectionsAttributes",
      ],
      optional: true,
    },
    invoiceLines: {
      propDefinition: [
        pennylane,
        "lineItems",
      ],
      label: "Invoice Lines",
    },
  },
  async additionalProps(props) {
    switch (this.recurringRuleType) {
    case "monthly":
      props.dayOfMonth.hidden = false;
      props.dayOfWeek.hidden = true;
      break;
    case "weekly":
      props.dayOfMonth.hidden = true;
      props.dayOfWeek.hidden = false;
      break;
    case "yearly":
      props.dayOfMonth.hidden = true;
      props.dayOfWeek.hidden = true;
      break;
    }
    return {};
  },
  async run({ $ }) {
    const response = await this.pennylane.createBillingSubscription({
      $,
      data: {
        create_customer: false,
        create_products: false,
        billing_subscription: {
          currency: this.currency,
          mode: this.mode,
          start: this.start,
          payment_conditions: this.paymentConditions,
          payment_method: this.paymentMethod,
          recurring_rule: {
            type: this.recurringRuleType,
            day_of_month: this.dayOfMonth,
            day_of_week: this.dayOfWeek,
            interval: this.interval,
            count: this.count,
          },
          special_mention: this.specialMention,
          discount: this.discount,
          customer: {
            source_id: this.customerId,
          },
          line_items_sections_attributes: parseObject(this.lineItemsSectionsAttributes),
          invoice_lines: parseObject(this.invoiceLines),
        },
      },
    });
    $.export("$summary", `Created billing subscription with ID ${response.billing_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
Pennylane	`pennylane`	`app`	This component uses the Pennylane app.
Currency	`currency`	`string`	Invoice Currency (ISO 4217). Default is EUR.
Mode	`mode`	`string`	Select a value from the drop down menu:`{ "label": "Draft invoices will be created", "value": "awaiting_validation" }{ "label": "Finalized invoices will be created", "value": "finalized" }{ "label": "Finalized invoices will be created and autimatically sent to the client at each new occurrence", "value": "email" }`
Start	`start`	`string`	Start date (ISO 8601)
Payment Conditions	`paymentConditions`	`string`	Select a value from the drop down menu:`upon_receiptcustom15_days30_days45_days60_days`
Payment Method	`paymentMethod`	`string`	Select a value from the drop down menu:`{ "label": "Offline - The subscription is not linked to a payment method", "value": "offline" }{ "label": "Gocardless Direct Debit - At each new occurrence the client will be automatically debited thanks to GoCardless", "value": "gocardless_direct_debit" }`
Recurring Rule Type	`recurringRuleType`	`string`	Select a value from the drop down menu:`monthlyweeklyyearly`
Interval	`interval`	`string`	The interval of occurrences of the recurring rule
Count	`count`	`integer`	Number of occurrences of the recurring rule
Special Mention	`specialMention`	`string`	Additional details
Discount	`discount`	`integer`	Invoice discount (in percent)
Customer Id	`customerId`	`string`	Select a value from the drop down menu.
Line Items Sections Attributes	`lineItemsSectionsAttributes`	`string[]`	A list of objects of items sections to be listed on the invoice. Example: [{"title": "Title","description": "description","rank": 1}] See the documentation from further information.
Invoice Lines	`invoiceLines`	`string[]`	A list of objects of items to be listed on the invoice. Example: [{"product": {"source_id": "0e67fc3c-c632-4feb-ad34-e18ed5fbf66a","unit": "20","price": "10.00","label": "Product label","vat_rate": "FR_09","currency": "EUR"},"quantity": 2,"label": "Line Item Label"}] See the documentation from further information.

Authentication#

Pennylane uses OAuth authentication. When you connect your Pennylane account, Pipedream will open a popup window where you can sign into Pennylane and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Pennylane API.

Pipedream requests the following authorization scopes when you connect your account:

customer_invoices