FrameSDK/com.framepayments.framesdk.subscriptions/SubscriptionEndpoints/GetSubscriptions

GetSubscriptions

data class GetSubscriptions(val perPage: Int? = null, val page: Int? = null) : SubscriptionEndpoints

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

Constructors

GetSubscriptions

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

The fully qualified URL string for this endpoint.

httpMethod

open override val httpMethod: String

HTTP method, e.g. "GET", "POST", "DELETE".

page

val page: Int? = null

Optional page number to retrieve.

perPage

val perPage: Int? = null

Optional number of results per page.

queryItems

open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.