FrameSDK/com.framepayments.framesdk.subscriptionphases/SubscriptionPhaseEndpoints

SubscriptionPhaseEndpoints

sealed class SubscriptionPhaseEndpoints : FrameNetworkingEndpoints

Defines all API endpoints for subscription phase operations.

Each case carries the path parameters required to construct its URL and selects the appropriate HTTP method.

Inheritors

Types

Link copied to clipboard
data class BulkUpdateSubscriptionPhases(val subscriptionId: String) : SubscriptionPhaseEndpoints

Replaces all phases on a subscription in a single request. Resolves to PATCH /v1/subscriptions/{subscriptionId}/phases/bulk_update.

Link copied to clipboard
data class CreateSubscriptionPhase(val subscriptionId: String) : SubscriptionPhaseEndpoints

Creates a new phase on a subscription. Resolves to POST /v1/subscriptions/{subscriptionId}/phases.

Link copied to clipboard
data class DeleteSubscriptionPhase(val subscriptionId: String, val phaseId: String) : SubscriptionPhaseEndpoints

Deletes a phase from a subscription. Resolves to DELETE /v1/subscriptions/{subscriptionId}/phases/{phaseId}.

Link copied to clipboard
data class GetSubscriptionPhases(val subscriptionId: String) : SubscriptionPhaseEndpoints

Retrieves all phases for a subscription. Resolves to GET /v1/subscriptions/{subscriptionId}/phases.

Link copied to clipboard
data class GetSubscriptionPhaseWith(val subscriptionId: String, val phaseId: String) : SubscriptionPhaseEndpoints

Retrieves a single phase by ID. Resolves to GET /v1/subscriptions/{subscriptionId}/phases/{phaseId}.

Link copied to clipboard
data class UpdateSubscriptionPhase(val subscriptionId: String, val phaseId: String) : SubscriptionPhaseEndpoints

Updates an existing phase on a subscription. Resolves to PATCH /v1/subscriptions/{subscriptionId}/phases/{phaseId}.

Properties

Link copied to clipboard
open override val endpointURL: String

The fully qualified URL string for this endpoint.

Link copied to clipboard
open override val httpMethod: String

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

Link copied to clipboard
open override val queryItems: List<QueryItem>? = null

Optional query-string parameters appended to endpointURL.