Customers.md

Customers

A list of all methods in the Customers service. Click on the method name to view detailed information about that method.

Methods	Description
list_customers
create_customer
get_customer_handler
patch_customer

list_customers

• HTTP Method: GET
• Endpoint: /customers

Parameters

Name	Type	Required	Description
$pageSize	int	❌	Page size default is 10 max is 100
$pageNumber	int	❌	Page number default is 0

Return Type

Models\GetCustomersListResponse

Example Usage Code Snippet

<?php

use Dodopayments\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->customers->listCustomers(
  pageSize: 8,
  pageNumber: 2
);

print_r($response);

create_customer

• HTTP Method: POST
• Endpoint: /customers

Parameters

Name	Type	Required	Description
input	Models\CreateCustomerRequest	✅

Return Type

Models\CustomerResponse

Example Usage Code Snippet

<?php

use Dodopayments\Client;
use Dodopayments\Models\CreateCustomerRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\CreateCustomerRequest(
  email: "email",
  name: "name",
  phoneNumber: "phone_number"
);

$response = $sdk->customers->createCustomer(
  input: $input
);

print_r($response);

get_customer_handler

• HTTP Method: GET
• Endpoint: /customers/{customer_id}

Parameters

Name	Type	Required	Description
$customerId	string	✅	Customer Id

Return Type

Models\CustomerResponse

Example Usage Code Snippet

<?php

use Dodopayments\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->customers->getCustomerHandler(
  customerId: "customer_id"
);

print_r($response);

patch_customer

• HTTP Method: PATCH
• Endpoint: /customers/{customer_id}

Parameters

Name	Type	Required	Description
input	Models\PatchCustomerRequest	✅
$customerId	string	✅	Customer Id

Return Type

Models\CustomerResponse

Example Usage Code Snippet

<?php

use Dodopayments\Client;
use Dodopayments\Models\PatchCustomerRequest;

$sdk = new Client(accessToken: 'YOUR_TOKEN');


$input = new Models\PatchCustomerRequest(
  name: "name",
  phoneNumber: "phone_number"
);

$response = $sdk->customers->patchCustomer(
  input: $input,
  customerId: "customer_id"
);

print_r($response);