Skip to main content
POST
/
customers
{
  "customerId": "<string>",
  "customerType": "CONSUMER",
  "name": "<string>",
  "identity": "<string>",
  "preferredLocale": "en-US",
  "humanReadableId": "29A-BY3Z-X78",
  "contact": {
    "email": "jsmith@example.com",
    "msisdn": "<string>"
  },
  "billing": {
    "method": "EMAIL_INVOICE",
    "email": "billing@company.com",
    "address": {
      "street1": "500 S Main St",
      "street2": "Apt 1",
      "city": "Natick",
      "zip": "01701",
      "country": "US",
      "state": "CA",
      "region": "<string>",
      "attention": "<string>"
    },
    "currency": "USD",
    "defaultPaymentProfileId": "c1d2e3f4-a5b6-7890-1234-901234567890",
    "autoPay": true
  },
  "users": [
    {
      "userId": "<string>",
      "name": "<string>",
      "role": "MEMBER"
    }
  ],
  "contactPersonUserId": "<string>",
  "contactPerson": {
    "userId": "<string>",
    "name": "<string>",
    "role": "MEMBER"
  },
  "shipping": {
    "name": "John Doe",
    "msisdn": "+15551234567",
    "address": {
      "street1": "500 S Main St",
      "street2": "Apt 1",
      "city": "Natick",
      "zip": "01701",
      "country": "US",
      "state": "CA",
      "region": "<string>",
      "attention": "<string>"
    },
    "instructions": "Leave at front door"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Headers

​
X-Idempotency-Key
string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum length: 256

Body

application/json

The customer to create.

Request to create a customer with optional payment profile setup.

​
customerType
enum<string>
required

The type of customer.

Available options:
CONSUMER,
BUSINESS
​
name
string
required

Name of the customer.

Example:

"John Doe"

​
contact
object
required

Contact details for the customer.

​
billing
object
required

Billing configuration and payment preferences for the customer.

​
userIds
string[]
required

List of user IDs to associate with this customer.

These users will be granted access to manage the customer and its subscriptions.

​
contactPersonUserId
string
required

The user ID of the contact person for this customer.

This user will be set as the primary contact for the customer and will receive important notifications.

​
identity
string

The identity of the entity, such as personal number, organization number, etc., depending on the country and customer type.

​
preferredLocale
string
default:en-US

The preferred locale for the customer, in IETF BCP 47 format (e.g., "en-US", "sv-SE").

Example:

"en-US"

​
shipping
object

The default shipping address for the customer.

This address is used for shipping physical goods to the customer, such as SIM cards or devices. It is also used to pre-fill the address when ordering physical goods.

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

Response

Customer created successfully.

A customer is a billable entity, the person or organization responsible for paying for services.

The customer is the owner of subscribers and subscriptions. Users are associated with a customer, but are not owned by the customer.

​
customerId
string
required

Unique identifier for the customer.

​
customerType
enum<string>
required

The type of customer.

Available options:
CONSUMER,
BUSINESS
​
name
string
required

Name of the customer.

​
contact
object
required

Contact details for the customer.

​
identity
string

The identity of the entity, such as personal number, organization number, etc., depending on the country and customer type.

​
preferredLocale
string
default:en-US

The preferred locale for the customer, in IETF BCP 47 format (e.g., "en-US", "sv-SE").

Example:

"en-US"

​
humanReadableId
string

A human-readable identifier for the customer that customers can state in support requests.

Example:

"29A-BY3Z-X78"

​
billing
object

Billing configuration and payment preferences for the customer.

​
users
object[]

List of users associated with this customer.

​
contactPersonUserId
string

The unique identifier for the contact person user.

​
contactPerson
object

The primary contact person for the customer.

​
shipping
object

The shipping address for the customer.

This address is used for shipping physical goods to the customer, such as SIM cards or devices. It is also used to pre-fill the address when ordering physical goods.

​
createdAt
string<date-time>

Date and time when the customer was created.

​
updatedAt
string<date-time>

Date and time when the customer was last updated.

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

⌘I