Customers
in package
Customers resource for managing customer records.
Table of Contents
Methods
- __construct() : mixed
- create() : Customer
- Create a customer (POST /customers/create).
- lookup() : Customer
- Lookup a customer by ID (POST /customers/lookup).
- page() : CustomerPage
- Page through customers (POST /customers/page).
- update() : Customer
- Update supplied fields on a customer record (POST /customers/update).
Methods
__construct()
public
__construct(HttpClient $http) : mixed
Parameters
- $http : HttpClient
create()
Create a customer (POST /customers/create).
public
create(array<string|int, mixed> $payload) : Customer
Parameters
- $payload : array<string|int, mixed>
Return values
Customerlookup()
Lookup a customer by ID (POST /customers/lookup).
public
lookup(string $customerId) : Customer
Parameters
- $customerId : string
Return values
Customerpage()
Page through customers (POST /customers/page).
public
page([array<string|int, mixed> $payload = [] ]) : CustomerPage
Parameters
- $payload : array<string|int, mixed> = []
Return values
CustomerPageupdate()
Update supplied fields on a customer record (POST /customers/update).
public
update(array<string|int, mixed> $payload[, string|null $idempotencyKey = null ]) : Customer
Parameters
- $payload : array<string|int, mixed>
- $idempotencyKey : string|null = null