Skip to main content
POST
Create customer
This reference describes API version 2026-07-31. Send Commet-Version: 2026-07-31 with your request.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-07-31

API version used by this reference. Send this header to select this contract explicitly.

Body

application/json
email
string<email>
required
Maximum string length: 200
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
id
string
Maximum string length: 100
externalId
string
Maximum string length: 100
fullName
string
Maximum string length: 200
taxDocument
string
Maximum string length: 50
businessTaxId
string

Business tax ID, such as an EU VAT number or a Peruvian RUC, for the country of the customer's address. Accepted only where Commet collects tax; a valid ID replaces consumer tax with the business treatment.

Required string length: 1 - 30
address
object
addressId
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
timezone
enum<string>
default:UTC
Available options:
UTC,
America/New_York,
America/Chicago,
America/Denver,
America/Los_Angeles,
America/Sao_Paulo,
America/Mexico_City,
America/Buenos_Aires,
America/Santiago,
America/Bogota,
America/Lima,
America/Asuncion,
Europe/London,
Europe/Paris,
Europe/Berlin,
Europe/Madrid,
Asia/Tokyo,
Asia/Shanghai,
Asia/Singapore,
Asia/Dubai,
Australia/Sydney
metadata
object
planGroupId
string

Plan group whose starting plan the customer starts on when it has no open subscription: its signup trial, a trial without a payment method, when the group has one and the customer never had that plan, otherwise its default plan. A customer who already had the signup trial plan in a group without a default plan starts on none. Without it, no plan is assigned.

Minimum string length: 1

Response

Success

id
string
required
externalId
string | null
required
fullName
string | null
required
email
string
required
taxDocument
string | null
required
documentType
string | null
required
businessTaxId
object | null
required
timezone
string | null
required
metadata
object | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
object
string
required
Allowed value: "customer"
livemode
boolean
required