Create Subscription with Zoho Subscriptions API on New Requests (Payload Only) from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Zoho Subscriptions, HTTP / Webhook and 2,200+ other apps remarkably fast.

Trigger workflow on

New Requests (Payload Only) from the HTTP / Webhook API

Next, do this

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

Select this integration
Configure the New Requests (Payload Only) trigger
1. Connect your HTTP / Webhook account
Configure the Create Subscription action
1. Connect your Zoho Subscriptions account
2. Select a Organization Id
3. Optional- Configure Add To Unbilled Charges
4. Select a Customer Id
5. Optional- Configure Payment Terms
6. Optional- Configure Payment Terms Label
7. Optional- Configure Custom Fields
8. Optional- Select one or more Contact Person Id
9. Optional- Select a Card Id
10. Optional- Configure Starts At
11. Optional- Configure Exchange Rate
12. Optional- Configure Place Of Supply
13. Select a Plan Code
14. Optional- Configure Plan Description
15. Optional- Configure Price
16. Optional- Configure Setup Fee
17. Optional- Configure Setup Fee Tax Id
18. Optional- Configure Item Custom Fields
19. Optional- Configure Quantity
20. Optional- Configure Tax Id
21. Optional- Configure Tax Exemption Id
22. Optional- Configure Tax Exemption Code
23. Optional- Configure TDS Tax Id
24. Optional- Configure Sat Item Key Code
25. Optional- Configure Unit Key Code
26. Optional- Configure Setup Fee Tax Exemption Id
27. Optional- Configure Setup Fee Tax Exemption Code
28. Optional- Configure Exclude Trial
29. Optional- Configure Exclude Setup Fee
30. Optional- Configure Billing Cycles
31. Optional- Configure Trial Days
32. Optional- Configure Addons
33. Optional- Configure Coupon Code
34. Configure Auto Collect
35. Optional- Configure Reference Id
36. Optional- Configure Sales Person Name
37. Optional- Select one or more Payment Gateways
38. Optional- Configure Create Backdated Invoice
39. Optional- Configure Can Charge Setup Fee Immediately
40. Optional- Configure Template Id
41. Optional- Select a CFDI Usage
42. Optional- Configure Allow Partial Payments
43. Optional- Configure Account Id
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 Requests (Payload Only) on HTTP / Webhook

Description:Get a URL and emit the HTTP body as an event on every request

Version:0.1.1

