Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
name
string
required
The name of the customer
Minimum string length: 1
aliases
string[] | null
The aliases of the customer used to match events to the customer.
contacts
object[] | null
The contacts of the customer. Contact marked as primary is the target for invoice sharing.
Show child attributes
source
enum<string> | null
The source of the customer
Available options:
Stripe,
VayuEventsApi,
Api,
Vayu,
Salesforce,
HubSpot,
ContractExtraction
legalName
string | null
The legal name of the customer
taxIds
string[] | null
The tax IDs of the customer
status
enum<string>
The lifecycle status of the customer. Defaults to Active when omitted on creation.
Available options:
Active,
Inactive,
Suspended,
Trial
taxId
string | null
deprecated
The tax ID of the customer (deprecated, use taxIds instead)
cloudProviderSettings
object | null
Cloud provider settings for the customer
Show child attributes
externalId
string
The external ID of the customer
customerErpId
string | null
The ID of the customer in the ERP system
address
object | null
The address of the customer
Show child attributes
shippingAddress
object | null
The shipping address of the customer
Show child attributes
salesForceAccountId
string | null
The ID of the customer in the Salesforce system
externalIntegration
object[] | null
External integration links for the customer. Each entry links the customer to an external provider entity by its id. Stripe entries are saved on the customer; other providers are linked via the integration registry.
Custom fields from CRM systems (Salesforce, HubSpot, etc.)
Show child attributes
customFieldValues
object[] | null
The stored custom field values associated with the customer. Read-only: ignored on create and update requests; values are set via customFields.
Show child attributes
subsidiary
string | null
The name of the subsidiary of the customer
totalOutstandingAmount
number
Total outstanding amount across all unpaid invoices (in USD)
openAmount
number
Total amount of invoices with no billing status set (in USD)
overdueAmount
number
Total amount of overdue invoices (in USD)
pendingPaymentAmount
number
Total amount of invoices pending payment (in USD)
paidAmount
number
Total amount of paid invoices (in USD)
Response
RequestSuccess
customer
object
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Vayu docs","colors":{"primary":"#00a7df","light":"#00e5f5","dark":"#163B7E"},"logo":{"light":"https://mintcdn.com/vayu-786467d1/o-8hk5NjGtk8g3GS/assets/logo/light.svg?fit=max\u0026auto=format\u0026n=o-8hk5NjGtk8g3GS\u0026q=85\u0026s=bfce6c8445b24dbb51f5541edea9c802","dark":"https://mintcdn.com/vayu-786467d1/4AZPc6NfN1PrLxrr/images/Vayu-FullLogo-White-GradientX2.png?fit=max\u0026auto=format\u0026n=4AZPc6NfN1PrLxrr\u0026q=85\u0026s=5f9efb6a5f2fc4ab1c6eb9529b865238"},"favicon":"https://mintcdn.com/vayu-786467d1/1SxS3Ik3tm_XU1jg/assets/favicon.png?fit=max\u0026auto=format\u0026n=1SxS3Ik3tm_XU1jg\u0026q=85\u0026s=e4cd09db091a8f11f1d4a0c892b8d1c0","navbar":{"links":[{"href":"mailto:shai@withvayu.com?subject=Support Request","label":"Support"}],"primary":{"type":"button","label":"Get started now","href":"https://www.withvayu.com/#FAQ"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/withvayu"}},"seo":{"indexing":"navigable"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"link","href":"https://withvayu.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vayu-786467d1","hasAudioNarration":false,"actualSubdomain":"vayu-786467d1","customDomains":["guide.withvayu.com"],"gitSource":{"type":"github","owner":"vayucode","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aa653f3293612ad8f41df49","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":102},{"language":"default","tag":"Documentation","count":40},{"language":"default","tag":"Guides","count":37},{"language":"default","tag":"Integrations","count":20},{"language":"default","tag":"Customers","count":16},{"language":"default","tag":"API Documentation","count":12},{"language":"default","tag":"Invoices","count":11},{"language":"default","tag":"Plans \u0026 Pricing","count":10},{"language":"default","tag":"Contracts","count":8},{"language":"default","tag":"Events","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/endpoints/customers/create-customer","slug":"/api-reference/endpoints/customers/create-customer","pageMetadata":{"openapi":"post /customers","title":"Create Customer","description":"Create a new Customer.","href":"/api-reference/endpoints/customers/create-customer"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new Customer.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /customers","title":"Create Customer","description":"Create a new Customer.","href":"/api-reference/endpoints/customers/create-customer"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["customers"],"operationId":"createCustomer","description":"Create a new Customer.","summary":"Create Customer","security":["a61f4805-dd03-4ec9-b495-e8f65eaceb64"],"requestBody":"6afab987-f852-47bf-bb74-f1ee458a7f9b","x-required-scope":"vayu.customers.write","responses":{"200":"bbf1ca47-dac3-4135-949d-2e3b29d05622","400":"14d3837f-41d4-458a-9b56-9cc14a0f646b","401":"cc46b3ec-89db-47b5-b9f3-b90fe2b84159","429":"6cccf428-c8a6-46f8-9da9-3e2575c48b05","500":"131f4b6e-6492-4790-b849-bb56aade6924"},"method":"post","type":"path","servers":["0dec5a11-3cfa-4138-ae7a-94bedee29854","eee074eb-d58a-403e-b620-7f577fbb3209"],"path":"/customers","baseUrlOptions":["https://connect.withvayu.com","https://staging-connect.withvayu.com"],"title":"Create Customer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the customer","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"aliases":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"aliases.oneOf.0.items.[INDEX]","typeLabel":"string"},"default":[],"description":"The aliases of the customer used to match events to the customer.","uniqueKey":"aliases.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"default":[],"description":"The aliases of the customer used to match events to the customer.","uniqueKey":"aliases.oneOf.1","typeLabel":"null"}],"uniqueKey":"aliases","typeLabel":"string[] | null"},"contacts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"contacts.oneOf.0.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","uniqueKey":"contacts.oneOf.0.items.[INDEX].email","typeLabel":"string"},"title":{"type":"string","uniqueKey":"contacts.oneOf.0.items.[INDEX].title","typeLabel":"string"},"phone":{"type":"string","uniqueKey":"contacts.oneOf.0.items.[INDEX].phone","typeLabel":"string"},"receiveInvoiceEmail":{"type":"boolean","uniqueKey":"contacts.oneOf.0.items.[INDEX].receiveInvoiceEmail","typeLabel":"boolean"}},"uniqueKey":"contacts.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The contacts of the customer. Contact marked as primary is the target for invoice sharing.","uniqueKey":"contacts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"title":{"type":"string"},"phone":{"type":"string"},"receiveInvoiceEmail":{"type":"boolean"}}},"description":"The contacts of the customer. Contact marked as primary is the target for invoice sharing.","uniqueKey":"contacts.oneOf.1","typeLabel":"null"}],"uniqueKey":"contacts","typeLabel":"object[] | null"},"source":{"oneOf":[{"type":"string","enum":["Stripe","VayuEventsApi","Api","Vayu","Salesforce","HubSpot","ContractExtraction"],"description":"The source of the customer","uniqueKey":"source.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Stripe","VayuEventsApi","Api","Vayu","Salesforce","HubSpot","ContractExtraction"],"description":"The source of the customer","uniqueKey":"source.oneOf.1","typeLabel":"null"}],"uniqueKey":"source","typeLabel":"enum\u003cstring> | null"},"legalName":{"oneOf":[{"type":"string","description":"The legal name of the customer","uniqueKey":"legalName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal name of the customer","uniqueKey":"legalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"legalName","typeLabel":"string | null"},"taxIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"taxIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"default":[],"description":"The tax IDs of the customer","uniqueKey":"taxIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"default":[],"description":"The tax IDs of the customer","uniqueKey":"taxIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxIds","typeLabel":"string[] | null"},"status":{"type":"string","enum":["Active","Inactive","Suspended","Trial"],"description":"The lifecycle status of the customer. Defaults to Active when omitted on creation.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"taxId":{"oneOf":[{"type":"string","description":"The tax ID of the customer (deprecated, use taxIds instead)","deprecated":true,"uniqueKey":"taxId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax ID of the customer (deprecated, use taxIds instead)","deprecated":true,"uniqueKey":"taxId.oneOf.1","typeLabel":"null"}],"uniqueKey":"taxId","typeLabel":"string | null"},"cloudProviderSettings":{"oneOf":[{"type":"object","properties":{"cloudProvider":{"type":"string","enum":["AWS","GCP","Azure"],"uniqueKey":"cloudProviderSettings.oneOf.0.cloudProvider","typeLabel":"enum\u003cstring>"},"cloudProviderMarketplaceId":{"type":"string","uniqueKey":"cloudProviderSettings.oneOf.0.cloudProviderMarketplaceId","typeLabel":"string"},"customerIdentifier":{"type":"string","uniqueKey":"cloudProviderSettings.oneOf.0.customerIdentifier","typeLabel":"string"}},"description":"Cloud provider settings for the customer","uniqueKey":"cloudProviderSettings.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"cloudProvider":{"type":"string","enum":["AWS","GCP","Azure"]},"cloudProviderMarketplaceId":{"type":"string"},"customerIdentifier":{"type":"string"}},"description":"Cloud provider settings for the customer","uniqueKey":"cloudProviderSettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"cloudProviderSettings","typeLabel":"object | null"},"externalId":{"type":"string","description":"The external ID of the customer","uniqueKey":"externalId","typeLabel":"string"},"customerErpId":{"oneOf":[{"type":"string","description":"The ID of the customer in the ERP system","uniqueKey":"customerErpId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the customer in the ERP system","uniqueKey":"customerErpId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerErpId","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","properties":{"country":{"oneOf":[{"type":"string","uniqueKey":"address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.country","typeLabel":"string | null"},"countryCode":{"oneOf":[{"type":"string","uniqueKey":"address.oneOf.0.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.oneOf.0.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.countryCode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.city","typeLabel":"string | null"},"addressText":{"oneOf":[{"type":"string","uniqueKey":"address.oneOf.0.addressText.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.oneOf.0.addressText.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.addressText","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","uniqueKey":"address.oneOf.0.postalCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"address.oneOf.0.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.postalCode","typeLabel":"string | null"}},"description":"The address of the customer","uniqueKey":"address.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"country":{"oneOf":[{"type":"string"},{"type":"null"}]},"countryCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"city":{"oneOf":[{"type":"string"},{"type":"null"}]},"addressText":{"oneOf":[{"type":"string"},{"type":"null"}]},"state":{"oneOf":[{"type":"string"},{"type":"null"}]},"postalCode":{"oneOf":[{"type":"string"},{"type":"null"}]}},"description":"The address of the customer","uniqueKey":"address.oneOf.1","typeLabel":"null"}],"uniqueKey":"address","typeLabel":"object | null"},"shippingAddress":{"oneOf":[{"type":"object","description":"The shipping address of the customer","properties":{"country":{"oneOf":[{"type":"string","uniqueKey":"shippingAddress.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shippingAddress.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.oneOf.0.country","typeLabel":"string | null"},"countryCode":{"oneOf":[{"type":"string","uniqueKey":"shippingAddress.oneOf.0.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shippingAddress.oneOf.0.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.oneOf.0.countryCode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"shippingAddress.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shippingAddress.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.oneOf.0.city","typeLabel":"string | null"},"addressText":{"oneOf":[{"type":"string","uniqueKey":"shippingAddress.oneOf.0.addressText.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shippingAddress.oneOf.0.addressText.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.oneOf.0.addressText","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"shippingAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shippingAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.oneOf.0.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","uniqueKey":"shippingAddress.oneOf.0.postalCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shippingAddress.oneOf.0.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.oneOf.0.postalCode","typeLabel":"string | null"}},"uniqueKey":"shippingAddress.oneOf.0","typeLabel":"object"},{"type":"null","description":"The shipping address of the customer","properties":{"country":{"oneOf":[{"type":"string"},{"type":"null"}]},"countryCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"city":{"oneOf":[{"type":"string"},{"type":"null"}]},"addressText":{"oneOf":[{"type":"string"},{"type":"null"}]},"state":{"oneOf":[{"type":"string"},{"type":"null"}]},"postalCode":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"shippingAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress","typeLabel":"object | null"},"salesForceAccountId":{"oneOf":[{"type":"string","description":"The ID of the customer in the Salesforce system","uniqueKey":"salesForceAccountId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the customer in the Salesforce system","uniqueKey":"salesForceAccountId.oneOf.1","typeLabel":"null"}],"uniqueKey":"salesForceAccountId","typeLabel":"string | null"},"externalIntegration":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["NetSuite","QuickBooks","Morning","Hubspot","Anrok","Snowflake","Connact","Xero","Salesforce","Paddle","Stripe"],"description":"The integration provider. Stripe links are saved on the customer; other providers are linked via the integration registry.","isRequired":true,"uniqueKey":"externalIntegration.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The ID of the customer in the external provider system","isRequired":true,"uniqueKey":"externalIntegration.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the customer in the external provider system","isRequired":true,"uniqueKey":"externalIntegration.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"required":["type","id","name"],"uniqueKey":"externalIntegration.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"External integration links for the customer. Each entry links the customer to an external provider entity by its id. Stripe entries are saved on the customer; other providers are linked via the integration registry.","example":[{"type":"Stripe","id":"cus_123","name":"Acme Inc"}],"uniqueKey":"externalIntegration.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"type":{"type":"string","enum":["NetSuite","QuickBooks","Morning","Hubspot","Anrok","Snowflake","Connact","Xero","Salesforce","Paddle","Stripe"],"description":"The integration provider. Stripe links are saved on the customer; other providers are linked via the integration registry."},"id":{"type":"string","description":"The ID of the customer in the external provider system"},"name":{"type":"string","description":"The name of the customer in the external provider system"}},"required":["type","id","name"]},"description":"External integration links for the customer. Each entry links the customer to an external provider entity by its id. Stripe entries are saved on the customer; other providers are linked via the integration registry.","example":[{"type":"Stripe","id":"cus_123","name":"Acme Inc"}],"uniqueKey":"externalIntegration.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalIntegration","typeLabel":"object[] | null"},"dueDays":{"oneOf":[{"type":"string","enum":["END_OF_MONTH","SAME_DAY","15_DAYS","30_DAYS","45_DAYS","60_DAYS","90_DAYS","180_DAYS"],"description":"The due days of the customer","uniqueKey":"dueDays.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["END_OF_MONTH","SAME_DAY","15_DAYS","30_DAYS","45_DAYS","60_DAYS","90_DAYS","180_DAYS"],"description":"The due days of the customer","uniqueKey":"dueDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"dueDays","typeLabel":"enum\u003cstring> | null"},"currency":{"oneOf":[{"type":"string","enum":["USD","EUR","GBP","ILS","CAD","AUD","COP","BRL","ARS","INR","MXN","CHF"],"description":"The billing currency of the customer","uniqueKey":"currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["USD","EUR","GBP","ILS","CAD","AUD","COP","BRL","ARS","INR","MXN","CHF"],"description":"The billing currency of the customer","uniqueKey":"currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency","typeLabel":"enum\u003cstring> | null"},"customFields":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"vayuCustomFieldName":{"type":"string","description":"The name of the field in Vayu (e.g., \"AE Name\")","isRequired":true,"uniqueKey":"customFields.oneOf.0.items.[INDEX].vayuCustomFieldName","typeLabel":"string"},"valueType":{"type":"string","enum":["String","Number","Boolean","Enum"],"description":"The type of the value: \"String\", \"Number\", or \"Boolean\"","isRequired":true,"uniqueKey":"customFields.oneOf.0.items.[INDEX].valueType","typeLabel":"enum\u003cstring>"},"integrationSource":{"type":"string","enum":["NetSuite","QuickBooks","Stripe","Salesforce","Hubspot","Vayu","Slack","S3","Morning","Snowflake","Anrok","Connact","Xero","Paddle"],"description":"The integration provider (e.g., \"Salesforce\", \"HubSpot\")","uniqueKey":"customFields.oneOf.0.items.[INDEX].integrationSource","typeLabel":"enum\u003cstring>"},"integrationEntityType":{"type":"string","enum":["Account","Invoice","SalesOrder","Item","Deal","Company","Opportunity"],"description":"The entity type in the integration (e.g., \"Opportunity\", \"Deal\")","uniqueKey":"customFields.oneOf.0.items.[INDEX].integrationEntityType","typeLabel":"enum\u003cstring>"},"fieldPath":{"type":"string","description":"The path to the field in the integration (e.g., \"root.path.field\")","uniqueKey":"customFields.oneOf.0.items.[INDEX].fieldPath","typeLabel":"string"},"value":{"oneOf":[{"description":"The actual value of the custom field","uniqueKey":"customFields.oneOf.0.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"The actual value of the custom field","type":"null","uniqueKey":"customFields.oneOf.0.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"customFields.oneOf.0.items.[INDEX].value","typeLabel":"any | null"}},"required":["vayuCustomFieldName","valueType"],"uniqueKey":"customFields.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Custom fields from CRM systems (Salesforce, HubSpot, etc.)","uniqueKey":"customFields.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"integrationSource":{"type":"string","enum":["NetSuite","QuickBooks","Stripe","Salesforce","Hubspot","Vayu","Slack","S3","Morning","Snowflake","Anrok","Connact","Xero","Paddle"],"description":"The integration provider (e.g., \"Salesforce\", \"HubSpot\")"},"integrationEntityType":{"type":"string","enum":["Account","Invoice","SalesOrder","Item","Deal","Company","Opportunity"],"description":"The entity type in the integration (e.g., \"Opportunity\", \"Deal\")"},"fieldPath":{"type":"string","description":"The path to the field in the integration (e.g., \"root.path.field\")"},"vayuCustomFieldName":{"type":"string","description":"The name of the field in Vayu (e.g., \"AE Name\")"},"valueType":{"type":"string","enum":["String","Number","Boolean","Enum"],"description":"The type of the value: \"String\", \"Number\", or \"Boolean\""},"value":{"oneOf":[{"description":"The actual value of the custom field"},{"description":"The actual value of the custom field","type":"null"}]}},"required":["vayuCustomFieldName","valueType"]},"description":"Custom fields from CRM systems (Salesforce, HubSpot, etc.)","uniqueKey":"customFields.oneOf.1","typeLabel":"null"}],"uniqueKey":"customFields","typeLabel":"object[] | null"},"customFieldValues":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"customFieldDefinitionId":{"type":"string","isRequired":true,"uniqueKey":"customFieldValues.oneOf.0.items.[INDEX].customFieldDefinitionId","typeLabel":"string"},"value":{"type":"string","uniqueKey":"customFieldValues.oneOf.0.items.[INDEX].value","typeLabel":"string"},"fieldName":{"type":"string","uniqueKey":"customFieldValues.oneOf.0.items.[INDEX].fieldName","typeLabel":"string"}},"required":["customFieldDefinitionId"],"uniqueKey":"customFieldValues.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The stored custom field values associated with the customer. Read-only: ignored on create and update requests; values are set via customFields.","uniqueKey":"customFieldValues.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"customFieldDefinitionId":{"type":"string"},"value":{"type":"string"},"fieldName":{"type":"string"}},"required":["customFieldDefinitionId"]},"description":"The stored custom field values associated with the customer. Read-only: ignored on create and update requests; values are set via customFields.","uniqueKey":"customFieldValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"customFieldValues","typeLabel":"object[] | null"},"subsidiary":{"oneOf":[{"type":"string","description":"The name of the subsidiary of the customer","uniqueKey":"subsidiary.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the subsidiary of the customer","uniqueKey":"subsidiary.oneOf.1","typeLabel":"null"}],"uniqueKey":"subsidiary","typeLabel":"string | null"},"totalOutstandingAmount":{"type":"number","description":"Total outstanding amount across all unpaid invoices (in USD)","uniqueKey":"totalOutstandingAmount","typeLabel":"number"},"openAmount":{"type":"number","description":"Total amount of invoices with no billing status set (in USD)","uniqueKey":"openAmount","typeLabel":"number"},"overdueAmount":{"type":"number","description":"Total amount of overdue invoices (in USD)","uniqueKey":"overdueAmount","typeLabel":"number"},"pendingPaymentAmount":{"type":"number","description":"Total amount of invoices pending payment (in USD)","uniqueKey":"pendingPaymentAmount","typeLabel":"number"},"paidAmount":{"type":"number","description":"Total amount of paid invoices (in USD)","uniqueKey":"paidAmount","typeLabel":"number"}},"required":["name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","aliases":[],"contacts":[{"name":"\u003cstring>","email":"\u003cstring>","title":"\u003cstring>","phone":"\u003cstring>","receiveInvoiceEmail":true}],"legalName":"\u003cstring>","taxIds":[],"taxId":"\u003cstring>","cloudProviderSettings":{"cloudProviderMarketplaceId":"\u003cstring>","customerIdentifier":"\u003cstring>"},"externalId":"\u003cstring>","customerErpId":"\u003cstring>","address":{"country":"\u003cstring>","countryCode":"\u003cstring>","city":"\u003cstring>","addressText":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>"},"shippingAddress":{"country":"\u003cstring>","countryCode":"\u003cstring>","city":"\u003cstring>","addressText":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>"},"salesForceAccountId":"\u003cstring>","externalIntegration":[{"type":"Stripe","id":"cus_123","name":"Acme Inc"}],"customFields":[{"vayuCustomFieldName":"\u003cstring>","fieldPath":"\u003cstring>","value":"\u003cunknown>"}],"customFieldValues":[{"customFieldDefinitionId":"\u003cstring>","value":"\u003cstring>","fieldName":"\u003cstring>"}],"subsidiary":"\u003cstring>","totalOutstandingAmount":123,"openAmount":123,"overdueAmount":123,"pendingPaymentAmount":123,"paidAmount":123}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bbf1ca47-dac3-4135-949d-2e3b29d05622":{"description":"RequestSuccess","content":{"application/json":{"schema":{"type":"object","properties":{"customer":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the customer","isRequired":true,"uniqueKey":"customer.name","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"customer.id","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"customer.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"customer.updatedAt","typeLabel":"string\u003cdate-time>"},"aliases":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"customer.aliases.oneOf.0.items.[INDEX]","typeLabel":"string"},"default":[],"description":"The aliases of the customer used to match events to the customer.","uniqueKey":"customer.aliases.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"default":[],"description":"The aliases of the customer used to match events to the customer.","uniqueKey":"customer.aliases.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.aliases","typeLabel":"string[] | null"},"contacts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"customer.contacts.oneOf.0.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","uniqueKey":"customer.contacts.oneOf.0.items.[INDEX].email","typeLabel":"string"},"title":{"type":"string","uniqueKey":"customer.contacts.oneOf.0.items.[INDEX].title","typeLabel":"string"},"phone":{"type":"string","uniqueKey":"customer.contacts.oneOf.0.items.[INDEX].phone","typeLabel":"string"},"receiveInvoiceEmail":{"type":"boolean","uniqueKey":"customer.contacts.oneOf.0.items.[INDEX].receiveInvoiceEmail","typeLabel":"boolean"}},"uniqueKey":"customer.contacts.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The contacts of the customer. Contact marked as primary is the target for invoice sharing.","uniqueKey":"customer.contacts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"title":{"type":"string"},"phone":{"type":"string"},"receiveInvoiceEmail":{"type":"boolean"}}},"description":"The contacts of the customer. Contact marked as primary is the target for invoice sharing.","uniqueKey":"customer.contacts.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.contacts","typeLabel":"object[] | null"},"source":{"oneOf":[{"type":"string","enum":["Stripe","VayuEventsApi","Api","Vayu","Salesforce","HubSpot","ContractExtraction"],"description":"The source of the customer","uniqueKey":"customer.source.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Stripe","VayuEventsApi","Api","Vayu","Salesforce","HubSpot","ContractExtraction"],"description":"The source of the customer","uniqueKey":"customer.source.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.source","typeLabel":"enum\u003cstring> | null"},"legalName":{"oneOf":[{"type":"string","description":"The legal name of the customer","uniqueKey":"customer.legalName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal name of the customer","uniqueKey":"customer.legalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.legalName","typeLabel":"string | null"},"taxIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"customer.taxIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"default":[],"description":"The tax IDs of the customer","uniqueKey":"customer.taxIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"default":[],"description":"The tax IDs of the customer","uniqueKey":"customer.taxIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.taxIds","typeLabel":"string[] | null"},"status":{"type":"string","enum":["Active","Inactive","Suspended","Trial"],"description":"The lifecycle status of the customer. Defaults to Active when omitted on creation.","uniqueKey":"customer.status","typeLabel":"enum\u003cstring>"},"taxId":{"oneOf":[{"type":"string","description":"The tax ID of the customer (deprecated, use taxIds instead)","deprecated":true,"uniqueKey":"customer.taxId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The tax ID of the customer (deprecated, use taxIds instead)","deprecated":true,"uniqueKey":"customer.taxId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.taxId","typeLabel":"string | null"},"cloudProviderSettings":{"oneOf":[{"type":"object","properties":{"cloudProvider":{"type":"string","enum":["AWS","GCP","Azure"],"uniqueKey":"customer.cloudProviderSettings.oneOf.0.cloudProvider","typeLabel":"enum\u003cstring>"},"cloudProviderMarketplaceId":{"type":"string","uniqueKey":"customer.cloudProviderSettings.oneOf.0.cloudProviderMarketplaceId","typeLabel":"string"},"customerIdentifier":{"type":"string","uniqueKey":"customer.cloudProviderSettings.oneOf.0.customerIdentifier","typeLabel":"string"}},"description":"Cloud provider settings for the customer","uniqueKey":"customer.cloudProviderSettings.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"cloudProvider":{"type":"string","enum":["AWS","GCP","Azure"]},"cloudProviderMarketplaceId":{"type":"string"},"customerIdentifier":{"type":"string"}},"description":"Cloud provider settings for the customer","uniqueKey":"customer.cloudProviderSettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.cloudProviderSettings","typeLabel":"object | null"},"externalId":{"type":"string","description":"The external ID of the customer","uniqueKey":"customer.externalId","typeLabel":"string"},"customerErpId":{"oneOf":[{"type":"string","description":"The ID of the customer in the ERP system","uniqueKey":"customer.customerErpId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the customer in the ERP system","uniqueKey":"customer.customerErpId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.customerErpId","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","properties":{"country":{"oneOf":[{"type":"string","uniqueKey":"customer.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.address.oneOf.0.country","typeLabel":"string | null"},"countryCode":{"oneOf":[{"type":"string","uniqueKey":"customer.address.oneOf.0.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.address.oneOf.0.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.address.oneOf.0.countryCode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"customer.address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.address.oneOf.0.city","typeLabel":"string | null"},"addressText":{"oneOf":[{"type":"string","uniqueKey":"customer.address.oneOf.0.addressText.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.address.oneOf.0.addressText.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.address.oneOf.0.addressText","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"customer.address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.address.oneOf.0.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","uniqueKey":"customer.address.oneOf.0.postalCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.address.oneOf.0.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.address.oneOf.0.postalCode","typeLabel":"string | null"}},"description":"The address of the customer","uniqueKey":"customer.address.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"country":{"oneOf":[{"type":"string"},{"type":"null"}]},"countryCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"city":{"oneOf":[{"type":"string"},{"type":"null"}]},"addressText":{"oneOf":[{"type":"string"},{"type":"null"}]},"state":{"oneOf":[{"type":"string"},{"type":"null"}]},"postalCode":{"oneOf":[{"type":"string"},{"type":"null"}]}},"description":"The address of the customer","uniqueKey":"customer.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.address","typeLabel":"object | null"},"shippingAddress":{"oneOf":[{"type":"object","description":"The shipping address of the customer","properties":{"country":{"oneOf":[{"type":"string","uniqueKey":"customer.shippingAddress.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.shippingAddress.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shippingAddress.oneOf.0.country","typeLabel":"string | null"},"countryCode":{"oneOf":[{"type":"string","uniqueKey":"customer.shippingAddress.oneOf.0.countryCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.shippingAddress.oneOf.0.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shippingAddress.oneOf.0.countryCode","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"customer.shippingAddress.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.shippingAddress.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shippingAddress.oneOf.0.city","typeLabel":"string | null"},"addressText":{"oneOf":[{"type":"string","uniqueKey":"customer.shippingAddress.oneOf.0.addressText.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.shippingAddress.oneOf.0.addressText.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shippingAddress.oneOf.0.addressText","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"customer.shippingAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.shippingAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shippingAddress.oneOf.0.state","typeLabel":"string | null"},"postalCode":{"oneOf":[{"type":"string","uniqueKey":"customer.shippingAddress.oneOf.0.postalCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.shippingAddress.oneOf.0.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shippingAddress.oneOf.0.postalCode","typeLabel":"string | null"}},"uniqueKey":"customer.shippingAddress.oneOf.0","typeLabel":"object"},{"type":"null","description":"The shipping address of the customer","properties":{"country":{"oneOf":[{"type":"string"},{"type":"null"}]},"countryCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"city":{"oneOf":[{"type":"string"},{"type":"null"}]},"addressText":{"oneOf":[{"type":"string"},{"type":"null"}]},"state":{"oneOf":[{"type":"string"},{"type":"null"}]},"postalCode":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"customer.shippingAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.shippingAddress","typeLabel":"object | null"},"salesForceAccountId":{"oneOf":[{"type":"string","description":"The ID of the customer in the Salesforce system","uniqueKey":"customer.salesForceAccountId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the customer in the Salesforce system","uniqueKey":"customer.salesForceAccountId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.salesForceAccountId","typeLabel":"string | null"},"externalIntegration":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["NetSuite","QuickBooks","Morning","Hubspot","Anrok","Snowflake","Connact","Xero","Salesforce","Paddle","Stripe"],"description":"The integration provider. Stripe links are saved on the customer; other providers are linked via the integration registry.","isRequired":true,"uniqueKey":"customer.externalIntegration.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The ID of the customer in the external provider system","isRequired":true,"uniqueKey":"customer.externalIntegration.oneOf.0.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the customer in the external provider system","isRequired":true,"uniqueKey":"customer.externalIntegration.oneOf.0.items.[INDEX].name","typeLabel":"string"}},"required":["type","id","name"],"uniqueKey":"customer.externalIntegration.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"External integration links for the customer. Each entry links the customer to an external provider entity by its id. Stripe entries are saved on the customer; other providers are linked via the integration registry.","example":[{"type":"Stripe","id":"cus_123","name":"Acme Inc"}],"uniqueKey":"customer.externalIntegration.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"type":{"type":"string","enum":["NetSuite","QuickBooks","Morning","Hubspot","Anrok","Snowflake","Connact","Xero","Salesforce","Paddle","Stripe"],"description":"The integration provider. Stripe links are saved on the customer; other providers are linked via the integration registry."},"id":{"type":"string","description":"The ID of the customer in the external provider system"},"name":{"type":"string","description":"The name of the customer in the external provider system"}},"required":["type","id","name"]},"description":"External integration links for the customer. Each entry links the customer to an external provider entity by its id. Stripe entries are saved on the customer; other providers are linked via the integration registry.","example":[{"type":"Stripe","id":"cus_123","name":"Acme Inc"}],"uniqueKey":"customer.externalIntegration.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.externalIntegration","typeLabel":"object[] | null"},"dueDays":{"oneOf":[{"type":"string","enum":["END_OF_MONTH","SAME_DAY","15_DAYS","30_DAYS","45_DAYS","60_DAYS","90_DAYS","180_DAYS"],"description":"The due days of the customer","uniqueKey":"customer.dueDays.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["END_OF_MONTH","SAME_DAY","15_DAYS","30_DAYS","45_DAYS","60_DAYS","90_DAYS","180_DAYS"],"description":"The due days of the customer","uniqueKey":"customer.dueDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.dueDays","typeLabel":"enum\u003cstring> | null"},"currency":{"oneOf":[{"type":"string","enum":["USD","EUR","GBP","ILS","CAD","AUD","COP","BRL","ARS","INR","MXN","CHF"],"description":"The billing currency of the customer","uniqueKey":"customer.currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["USD","EUR","GBP","ILS","CAD","AUD","COP","BRL","ARS","INR","MXN","CHF"],"description":"The billing currency of the customer","uniqueKey":"customer.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.currency","typeLabel":"enum\u003cstring> | null"},"customFields":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"vayuCustomFieldName":{"type":"string","description":"The name of the field in Vayu (e.g., \"AE Name\")","isRequired":true,"uniqueKey":"customer.customFields.oneOf.0.items.[INDEX].vayuCustomFieldName","typeLabel":"string"},"valueType":{"type":"string","enum":["String","Number","Boolean","Enum"],"description":"The type of the value: \"String\", \"Number\", or \"Boolean\"","isRequired":true,"uniqueKey":"customer.customFields.oneOf.0.items.[INDEX].valueType","typeLabel":"enum\u003cstring>"},"integrationSource":{"type":"string","enum":["NetSuite","QuickBooks","Stripe","Salesforce","Hubspot","Vayu","Slack","S3","Morning","Snowflake","Anrok","Connact","Xero","Paddle"],"description":"The integration provider (e.g., \"Salesforce\", \"HubSpot\")","uniqueKey":"customer.customFields.oneOf.0.items.[INDEX].integrationSource","typeLabel":"enum\u003cstring>"},"integrationEntityType":{"type":"string","enum":["Account","Invoice","SalesOrder","Item","Deal","Company","Opportunity"],"description":"The entity type in the integration (e.g., \"Opportunity\", \"Deal\")","uniqueKey":"customer.customFields.oneOf.0.items.[INDEX].integrationEntityType","typeLabel":"enum\u003cstring>"},"fieldPath":{"type":"string","description":"The path to the field in the integration (e.g., \"root.path.field\")","uniqueKey":"customer.customFields.oneOf.0.items.[INDEX].fieldPath","typeLabel":"string"},"value":{"oneOf":[{"description":"The actual value of the custom field","uniqueKey":"customer.customFields.oneOf.0.items.[INDEX].value.oneOf.0","typeLabel":"any"},{"description":"The actual value of the custom field","type":"null","uniqueKey":"customer.customFields.oneOf.0.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.customFields.oneOf.0.items.[INDEX].value","typeLabel":"any | null"}},"required":["vayuCustomFieldName","valueType"],"uniqueKey":"customer.customFields.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Custom fields from CRM systems (Salesforce, HubSpot, etc.)","uniqueKey":"customer.customFields.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"integrationSource":{"type":"string","enum":["NetSuite","QuickBooks","Stripe","Salesforce","Hubspot","Vayu","Slack","S3","Morning","Snowflake","Anrok","Connact","Xero","Paddle"],"description":"The integration provider (e.g., \"Salesforce\", \"HubSpot\")"},"integrationEntityType":{"type":"string","enum":["Account","Invoice","SalesOrder","Item","Deal","Company","Opportunity"],"description":"The entity type in the integration (e.g., \"Opportunity\", \"Deal\")"},"fieldPath":{"type":"string","description":"The path to the field in the integration (e.g., \"root.path.field\")"},"vayuCustomFieldName":{"type":"string","description":"The name of the field in Vayu (e.g., \"AE Name\")"},"valueType":{"type":"string","enum":["String","Number","Boolean","Enum"],"description":"The type of the value: \"String\", \"Number\", or \"Boolean\""},"value":{"oneOf":[{"description":"The actual value of the custom field"},{"description":"The actual value of the custom field","type":"null"}]}},"required":["vayuCustomFieldName","valueType"]},"description":"Custom fields from CRM systems (Salesforce, HubSpot, etc.)","uniqueKey":"customer.customFields.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.customFields","typeLabel":"object[] | null"},"customFieldValues":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"customFieldDefinitionId":{"type":"string","isRequired":true,"uniqueKey":"customer.customFieldValues.oneOf.0.items.[INDEX].customFieldDefinitionId","typeLabel":"string"},"value":{"type":"string","uniqueKey":"customer.customFieldValues.oneOf.0.items.[INDEX].value","typeLabel":"string"},"fieldName":{"type":"string","uniqueKey":"customer.customFieldValues.oneOf.0.items.[INDEX].fieldName","typeLabel":"string"}},"required":["customFieldDefinitionId"],"uniqueKey":"customer.customFieldValues.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The stored custom field values associated with the customer. Read-only: ignored on create and update requests; values are set via customFields.","uniqueKey":"customer.customFieldValues.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"customFieldDefinitionId":{"type":"string"},"value":{"type":"string"},"fieldName":{"type":"string"}},"required":["customFieldDefinitionId"]},"description":"The stored custom field values associated with the customer. Read-only: ignored on create and update requests; values are set via customFields.","uniqueKey":"customer.customFieldValues.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.customFieldValues","typeLabel":"object[] | null"},"subsidiary":{"oneOf":[{"type":"string","description":"The name of the subsidiary of the customer","uniqueKey":"customer.subsidiary.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the subsidiary of the customer","uniqueKey":"customer.subsidiary.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.subsidiary","typeLabel":"string | null"},"totalOutstandingAmount":{"type":"number","description":"Total outstanding amount across all unpaid invoices (in USD)","uniqueKey":"customer.totalOutstandingAmount","typeLabel":"number"},"openAmount":{"type":"number","description":"Total amount of invoices with no billing status set (in USD)","uniqueKey":"customer.openAmount","typeLabel":"number"},"overdueAmount":{"type":"number","description":"Total amount of overdue invoices (in USD)","uniqueKey":"customer.overdueAmount","typeLabel":"number"},"pendingPaymentAmount":{"type":"number","description":"Total amount of invoices pending payment (in USD)","uniqueKey":"customer.pendingPaymentAmount","typeLabel":"number"},"paidAmount":{"type":"number","description":"Total amount of paid invoices (in USD)","uniqueKey":"customer.paidAmount","typeLabel":"number"}},"required":["name","id","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"customer","typeLabel":"object"}},"required":["customer"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customer":{"name":"\u003cstring>","id":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","aliases":[],"contacts":[{"name":"\u003cstring>","email":"\u003cstring>","title":"\u003cstring>","phone":"\u003cstring>","receiveInvoiceEmail":true}],"source":"Stripe","legalName":"\u003cstring>","taxIds":[],"status":"Active","taxId":"\u003cstring>","cloudProviderSettings":{"cloudProvider":"AWS","cloudProviderMarketplaceId":"\u003cstring>","customerIdentifier":"\u003cstring>"},"externalId":"\u003cstring>","customerErpId":"\u003cstring>","address":{"country":"\u003cstring>","countryCode":"\u003cstring>","city":"\u003cstring>","addressText":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>"},"shippingAddress":{"country":"\u003cstring>","countryCode":"\u003cstring>","city":"\u003cstring>","addressText":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>"},"salesForceAccountId":"\u003cstring>","externalIntegration":[{"type":"Stripe","id":"cus_123","name":"Acme Inc"}],"dueDays":"END_OF_MONTH","currency":"USD","customFields":[{"vayuCustomFieldName":"\u003cstring>","valueType":"String","integrationSource":"NetSuite","integrationEntityType":"Account","fieldPath":"\u003cstring>","value":"\u003cunknown>"}],"customFieldValues":[{"customFieldDefinitionId":"\u003cstring>","value":"\u003cstring>","fieldName":"\u003cstring>"}],"subsidiary":"\u003cstring>","totalOutstandingAmount":123,"openAmount":123,"overdueAmount":123,"pendingPaymentAmount":123,"paidAmount":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"14d3837f-41d4-458a-9b56-9cc14a0f646b":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Specific machine-readable error code","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error explanation","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requiredScope":{"type":"string","description":"Scope the token was missing, present on insufficient_scope errors","uniqueKey":"requiredScope","typeLabel":"string"},"param":{"type":"string","description":"Single parameter that failed validation","uniqueKey":"param","typeLabel":"string"},"params":{"type":"array","items":{"type":"object","properties":{"param":{"type":"string","description":"The parameter that failed validation","isRequired":true,"uniqueKey":"params.items.[INDEX].param","typeLabel":"string"},"message":{"type":"string","description":"Why validation failed for this parameter","isRequired":true,"uniqueKey":"params.items.[INDEX].message","typeLabel":"string"}},"required":["param","message"],"uniqueKey":"params.items.[INDEX]","typeLabel":"object"},"description":"Multiple parameters that failed validation","uniqueKey":"params","typeLabel":"object[]"}},"required":["type","code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"invalid_request_error","code":"\u003cstring>","message":"\u003cstring>","requiredScope":"\u003cstring>","param":"\u003cstring>","params":[{"param":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"cc46b3ec-89db-47b5-b9f3-b90fe2b84159":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["authentication_error"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["authentication_failed"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error explanation","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requiredScope":{"type":"string","description":"Scope the token was missing, present on insufficient_scope errors","uniqueKey":"requiredScope","typeLabel":"string"}},"required":["type","code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"authentication_error","code":"authentication_failed","message":"\u003cstring>","requiredScope":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"6cccf428-c8a6-46f8-9da9-3e2575c48b05":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["rate_limit_error"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["rate_limit_exceeded"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error explanation","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requiredScope":{"type":"string","description":"Scope the token was missing, present on insufficient_scope errors","uniqueKey":"requiredScope","typeLabel":"string"}},"required":["type","code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"rate_limit_error","code":"rate_limit_exceeded","message":"\u003cstring>","requiredScope":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"131f4b6e-6492-4790-b849-bb56aade6924":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["api_error"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["internal_error"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable error explanation","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requiredScope":{"type":"string","description":"Scope the token was missing, present on insufficient_scope errors","uniqueKey":"requiredScope","typeLabel":"string"}},"required":["type","code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"api_error","code":"internal_error","message":"\u003cstring>","requiredScope":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a61f4805-dd03-4ec9-b495-e8f65eaceb64":{"BearerAuthorizer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]}}},"servers":{"0dec5a11-3cfa-4138-ae7a-94bedee29854":{"url":"https://connect.withvayu.com","description":"Production server"},"eee074eb-d58a-403e-b620-7f577fbb3209":{"url":"https://staging-connect.withvayu.com","description":"Sandbox server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuthorizer","name":"Authorization"}],"title":"BearerAuthorizer"}]},"originalFileLocation":"config/vy-openapi.yml"},"subdomain":"vayu-786467d1","siteName":"Vayu docs","title":"Create Customer - Vayu docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T10:53:07.113Z","originalFileLocation":"api-reference/endpoints/customers/create-customer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a new Customer.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vayu docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vayu-786467d1/mq4wQUuhRBkcW2Tn/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/vayu-786467d1/mq4wQUuhRBkcW2Tn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vayu-786467d1/mq4wQUuhRBkcW2Tn/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vayu-786467d1/mq4wQUuhRBkcW2Tn/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vayu-786467d1/mq4wQUuhRBkcW2Tn/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vayu-786467d1/mq4wQUuhRBkcW2Tn/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vayu-786467d1/mq4wQUuhRBkcW2Tn/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vayu-786467d1/mq4wQUuhRBkcW2Tn/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vayu-786467d1/mq4wQUuhRBkcW2Tn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Customer - Vayu docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new Customer.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vayu docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://guide.withvayu.com/api-reference/endpoints/customers/create-customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vayu-786467d1.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+Customer\u0026amp;description=Create+a+new+Customer.\u0026amp;theme=60e6ddf5d5054f7c48063afd\u0026amp;signature=7c544be3a4f1d24bbbebd3de6be6b73f1b020e41ce5e8157436d48634a3d432e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Customer - Vayu docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new Customer.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vayu-786467d1.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Create+Customer\u0026amp;description=Create+a+new+Customer.\u0026amp;theme=60e6ddf5d5054f7c48063afd\u0026amp;signature=7c544be3a4f1d24bbbebd3de6be6b73f1b020e41ce5e8157436d48634a3d432e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/vayu-786467d1/mq4wQUuhRBkcW2Tn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vayu docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00a7df\">\u003clink data-mint-head rel=\"canonical\" href=\"https://guide.withvayu.com/api-reference/endpoints/customers/create-customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/customers/create-customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://guide.withvayu.com/#organization\",\"name\":\"Vayu docs\",\"url\":\"https://guide.withvayu.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vayu-786467d1/o-8hk5NjGtk8g3GS/assets/logo/light.svg?fit=max\u0026auto=format\u0026n=o-8hk5NjGtk8g3GS\u0026q=85\u0026s=bfce6c8445b24dbb51f5541edea9c802\"}},{\"@type\":\"WebSite\",\"@id\":\"https://guide.withvayu.com#website\",\"name\":\"Vayu docs\",\"url\":\"https://guide.withvayu.com\",\"publisher\":{\"@id\":\"https://guide.withvayu.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://guide.withvayu.com/api-reference/endpoints/customers/create-customer#webpage\",\"url\":\"https://guide.withvayu.com/api-reference/endpoints/customers/create-customer\",\"name\":\"Create Customer\",\"description\":\"Create a new Customer.\",\"dateModified\":\"2026-01-28T10:53:07.113Z\",\"isPartOf\":{\"@id\":\"https://guide.withvayu.com#website\"},\"breadcrumb\":{\"@id\":\"https://guide.withvayu.com/api-reference/endpoints/customers/create-customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://guide.withvayu.com/api-reference/endpoints/customers/create-customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://guide.withvayu.com/api-reference/endpoints/customers/list-customers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customers\",\"item\":\"https://guide.withvayu.com/api-reference/endpoints/customers/list-customers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create Customer\",\"item\":\"https://guide.withvayu.com/api-reference/endpoints/customers/create-customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://guide.withvayu.com/api-reference/endpoints/customers/create-customer#apireference\",\"headline\":\"Create Customer\",\"name\":\"Create Customer\",\"description\":\"Create a new Customer.\",\"url\":\"https://guide.withvayu.com/api-reference/endpoints/customers/create-customer\",\"mainEntityOfPage\":{\"@id\":\"https://guide.withvayu.com/api-reference/endpoints/customers/create-customer#webpage\"},\"dateModified\":\"2026-01-28T10:53:07.113Z\",\"publisher\":{\"@id\":\"https://guide.withvayu.com/#organization\"},\"isPartOf\":{\"@id\":\"https://guide.withvayu.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vayu docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Vayu docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoints/customers/create-customer.md","siteName":"Vayu docs","nav":{"global":{"anchors":[{"anchor":"Website","icon":"link","href":"https://withvayu.com/"}]},"tabs":[{"tab":"Documentation","icon":"file-doc","pages":[{"title":"Documentation","href":"/documentation/get-started/introduction"}]},{"tab":"API Reference","icon":"phone-plus","groups":[{"group":"API Documentation","icon":"file-doc","pages":[{"title":"Vayu API","href":"/api-reference/pages/introduction"},{"title":"Connecting to Vayu","icon":"key","href":"/api-reference/pages/connecting-to-vayu"},{"title":"SDK","icon":"cube","href":"/api-reference/pages/sdk"},{"title":"Errors","icon":"circle-exclamation","href":"/api-reference/pages/errors"},{"title":"Rate Limits","icon":"gauge-high","href":"/api-reference/pages/rate-limits"},{"title":"Idempotency","icon":"rotate","href":"/api-reference/pages/idempotency"},{"title":"Pagination","icon":"list","href":"/api-reference/pages/pagination"},{"title":"Sending events","icon":"paper-plane","href":"/api-reference/pages/sending-events"},{"title":"Dry Run Ingestion","icon":"square-terminal","href":"/api-reference/pages/ingestion"},{"title":"Browsing Events","icon":"eye","href":"/api-reference/pages/browsing-events"},{"title":"Webhooks","icon":"bell","href":"/api-reference/pages/webhooks"},{"title":"Product Structure","icon":"box","href":"/api-reference/pages/product-structure"}]},{"group":"API Reference","icon":"file-dashed-line","pages":[{"group":"Customers","icon":"hand-holding-box","pages":[{"openapi":"get /customers","title":"List Customers","description":"Get a list of Customers.","href":"/api-reference/endpoints/customers/list-customers"},{"openapi":"post /customers","title":"Create Customer","href":"/api-reference/endpoints/customers/create-customer"},{"openapi":"get /customers/{customerId}","title":"Get Customer","description":"Get a Customer by id.","href":"/api-reference/endpoints/customers/get-customer"},{"openapi":"get /customers/externalId/{externalId}","title":"Get customer by externalId","href":"/api-reference/endpoints/customers/get-customer-by-externalid"},{"openapi":"get /customers/integration/{integrationType}/{integrationId}","title":"Get customer by integration id","href":"/api-reference/endpoints/customers/get-customer-by-integration-id"},{"openapi":"put /customers/{customerId}","title":"Update Customer","href":"/api-reference/endpoints/customers/update-customer"},{"openapi":"delete /customers/{customerId}","title":"Delete Customer","href":"/api-reference/endpoints/customers/delete-customer"},{"openapi":"get /customers/products-consumptions/{customerId}","title":"Get products consumptions by customer id","href":"/api-reference/endpoints/customers/get-products-consumptions-by-customer-id"},{"openapi":"get /customers/products-consumptions/alias/{alias}","title":"Get products consumptions by customer alias","href":"/api-reference/endpoints/customers/get-products-consumptions-by-customer-alias"},{"openapi":"get /customers/name/{name}","title":"Get customer by name","href":"/api-reference/endpoints/customers/get-customer-by-name"}]},{"group":"Customer Relations","icon":"handshake","pages":[{"openapi":"get /customer-relations/{customerRelationId}","title":"Get Customer relation","href":"/api-reference/endpoints/customers/get-customer-relation"},{"openapi":"post /customer-relations","title":"Create Customer relation","href":"/api-reference/endpoints/customers/create-customer-relation"}]},{"group":"Catalog Products","icon":"list-dropdown","pages":[{"openapi":"get /catalogProducts/{catalogProductId}","title":"Get Catalog product","href":"/api-reference/endpoints/catalog-products/get-catalog-product"},{"openapi":"put /catalogProducts/{catalogProductId}","title":"Update Catalog product","href":"/api-reference/endpoints/catalog-products/update-catalog-product"},{"openapi":"get /catalogProducts","title":"List Catalog products","href":"/api-reference/endpoints/catalog-products/list-catalog-products"},{"openapi":"post /catalogProducts","title":"Create Catalog product","href":"/api-reference/endpoints/catalog-products/create-catalog-product"},{"openapi":"delete /catalogProducts/{catalogProductId}","title":"Delete Catalog product","href":"/api-reference/endpoints/catalog-products/delete-catalog-product"}]},{"group":"Contracts","icon":"file-contract","pages":[{"openapi":"get /contracts/{contractId}","title":"Get Contract","href":"/api-reference/endpoints/contracts/get-contract"},{"openapi":"get /contracts/integration/{integrationType}/{integrationId}","title":"Get contract by integration id","href":"/api-reference/endpoints/contracts/get-contract-by-integration-id"},{"openapi":"delete /contracts/{contractId}","title":"Delete Contract","href":"/api-reference/endpoints/contracts/delete-contract"},{"openapi":"get /contracts","title":"List contracts","href":"/api-reference/endpoints/contracts/list-contracts"},{"openapi":"post /contracts","title":"Create Contract","href":"/api-reference/endpoints/contracts/create-contract"}]},{"group":"Invoices","icon":"file-invoice-dollar","pages":[{"openapi":"get /invoices/{invoiceId}","title":"Get Invoice","href":"/api-reference/endpoints/invoices/get-invoice"},{"openapi":"get /invoices","title":"List invoices","href":"/api-reference/endpoints/invoices/list-invoices"},{"openapi":"get /invoices/{invoiceId}/payment-status","title":"Get invoice payment status","href":"/api-reference/endpoints/invoices/get-invoice-payment-status"}]},{"group":"Measurements","icon":"ruler-combined","pages":[{"openapi":"get /measurements/{measurementId}","title":"Get Measurement","href":"/api-reference/endpoints/measurements/get-measurement"},{"openapi":"get /measurements","title":"List Measurements","href":"/api-reference/endpoints/measurements/list-measurements"},{"openapi":"post /measurements","title":"Create Measurement","href":"/api-reference/endpoints/measurements/create-measurement"},{"openapi":"delete /measurements/{measurementId}","title":"Delete Measurement","href":"/api-reference/endpoints/measurements/delete-measurement"}]},{"group":"Auth","icon":"key-skeleton","pages":[{"openapi":"post /login","title":"Login by obtaining a new access token","href":"/api-reference/endpoints/auth/login-by-obtaining-a-new-access-token"}]},{"group":"Events","icon":"calendar","pages":[{"openapi":"post /events/dry-run","title":"Submit a batch of events for testing","href":"/api-reference/endpoints/events/submit-a-batch-of-events-for-testing"},{"openapi":"get /events","title":"Query events by timestamp period and optional event name","href":"/api-reference/endpoints/events/query-events-by-timestamp-period-and-optional-event-name"},{"openapi":"post /events","title":"Submit a batch of events for ingestion","href":"/api-reference/endpoints/events/submit-a-batch-of-events-for-ingestion"},{"openapi":"get /events/{refId}","title":"Get event by refId","href":"/api-reference/endpoints/events/get-event-by-refid"},{"openapi":"delete /events/{refId}","title":"Delete an event by refId","href":"/api-reference/endpoints/events/delete-an-event-by-refid"},{"openapi":"post /events/delete-by-refs","title":"Delete events by refs","href":"/api-reference/endpoints/events/delete-events-by-refs"}]},{"group":"Credits","icon":"credit-card-front","pages":[{"openapi":"get /credits","title":"Retrieve credit ledger entries for customer.","href":"/api-reference/endpoints/credits/retrieve-credit-ledger-entries-for-customer"},{"openapi":"post /credits/grant","title":"Grant credits to a customer credit ledger","href":"/api-reference/endpoints/credits/grant-credits-to-a-customer-credit-ledger"},{"openapi":"post /credits/deduct","title":"Deduct credits from customer credit ledger","href":"/api-reference/endpoints/credits/deduct-credits-from-customer-credit-ledger"}]},{"group":"Product Consumption","icon":"space-station-moon-construction","pages":[{"openapi":"get /product-consumption/{productId}","title":"Get product consumption","href":"/api-reference/endpoints/product-consumptions/get-product-consumption"}]},{"group":"Meters","icon":"meter","pages":[{"openapi":"get /meters","title":"List Meters","href":"/api-reference/endpoints/meters/list-meters"},{"openapi":"get /meters/{meterId}","title":"Get Meter","href":"/api-reference/endpoints/meters/get-meter"},{"openapi":"put /meters/{meterId}","title":"Update Meter","href":"/api-reference/endpoints/meters/update-meter"},{"openapi":"delete /meters/{meterId}","title":"Delete Meter","href":"/api-reference/endpoints/meters/delete-meter"}]},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"post /webhook","title":"Subscribe to webhooks","href":"/api-reference/endpoints/webhooks/subscribe-to-webhooks"}]}]}]},{"tab":"Integrations","icon":"bullseye-pointer","pages":[{"title":"Integrations","href":"/documentation/guides/integrations/anrok"}]}]},"basePath":"","title":"Create Customer - Vayu docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}