Create Customer

POST

customers

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: 'My Bearer Token',
});

const customer = await client.customers.create({ email: 'email', name: 'name' });

console.log(customer.business_id);

from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token="My Bearer Token",
)
customer = client.customers.create(
    email="email",
    name="name",
)
print(customer.business_id)

package main

import (
  "context"
  "fmt"

  "github.com/dodopayments/dodopayments-go"
  "github.com/dodopayments/dodopayments-go/option"
)

func main() {
  client := dodopayments.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  customer, err := client.Customers.New(context.TODO(), dodopayments.CustomerNewParams{
    Email: dodopayments.F("email"),
    Name: dodopayments.F("name"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", customer.BusinessID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.customers.Customer;
import com.dodopayments.api.models.customers.CustomerCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        CustomerCreateParams params = CustomerCreateParams.builder()
            .email("email")
            .name("name")
            .build();
        Customer customer = client.customers().create(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.customers.Customer
import com.dodopayments.api.models.customers.CustomerCreateParams

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val params: CustomerCreateParams = CustomerCreateParams.builder()
        .email("email")
        .name("name")
        .build()
    val customer: Customer = client.customers().create(params)
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

customer = dodo_payments.customers.create(email: "email", name: "name")

puts(customer)

curl --request POST \
  --url https://test.dodopayments.com/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "name": "<string>",
  "metadata": {},
  "phone_number": "<string>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.dodopayments.com/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '<string>',
    'name' => '<string>',
    'metadata' => [
        
    ],
    'phone_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "email": "<string>",
  "name": "<string>",
  "metadata": {},
  "phone_number": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

string

required

name

string

required

metadata

object

Additional metadata for the customer

Show child attributes

phone_number

string | null

Response

business_id

string

required

created_at

string<date-time>

required

customer_id

string

required

string

required

name

string

required

metadata

object

Additional metadata for the customer

Show child attributes

phone_number

string | null

⌘I

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: 'My Bearer Token',
});

const customer = await client.customers.create({ email: 'email', name: 'name' });

console.log(customer.business_id);

from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token="My Bearer Token",
)
customer = client.customers.create(
    email="email",
    name="name",
)
print(customer.business_id)

package main

import (
  "context"
  "fmt"

  "github.com/dodopayments/dodopayments-go"
  "github.com/dodopayments/dodopayments-go/option"
)

func main() {
  client := dodopayments.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  customer, err := client.Customers.New(context.TODO(), dodopayments.CustomerNewParams{
    Email: dodopayments.F("email"),
    Name: dodopayments.F("name"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", customer.BusinessID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.customers.Customer;
import com.dodopayments.api.models.customers.CustomerCreateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        CustomerCreateParams params = CustomerCreateParams.builder()
            .email("email")
            .name("name")
            .build();
        Customer customer = client.customers().create(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.customers.Customer
import com.dodopayments.api.models.customers.CustomerCreateParams

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val params: CustomerCreateParams = CustomerCreateParams.builder()
        .email("email")
        .name("name")
        .build()
    val customer: Customer = client.customers().create(params)
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

customer = dodo_payments.customers.create(email: "email", name: "name")

puts(customer)

curl --request POST \
  --url https://test.dodopayments.com/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "name": "<string>",
  "metadata": {},
  "phone_number": "<string>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.dodopayments.com/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '<string>',
    'name' => '<string>',
    'metadata' => [
        
    ],
    'phone_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "business_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "email": "<string>",
  "name": "<string>",
  "metadata": {},
  "phone_number": "<string>"
}

API Reference

Checkout Sessions

Payments

Subscriptions

Discounts

Licenses

Customers

Customer Wallets

Products

Addons

Meters

Usage Events

Refunds

Disputes

Payouts

Brands

Webhooks

Miscellaneous

Authorizations

Body

Response