SearchCustomers

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

Endpoint for searching customers via GET /v1/customers/search.

Constructors

constructor(q: String? = null, email: String? = null, createdAfter: Int? = null, page: Int? = null, perPage: Int? = null)

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

val email: String? = null

Filters results to customers matching this email address. Pass null to omit.

open override val endpointURL: String

Returns the relative URL path for this endpoint.

open override val httpMethod: String

Returns the HTTP method string for this endpoint.

val page: Int? = null

The page number to retrieve. Uses the API default when null.

val perPage: Int? = null

The number of results to return per page. Uses the API default when null.

val q: String? = null

A general-purpose search query string. Pass null to omit.

Returns the URL query parameters for this endpoint, or null if none apply.