Skip to content

Mercury: Create a customer

Mercury customers.createCustomer: arguments, response, policy and SDK examples.

← Customers operations · Get started

Operation mercury.createcustomer

Provider route: POST /ar/customers. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["customers"]["createCustomer"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.customers.createCustomer(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_mercury import MercuryIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.customers.create_customer(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelOptionalExpand Create a customer — request body — body

Referenced models: Create a customer — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get a customer — response body

Referenced models: Get a customer — response body

Get a customer — response body
FieldTypePresenceDescription and constraints
$objectRootResponse data for Accounts Receivable customer API endpoints
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region
address (anyOf 1) (allOf 2)JSONAll variants applyAddress of customer.
address (anyOf 2)nullAlternative
deletedAtJSONOptional
deletedAt (anyOf 1)JSONAlternative
deletedAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
deletedAt (anyOf 1) (allOf 2)JSONAll variants applyThe time the customer was deleted, if it was deleted.
deletedAt (anyOf 2)nullAlternative
emailJSONRequired within parent
email (allOf 1)stringAll variants apply
email (allOf 2)JSONAll variants applyEmail of customer.
idJSONRequired within parent
id (allOf 1)stringAll variants applyThe customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first.
Format: uuid
id (allOf 2)JSONAll variants applyArCustomerId
namestringRequired within parentName of customer.
Maximum length: 5000
Minimum length: 1

Referenced models: Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region

Create a customer — request body — body
FieldTypePresenceDescription and constraints
$objectRootRequest data to create a customer using the public api
Additional keys: not allowed
addressJSONOptional
address (anyOf 1)JSONAlternative
address (anyOf 1) (allOf 1)ModelAll variants applyExpand Create a customer — request body — body address The address for the customer Address input for creating or updating customers
address (anyOf 1) (allOf 2)JSONAll variants applyThe address for the customer.
address (anyOf 2)nullAlternative
emailJSONRequired within parent
email (allOf 1)stringAll variants apply
email (allOf 2)JSONAll variants applyThe email address for the customer.
namestringRequired within parentThe name of the customer.
Maximum length: 5000
Minimum length: 1

Referenced models: Create a customer — request body — body address The address for the customer Address input for creating or updating customers

Get a customer — response body — address Address of customer address1, address2, city, country, postal Code, region
FieldTypePresenceDescription and constraints
$objectRootCustomer address information for Accounts Receivable API
address1stringRequired within parentPrimary street address line.
Maximum length: 299
Minimum length: 1
address2JSONOptional
address2 (anyOf 1)stringAlternativeSecondary street address line (optional).
Maximum length: 299
Minimum length: 1
address2 (anyOf 2)nullAlternative
citystringRequired within parentCity name.
Maximum length: 299
Minimum length: 1
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
country (allOf 2)JSONAll variants applyTwo-letter country code (ISO 3166-1 alpha-2).
postalCodestringRequired within parentPostal or ZIP code
Maximum length: 299
Minimum length: 1
regionJSONRequired within parent
region (allOf 1)stringAll variants apply
region (allOf 2)JSONAll variants applyState, province, or region.
Create a customer — request body — body address The address for the customer Address input for creating or updating customers
FieldTypePresenceDescription and constraints
$objectRootAddress input for creating or updating customers
Additional keys: not allowed
address1stringRequired within parentPrimary street address line.
Maximum length: 299
Minimum length: 1
address2JSONOptional
address2 (anyOf 1)stringAlternativeSecondary street address line (optional).
Maximum length: 299
Minimum length: 1
address2 (anyOf 2)nullAlternative
citystringRequired within parentCity name.
Maximum length: 299
Minimum length: 1
countryJSONRequired within parent
country (allOf 1)stringAll variants apply
country (allOf 2)JSONAll variants applyTwo-letter country code (ISO 3166-1 alpha-2).
namestringRequired within parentThe mailing name of the address.
postalCodestringRequired within parentPostal or ZIP code.
Maximum length: 299
Minimum length: 1
regionJSONRequired within parent
region (allOf 1)stringAll variants apply
region (allOf 2)JSONAll variants applyEither a two-letter US state code i.e. "CA" for California or a free-form identification of a particular region worldwide.

SDK function policy ID: mercury.createcustomer. Catalog operation: mercury:createCustomer. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.