Key:http-new-requests-payload-only

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
// Returns a 200 OK response, emits the HTTP payload as an event
export default {
  key: "http-new-requests-payload-only",
  name: "New Requests (Payload Only)",
  // eslint-disable-next-line
  description: "Get a URL and emit the HTTP body as an event on every request",
  version: "0.1.1",
  type: "source",
  props: {
    // eslint-disable-next-line
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    http,
  },
  async run(event) {
    const { body } = event;
    this.httpInterface.respond({
      status: 200,
      body,
    });
    // Emit the HTTP payload
    this.$emit({
      body,
    });
  },
};

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
N/A	`httpInterface`	`$.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.
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Create Subscription on Zoho Subscriptions

Description:Create a new subscription. [See the documentation](https://www.zoho.com/subscriptions/api/v1/subscription/#create-a-subscription)

Version:0.0.1

Key:zoho_subscriptions-create-subscription

View on GitHub

Zoho Subscriptions Overview#

The Zoho Subscriptions API allows you to manage various aspects of subscription-based billing services. With this API, you can automate tasks such as creating subscriptions, handling customer billing info, and managing invoices. In Pipedream, you can harness this API to build workflows that respond to events in Zoho Subscriptions or to perform actions based on triggers from other apps. This enables seamless automation of billing operations and integration with your broader app ecosystem.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import zohoSubscriptions from "../../zoho_subscriptions.app.mjs";

export default {
  key: "zoho_subscriptions-create-subscription",
  name: "Create Subscription",
  version: "0.0.1",
  description: "Create a new subscription. [See the documentation](https://www.zoho.com/subscriptions/api/v1/subscription/#create-a-subscription)",
  type: "action",
  props: {
    zohoSubscriptions,
    organizationId: {
      propDefinition: [
        zohoSubscriptions,
        "organizationId",
      ],
    },
    addToUnbilledCharges: {
      type: "boolean",
      label: "Add To Unbilled Charges",
      description: "When the value is given as true, the subscription would be created and charges for the current billing cycle will be put as unbilled. This can be converted to invoice at any later point of time.",
      optional: true,
    },
    customerId: {
      propDefinition: [
        zohoSubscriptions,
        "customerId",
        ({ organizationId }) => ({
          organizationId,
        }),
      ],
    },
    paymentTerms: {
      propDefinition: [
        zohoSubscriptions,
        "paymentTerms",
      ],
      optional: true,
    },
    paymentTermsLabel: {
      propDefinition: [
        zohoSubscriptions,
        "paymentTermsLabel",
      ],
      optional: true,
    },
    customFields: {
      propDefinition: [
        zohoSubscriptions,
        "customFields",
      ],
      optional: true,
    },
    contactpersons: {
      propDefinition: [
        zohoSubscriptions,
        "contactPersonId",
        ({
          customerId, organizationId,
        }) => ({
          customerId,
          organizationId,
        }),
      ],
      type: "string[]",
      optional: true,
    },
    cardId: {
      propDefinition: [
        zohoSubscriptions,
        "cardId",
        ({
          customerId, organizationId,
        }) => ({
          customerId,
          organizationId,
        }),
      ],
      optional: true,
    },
    startsAt: {
      type: "string",
      label: "Starts At",
      description: "Generally the subscription will start on the day it is created. But, the date can also be a future or past date depending upon your usecase. For future dates, the subscription status would be Future till the starts_at date. And for past dates, the subscription status can be `Trial`, `Live` or `Expired` depending on the subscription interval that you have selected. Format: `0000-00-00`",
      optional: true,
    },
    exchangeRate: {
      type: "string",
      label: "Exchange Rate",
      description: "This will be the exchange rate provided for the organization's currency and the customer's currency. The subscription fee would be the multiplicative product of the original price and the exchange rate.",
      optional: true,
    },
    placeOfSupply: {
      type: "string",
      label: "Place Of Supply",
      description: "Place of Supply for the customer's subscription. **India GST only**.",
      optional: true,
    },
    planCode: {
      propDefinition: [
        zohoSubscriptions,
        "planCode",
        ({ organizationId }) => ({
          organizationId,
        }),
      ],
    },
    planDescription: {
      type: "string",
      label: "Plan Description",
      description: "Description of the plan exclusive to this subscription. This will be displayed in place of the plan name in invoices generated for this subscription.",
      optional: true,
    },
    price: {
      type: "string",
      label: "Price",
      description: "Price of a plan for a particular subscription. If a value is provided here, the plan’s price for this subscription will be changed to the given value. If no value is provided, the plan’s price would be the same as what it was when it was created.",
      optional: true,
    },
    setupFee: {
      type: "string",
      label: "Setup Fee",
      description: "Setup fee for the plan.",
      optional: true,
    },
    setupFeeTaxId: {
      type: "string",
      label: "Setup Fee Tax Id",
      description: "Unique ID for tax of setup fee. `Setup Fee Tax Id` must be empty for applying tax Exemption.",
      optional: true,
    },
    itemCustomFields: {
      type: "object",
      label: "Item Custom Fields",
      description: "Custom fields for an item.",
      optional: true,
    },
    quantity: {
      type: "integer",
      label: "Quantity",
      description: "Required quantity of the chosen plan.",
      optional: true,
    },
    taxId: {
      type: "string",
      label: "Tax Id",
      description: "Unique ID of Tax or Tax Group that must be associated with the plan. `tax_id` must be empty for applying tax Exemption.",
      optional: true,
    },
    taxExemptionId: {
      type: "string",
      label: "Tax Exemption Id",
      description: "Unique ID of the tax exemption. **GST only**",
      optional: true,
    },
    taxExemptionCode: {
      type: "string",
      label: "Tax Exemption Code",
      description: "Unique code of the tax exemption. **GST only**",
      optional: true,
    },
    tdsTaxId: {
      type: "string",
      label: "TDS Tax Id",
      description: "ID of the TDS tax. **Mexico only**",
      optional: true,
    },
    satItemKeyCode: {
      type: "string",
      label: "Sat Item Key Code",
      description: "Add SAT Item Key Code for your goods/services. Download the [CFDI Catalogs](http://omawww.sat.gob.mx/tramitesyservicios/Paginas/documentos/catCFDI_V_4_07122022.xls). **Mexico only**",
      optional: true,
    },
    unitkeyCode: {
      type: "string",
      label: "Unit Key Code",
      description: "Add SAT Unit Key Code for your goods/services. Download the [CFDI Catalogs](http://omawww.sat.gob.mx/tramitesyservicios/Paginas/documentos/catCFDI_V_4_07122022.xls). **Mexico only**",
      optional: true,
    },
    setupFeeTaxExemptionId: {
      type: "string",
      label: "Setup Fee Tax Exemption Id",
      description: "Unique Tax Exemption ID that must be applied to setup fee. **GST only**",
      optional: true,
    },
    setupFeeTaxExemptionCode: {
      type: "string",
      label: "Setup Fee Tax Exemption Code",
      description: "Unique code of the tax exemption that must be applied to setup fee. **GST only**",
      optional: true,
    },
    excludeTrial: {
      type: "boolean",
      label: "Exclude Trial",
      description: "This is set to true if the respective plan's trial period needs to be excluded for this subscription.",
      optional: true,
    },
    excludeSetupFee: {
      type: "boolean",
      label: "Exclude Setup Fee",
      description: "This is set to true if the respective plan's setup fee needs to be excluded for this subscription.",
      optional: true,
    },
    billingCycles: {
      type: "integer",
      label: "Billing Cycles",
      description: "`Billing Cycles` specified at the time of creation of the plan would be the default value. If this needs to be overridden for this particular subscription, a value can be provided here.",
      optional: true,
    },
    trialDays: {
      type: "integer",
      label: "Trial Days",
      description: "Number of free trial days granted to a customer subscribed to this plan. Trial days for the subscription mentioned here will override the number of trial days provided at the time plan creation. This will be applicable even if `Exclude Trial` = true. Default is `0` only if `Exclude Trial` is `true`",
      optional: true,
    },
    addons: {
      type: "string[]",
      label: "Addons",
      description: "List of addon objects which are to be included in the subscription.",
      optional: true,
    },
    couponCode: {
      type: "string",
      label: "Coupon Code",
      description: "The coupon code of the coupon which is to be applied to the subscription.",
      optional: true,
    },
    autoCollect: {
      type: "boolean",
      label: "Auto Collect",
      description: "`Auto Collect` is set to `true` for creating an online subscription which will charge the customer's card automatically on every renewal. To create an offline subscriptions, set `Auto Collect` to `false`.",
      default: false,
    },
    referenceId: {
      type: "string",
      label: "Reference Id",
      description: "A string of your choice is required to easily identify and keep track of your subscriptions.",
      optional: true,
    },
    salespersonName: {
      type: "string",
      label: "Sales Person Name",
      description: "Name of the sales person assigned for the subscription.",
      optional: true,
    },
    paymentGateways: {
      type: "string[]",
      label: "Payment Gateways",
      description: "Payment gateway associated with the subscription.",
      options: [
        "test_gateway",
        "payflow_pro",
        "stripe",
        "2checkout",
        "authorize_net",
        "payments_pro",
        "forte",
        "worldpay",
        "wepay",
      ],
      optional: true,
    },
    createBackdatedInvoice: {
      type: "boolean",
      label: "Create Backdated Invoice",
      description: "To allow creation of invoice for current billing cycle for back dated subscriptions.",
      optional: true,
    },
    canChargeSetupFeeImmediately: {
      type: "boolean",
      label: "Can Charge Setup Fee Immediately",
      description: "If set to `true`, a separate invoice will be raised for the setup fee as soon as the subscription's trial period starts. Set the value as `false`, or remove this optional argument if you want the setup fee to be billed at the end of the trial period, along with the other subscription related charges.",
      optional: true,
    },
    templateId: {
      type: "string",
      label: "Template Id",
      description: "Default Invoice Template ID for all the invoices created from the subscription.",
      optional: true,
    },
    cfdiUsage: {
      type: "string",
      label: "CFDI Usage",
      description: "Choose CFDI Usage. **Mexico only**",
      options: [
        "acquisition_of_merchandise",
        "return_discount_bonus",
        "general_expense",
        "buildings",
        "furniture_office_equipment",
        "transport_equipment",
        "computer_equipmentdye_molds_tools",
        "telephone_communication",
        "satellite_communication",
        "other_machinery_equipment",
        "hospital_expense",
        "medical_expense_disability",
        "funeral_expense",
        "donation",
        "interest_mortage_loans",
        "contribution_sar",
        "medical_expense_insurance_pormium",
        "school_transportation_expense",
        "deposit_saving_account",
        "payment_educational_service",
        "no_tax_effect",
        "payment",
        "payroll",
      ],
      optional: true,
    },
    allowPartialPayments: {
      type: "boolean",
      label: "Allow Partial Payments",
      description: "Boolean to check if partial payments are allowed for the contact. **Mexico only**",
      optional: true,
    },
    accountId: {
      type: "string",
      label: "Account Id",
      description: "Account ID of the bank account from which payment is made by the customer.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      zohoSubscriptions,
      organizationId,
      addToUnbilledCharges,
      customerId,
      paymentTerms,
      paymentTermsLabel,
      customFields,
      contactpersons,
      cardId,
      startsAt,
      exchangeRate,
      placeOfSupply,
      planCode,
      planDescription,
      price,
      setupFee,
      setupFeeTaxId,
      itemCustomFields,
      quantity,
      taxId,
      taxExemptionId,
      taxExemptionCode,
      tdsTaxId,
      satItemKeyCode,
      unitkeyCode,
      setupFeeTaxExemptionId,
      setupFeeTaxExemptionCode,
      excludeTrial,
      excludeSetupFee,
      billingCycles,
      trialDays,
      addons,
      couponCode,
      autoCollect,
      referenceId,
      salespersonName,
      paymentGateways,
      createBackdatedInvoice,
      canChargeSetupFeeImmediately,
      templateId,
      cfdiUsage,
      allowPartialPayments,
      accountId,
    } = this;

    if (autoCollect && !cardId) {
      throw new ConfigurationError("By setting Auto-Collect to `true`, you must to fill in the card Id.");
    }

    if (autoCollect && !accountId) {
      throw new ConfigurationError("By setting Auto-Collect to `true`, you must to fill in the Account Id.");
    }

    let exchangeRateFloat = null;
    if (exchangeRate) {
      try {
        exchangeRateFloat = parseFloat(exchangeRate);
      } catch (e) {
        throw new ConfigurationError("Exchange Rate must be a double.");
      }
    }

    let priceFloat = null;
    if (price) {
      try {
        priceFloat = parseFloat(price);
      } catch (e) {
        throw new ConfigurationError("Plan price must be a double.");
      }
    }

    let setupFeeFLoat = null;
    if (setupFee) {
      try {
        setupFeeFLoat = parseFloat(setupFee);
      } catch (e) {
        throw new ConfigurationError("Setup Fee must be a double.");
      }
    }

    const response = await zohoSubscriptions.createSubscription({
      $,
      organizationId,
      data: {
        add_to_unbilled_charges: addToUnbilledCharges,
        customer_id: customerId,
        payment_terms: paymentTerms,
        payment_terms_label: paymentTermsLabel,
        custom_fields: customFields && Object.entries(customFields).map(([
          key,
          value,
        ]) => ({
          label: key,
          value: value,
        })),
        contactpersons: contactpersons && contactpersons.map((item) => ({
          contactperson_id: item,
        })),
        card_id: cardId,
        starts_at: startsAt,
        exchange_rate: exchangeRateFloat,
        place_of_supply: placeOfSupply,
        plan: {
          plan_code: planCode,
          plan_description: planDescription,
          price: priceFloat,
          setup_fee: setupFeeFLoat,
          setup_fee_tax_id: setupFeeTaxId,
          item_custom_fields: itemCustomFields && Object.entries(itemCustomFields).map(([
            key,
            value,
          ]) => ({
            label: key,
            value: value,
          })),
          quantity,
          tax_id: taxId,
          tax_exemption_id: taxExemptionId,
          tax_exemption_code: taxExemptionCode,
          tds_tax_id: tdsTaxId,
          sat_item_key_code: satItemKeyCode,
          unitkey_code: unitkeyCode,
          setup_fee_tax_exemption_id: setupFeeTaxExemptionId,
          setup_fee_tax_exemption_code: setupFeeTaxExemptionCode,
          exclude_trial: excludeTrial,
          exclude_setup_fee: excludeSetupFee,
          billing_cycles: billingCycles,
          trial_days: excludeTrial
            ? 0
            : trialDays,
        },
        addons,
        coupon_code: couponCode,
        reference_id: referenceId,
        salesperson_name: salespersonName,
        payment_gateways: paymentGateways && paymentGateways.map((item) => ({
          payment_gateway: item,
        })),
        create_backdated_invoice: createBackdatedInvoice,
        can_charge_setup_fee_immediately: canChargeSetupFeeImmediately,
        template_id: templateId,
        cfdi_usage: cfdiUsage,
        allow_partial_payments: allowPartialPayments,
        account_id: accountId,
      },
    });

    $.export("$summary", `A new subscription with Id: ${response.subscription?.subscription_id} was successfully created!`);
    return response;
  },
};

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
Zoho Subscriptions	`zohoSubscriptions`	`app`	This component uses the Zoho Subscriptions app.
Organization Id	`organizationId`	`string`	Select a value from the drop down menu.
Add To Unbilled Charges	`addToUnbilledCharges`	`boolean`	When the value is given as true, the subscription would be created and charges for the current billing cycle will be put as unbilled. This can be converted to invoice at any later point of time.
Customer Id	`customerId`	`string`	Select a value from the drop down menu.
Payment Terms	`paymentTerms`	`integer`	Payment Due details for the invoices.
Payment Terms Label	`paymentTermsLabel`	`string`	Label for the paymet due details.
Custom Fields	`customFields`	`object`	Additional fields for the invoices.
Contact Person Id	`contactpersons`	`string[]`	Select a value from the drop down menu.
Card Id	`cardId`	`string`	Select a value from the drop down menu.
Starts At	`startsAt`	`string`	Generally the subscription will start on the day it is created. But, the date can also be a future or past date depending upon your usecase. For future dates, the subscription status would be Future till the starts_at date. And for past dates, the subscription status can be `Trial`, `Live` or `Expired` depending on the subscription interval that you have selected. Format: `0000-00-00`
Exchange Rate	`exchangeRate`	`string`	This will be the exchange rate provided for the organization's currency and the customer's currency. The subscription fee would be the multiplicative product of the original price and the exchange rate.
Place Of Supply	`placeOfSupply`	`string`	Place of Supply for the customer's subscription. India GST only.
Plan Code	`planCode`	`string`	Select a value from the drop down menu.
Plan Description	`planDescription`	`string`	Description of the plan exclusive to this subscription. This will be displayed in place of the plan name in invoices generated for this subscription.
Price	`price`	`string`	Price of a plan for a particular subscription. If a value is provided here, the plan’s price for this subscription will be changed to the given value. If no value is provided, the plan’s price would be the same as what it was when it was created.
Setup Fee	`setupFee`	`string`	Setup fee for the plan.
Setup Fee Tax Id	`setupFeeTaxId`	`string`	Unique ID for tax of setup fee. `Setup Fee Tax Id` must be empty for applying tax Exemption.
Item Custom Fields	`itemCustomFields`	`object`	Custom fields for an item.
Quantity	`quantity`	`integer`	Required quantity of the chosen plan.
Tax Id	`taxId`	`string`	Unique ID of Tax or Tax Group that must be associated with the plan. `tax_id` must be empty for applying tax Exemption.
Tax Exemption Id	`taxExemptionId`	`string`	Unique ID of the tax exemption. GST only
Tax Exemption Code	`taxExemptionCode`	`string`	Unique code of the tax exemption. GST only
TDS Tax Id	`tdsTaxId`	`string`	ID of the TDS tax. Mexico only
Sat Item Key Code	`satItemKeyCode`	`string`	Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs. Mexico only
Unit Key Code	`unitkeyCode`	`string`	Add SAT Unit Key Code for your goods/services. Download the CFDI Catalogs. Mexico only
Setup Fee Tax Exemption Id	`setupFeeTaxExemptionId`	`string`	Unique Tax Exemption ID that must be applied to setup fee. GST only
Setup Fee Tax Exemption Code	`setupFeeTaxExemptionCode`	`string`	Unique code of the tax exemption that must be applied to setup fee. GST only
Exclude Trial	`excludeTrial`	`boolean`	This is set to true if the respective plan's trial period needs to be excluded for this subscription.
Exclude Setup Fee	`excludeSetupFee`	`boolean`	This is set to true if the respective plan's setup fee needs to be excluded for this subscription.
Billing Cycles	`billingCycles`	`integer`	`Billing Cycles` specified at the time of creation of the plan would be the default value. If this needs to be overridden for this particular subscription, a value can be provided here.
Trial Days	`trialDays`	`integer`	Number of free trial days granted to a customer subscribed to this plan. Trial days for the subscription mentioned here will override the number of trial days provided at the time plan creation. This will be applicable even if `Exclude Trial` = true. Default is `0` only if `Exclude Trial` is `true`
Addons	`addons`	`string[]`	List of addon objects which are to be included in the subscription.
Coupon Code	`couponCode`	`string`	The coupon code of the coupon which is to be applied to the subscription.
Auto Collect	`autoCollect`	`boolean`	`Auto Collect` is set to `true` for creating an online subscription which will charge the customer's card automatically on every renewal. To create an offline subscriptions, set `Auto Collect` to `false`.
Reference Id	`referenceId`	`string`	A string of your choice is required to easily identify and keep track of your subscriptions.
Sales Person Name	`salespersonName`	`string`	Name of the sales person assigned for the subscription.
Payment Gateways	`paymentGateways`	`string[]`	Select a value from the drop down menu:`test_gatewaypayflow_prostripe2checkoutauthorize_netpayments_proforteworldpaywepay`
Create Backdated Invoice	`createBackdatedInvoice`	`boolean`	To allow creation of invoice for current billing cycle for back dated subscriptions.
Can Charge Setup Fee Immediately	`canChargeSetupFeeImmediately`	`boolean`	If set to `true`, a separate invoice will be raised for the setup fee as soon as the subscription's trial period starts. Set the value as `false`, or remove this optional argument if you want the setup fee to be billed at the end of the trial period, along with the other subscription related charges.
Template Id	`templateId`	`string`	Default Invoice Template ID for all the invoices created from the subscription.
CFDI Usage	`cfdiUsage`	`string`	Select a value from the drop down menu:`acquisition_of_merchandisereturn_discount_bonusgeneral_expensebuildingsfurniture_office_equipmenttransport_equipmentcomputer_equipmentdye_molds_toolstelephone_communicationsatellite_communicationother_machinery_equipmenthospital_expensemedical_expense_disabilityfuneral_expensedonationinterest_mortage_loanscontribution_sarmedical_expense_insurance_pormiumschool_transportation_expensedeposit_saving_accountpayment_educational_serviceno_tax_effectpaymentpayroll`
Allow Partial Payments	`allowPartialPayments`	`boolean`	Boolean to check if partial payments are allowed for the contact. Mexico only
Account Id	`accountId`	`string`	Account ID of the bank account from which payment is made by the customer.

Action Authentication#

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

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

ZohoSubscriptions.fullaccess.all

About Zoho Subscriptions#

Subscription billing software, crafted for growing businesses.

More Ways to Connect Zoho Subscriptions + HTTP / Webhook#

Other Popular Integrations#

Create Customer with Zoho Subscriptions API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Zoho Subscriptions