View as Markdown
Zoho Billing icon

Zoho Billing ACTION

Create Customer

Create a new customer. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Zoho Billing account once, then configure and run Create Customer from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "zoho_subscriptions-create-customer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    zoho_subscriptions: { authProvisionId: "apn_xxxxxxx" },
    organizationId: "Organization Id",
    displayName: "Display Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Customer inputs
Property Type Description
organizationId Organization Id string
The Id of the organization you want to manage.
Required Dynamic
displayName Display Name string
Name of the customer which will be displayed in the interface and invoices.
Required
salutation Salutation string
Salutation of the customer.
Optional
firstName First Name string
First name of the customer.
Optional
lastName Last Name string
Last name of the customer.
Optional
email Email string
Email address of the customer.
Required
companyName Company Name string
Registered name of the company the customer represents.
Optional
phone Phone string
Customer's landline or fixed-line number.
Optional
mobile Mobile string
Customer's mobile phone number.
Optional
department Department string
Customer's department.
Optional
designation Designation string
Customer's designation.
Optional
website Website string
Customer's website if any.
Optional
billingAddressAttention Billing Address - Attention string
Attention of the customer's billing address.
Optional
billingAddressStreet Billing Address - Street string
Street of the customer's billing address.
Optional
billingAddressCity Billing Address - City string
City of the customer's billing address.
Optional
billingAddressState Billing Address - State string
State of the customer's billing address.
Optional
billingAddressZip Billing Address - Zip string
Zip of the customer's billing address.
Optional
billingAddressCountry Billing Address - Country string
Country of the customer's billing address.
Optional
billingAddressStateCode Billing Address - State Code string
State Code of the customer's billing address.
Optional
billingAddressFax Billing Address - Fax string
Fax of the customer's billing address.
Optional
shippingAddressAttention Shipping Address - Attention string
Attention of the customer's shipping address.
Optional
shippingAddressStreet Shipping Address - Street string
Street of the customer's shipping address.
Optional
shippingAddressCity Shipping Address - City string
City of the customer's shipping address.
Optional
shippingAddressState Shipping Address - State string
State of the customer's shipping address.
Optional
shippingAddressZip Shipping Address - Zip string
Zip of the customer's shipping address.
Optional
shippingAddressCountry Shipping Address - Country string
Country of the customer's shipping address.
Optional
shippingAddressStateCode Shipping Address - State Code string
State Code of the customer's shipping address.
Optional
shippingAddressFax Shipping Address - Fax string
Fax of the customer's shipping address.
Optional
paymentTerms Payment Terms integer
Net payment term for the customer.
Optional
paymentTermsLabel Payment Terms Label string
Text field of payment terms.
Optional
currencyCode Currency Code string
Currency code of the currency in which the customer wants to pay. If Currency Code is not specified here, the currency chosen in your Zoho Subscriptions organization will be used for billing.
Optional
achSupported ACH Supported boolean
Set to true if ACH payment is supported for the customer. Default is false
Optional
twitter Twitter string
Twitter profile of the customer.
Optional
facebook Facebook string
Facebook profile of the customer.
Optional
skype Skype string
Skype ID of the customer.
Optional
notes Notes string
A short note about the customer.
Optional
isPortalEnabled Is Portal Enabled boolean
Is Client portal enabled for the customer.
Optional
gstNo GTS Number string
GSTIN Number for the customer. India GTS only.
Optional
gstTreatment GST Treatment string
GST Treatment for the customer. India GTS only.
Optional
placeOfContact Place Of Contact string
Customer's place of contact. India GTS only.
Optional
vatTreatment VAT Treatment string
VAT treatment of the contact. VAT only.
Optional
taxRegNo Tax Registration Number string
12 digit Tax Registration number of a contact with Tax treatment as home_country_mexico, border_region_mexico, non_mexico. Consumers generic RFC: XAXX010101000, Overseas generic RFC: XEXX010101000. Mexico only.
Optional
tdsTaxId TDS Tax Id string
ID of the TDS tax. Mexico only.
Optional
taxTreatment Tax Treatment string
VAT treatment of the contact. Mexico only.
Optional
taxRegime Tax Regime string
Tax Regime of the contact. Mexico only.
Optional
isTdsRegistered Is TDS Registered boolean
Boolean to check if tax is registered. Mexico only.
Optional
vatRegNo VAT Registration Number string
VAT Registration number of a contact with length should be between 2 and 12 characters. VAT only.
Optional
isTaxable Is Taxable boolean
Set to true if customer's transactions must be tax inclusive. Sales Tax , GST only
Optional
taxId Tax Id string
Unique ID of the tax or tax group that can be collected from the contact. Tax can be given only if Is Taxable is true.
Optional
taxAuthorityId Tax Authority Id string
Unique ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
Optional
taxAuthorityName Tax Authority Name string
Unique name of the tax authority. Either Tax Authority Id or Tax Authority Name can be given.
Optional
taxExemptionId Tax Exemption Id string
Unique ID of the tax exemption. Sales Tax , GST only
Optional
taxExemptionCode Tax Exemption Code string
Unique code of the tax exemption. Sales Tax , GST only
Optional
invoiceTemplateId Invoice Template Id string
Unique Id used to denote the invoice template.
Optional
creditnoteTemplateId Credit Note Template Id string
Unique Id used to denote the credit note template.
Optional
customFields Custom Fields object
Additional fields for customers.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
zoho_subscriptions-create-customer
Version
0.0.3
App
Zoho Billing
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes