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

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

GetCustomers

constructor(perPage: Int? = null, page: Int? = null)

Properties

additionalHeaders

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.

endpointURL

open override val endpointURL: String

Returns the relative URL path for this endpoint.

httpMethod

open override val httpMethod: String

Returns the HTTP method string for this endpoint.

page

val page: Int? = null

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

perPage

val perPage: Int? = null

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

queryItems

open override val queryItems: List<QueryItem>?

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