GetCustomers

data class GetCustomers(val perPage: Int? = null, val page: Int? = null) : CustomerEndpoints

Endpoint for retrieving a paginated list of customers via GET /v1/customers.

Constructors

Link copied to clipboard
constructor(perPage: Int? = null, page: Int? = null)

Properties

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
open override val queryItems: List<QueryItem>?

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