FrameSDK/com.framepayments.framesdk.subscriptions/SubscriptionEndpoints

SubscriptionEndpoints

sealed class SubscriptionEndpoints : FrameNetworkingEndpoints

Defines the API endpoints available for subscription operations.

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

Inheritors

Types

CancelSubscription

data class CancelSubscription(val subscriptionId: String) : SubscriptionEndpoints

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

CreateSubscription

object CreateSubscription : SubscriptionEndpoints

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

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.

GetSubscriptionWith

data class GetSubscriptionWith(val subscriptionId: String) : SubscriptionEndpoints

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

SearchSubscriptions

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.

UpdateSubscription

data class UpdateSubscription(val subscriptionId: String) : SubscriptionEndpoints

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

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".

queryItems

open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.