Create a new User account
Creates a new User account in the system. The email must be unique across all Users. Returns the created User object with all fields except the password.
Note: If billingDetails are provided, ensure the countryCode is valid and postalCode is included for required countries.
Body
Email of the user.
"test@example.com"
User password used for logging in to the Store application. Password must contain at least one special character, one number and one uppercase letter. Password must be between 8 and 72 characters long.
8 - 72
"Password123!"
Username of the User.
1
"test-user"
A custom identifier for external system integration. This ID: - Can be used to link users with external systems - Will be included in all webhook notifications - Is optional but recommended for system integration
1
"abcd-1234-5678-90ab-cdef-1234-5678-90ab"
Billing information used for payments and invoices. Following fields are required for the payments: - countryCode: ISO 3166-1 alpha-2 country code (e.g., "US", "GB") - postalCode: Required for specific countries (US, CA, UA, IN)
All other fields are optional but recommended for a complete billing profile.
{
"type": "individual",
"countryCode": "US",
"state": "CA",
"firstName": "John",
"lastName": "Doe",
"dialCode": "+1",
"phoneNumber": "1234567890",
"address": "123 Main St",
"addressLine2": "Apt 1",
"city": "San Francisco",
"postalCode": "94101"
}
Pre-existing payment provider (Stripe/Paypal) customer IDs. Only provide this if: - You're migrating users from another system - You want to link existing Stripe/PayPal customers - You need to preserve payment history in provider's system
This is typically handled automatically during the first payment.
{
"stripeCustomerId": "cus_QzHuLRwfKfp2WX",
"paypalCustomerId": "KCE4828GQ37LL"
}