SubscriptionEndpoints

Defines the API endpoints available for subscription operations.

Each case maps to a specific URL path and HTTP method used by FrameNetworking.

Types

Endpoint for cancelling a subscription via POST to /v1/subscriptions/{subscriptionId}/cancel.

Endpoint for creating a new subscription via POST to /v1/subscriptions.

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.

Endpoint for retrieving a single subscription via GET to /v1/subscriptions/{subscriptionId}.

data class SearchSubscriptions(val status: String? = null, val createdBefore: Int? = null, val createdAfter: Int? = null) : SubscriptionEndpoints

Endpoint for searching subscriptions via GET to /v1/subscriptions/search.

Endpoint for updating an existing subscription via PATCH to /v1/subscriptions/{subscriptionId}.

open override val endpointURL: String

The fully qualified URL string for this endpoint.

open override val httpMethod: String

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

Optional query-string parameters appended to endpointURL.