SearchCustomersRequest

data class SearchCustomersRequest(val q: String? = null, val email: String? = null, val createdAfter: Int? = null, val page: Int? = null, val perPage: Int? = null)

Parameters for searching customers.

All fields are optional; provide only the criteria relevant to the search.

Constructors

Link copied to clipboard
constructor(q: String? = null, email: String? = null, createdAfter: Int? = null, page: Int? = null, perPage: Int? = null)

Properties

Link copied to clipboard
@SerializedName(value = "created_after")
val createdAfter: Int? = null

Unix timestamp; returns only customers created after this time. Defaults to null.

Link copied to clipboard
val email: String? = null

Filters results to customers matching this email address. Defaults to null.

Link copied to clipboard
val page: Int? = null

The page number to retrieve. Defaults to null, which uses the API's first page.

Link copied to clipboard
@SerializedName(value = "per_page")
val perPage: Int? = null

The number of results per page. Defaults to null, which uses the API's default page size.

Link copied to clipboard
val q: String? = null

A general-purpose search query string. Defaults to null.