FrameSDK/com.framepayments.framesdk.customers/CustomerEndpoints/SearchCustomers

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

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
open val additionalHeaders: Map<String, String>

Optional extra HTTP headers to attach to the request (e.g. Accept: application/json). Defaults to empty. Applied after the standard Frame Authorization/User-Agent headers but before Content-Type (set on POST/PATCH), so an entry may override the former but not the latter. Prefer supplemental headers like Accept; don't rely on this to set auth headers.

Link copied to clipboard
val createdAfter: Int? = null

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

Link copied to clipboard
val email: String? = null

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

Link copied to clipboard
open override val endpointURL: String

Returns the relative URL path for this endpoint.

Link copied to clipboard
open override val httpMethod: String

Returns the HTTP method string for this endpoint.

Link copied to clipboard
val page: Int? = null

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

Link copied to clipboard
val perPage: Int? = null

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

Link copied to clipboard
val q: String? = null

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

Link copied to clipboard
open override val queryItems: List<QueryItem>?

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