Skip to main content
POST
cURL
Create up to 100 customers in a single request. With planGroupId, each customer without an open subscription starts on that group’s starting plan (see planGroupId), and the entry of a deleted customer fails with customer_deleted.

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-08-27

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

Body

application/json
customers
object[]
required
Required array length: 1 - 100 elements
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

successful
object[]
required
failed
object[]
required
object
string
required
Allowed value: "customer_batch"
livemode
boolean
required