FrameSDK/com.framepayments.framesdk.subscriptionphases/SubscriptionPhasesAPI

SubscriptionPhasesAPI

object SubscriptionPhasesAPI

Provides suspend and callback-based operations for managing subscription phases.

Functions

Link copied to clipboard
suspend fun bulkUpdateSubscriptionPhases(subscriptionId: String, request: SubscriptionPhaseRequest.BulkUpdateSubscriptionPhaseRequest): Pair<List<SubscriptionPhase>?, NetworkingError?>

Replaces all phases on the specified subscription in a single request.

fun bulkUpdateSubscriptionPhases(subscriptionId: String, request: SubscriptionPhaseRequest.BulkUpdateSubscriptionPhaseRequest, completionHandler: (List<SubscriptionPhase>?, NetworkingError?) -> Unit)

Replaces all phases on the specified subscription in a single request and delivers the result via callback.

Link copied to clipboard
suspend fun createSubscriptionPhase(subscriptionId: String, request: SubscriptionPhaseRequest.CreateSubscriptionPhaseRequest): Pair<SubscriptionPhase?, NetworkingError?>

Creates a new phase for the specified subscription.

fun createSubscriptionPhase(subscriptionId: String, request: SubscriptionPhaseRequest.CreateSubscriptionPhaseRequest, completionHandler: (SubscriptionPhase?, NetworkingError?) -> Unit)

Creates a new phase for the specified subscription and delivers the result via callback.

Link copied to clipboard
suspend fun deleteSubscriptionPhaseWith(subscriptionId: String, phaseId: String): NetworkingError?

Deletes a single phase from the specified subscription.

fun deleteSubscriptionPhaseWith(subscriptionId: String, phaseId: String, completionHandler: (NetworkingError?) -> Unit)

Deletes a single phase from the specified subscription and delivers the result via callback.

Link copied to clipboard
suspend fun getSubscriptionPhases(subscriptionId: String): Pair<ListSubscriptionPhaseResponse?, NetworkingError?>

Fetches all phases for the specified subscription.

Link copied to clipboard
suspend fun getSubscriptionPhaseWith(subscriptionId: String, phaseId: String): Pair<SubscriptionPhase?, NetworkingError?>

Fetches a single phase by ID from the specified subscription.

Link copied to clipboard
fun getSubscriptions(subscriptionId: String, completionHandler: (ListSubscriptionPhaseResponse?, NetworkingError?) -> Unit)

Fetches all phases for the specified subscription and delivers the result via callback.

Link copied to clipboard
fun getSubscriptionWith(subscriptionId: String, phaseId: String, completionHandler: (SubscriptionPhase?, NetworkingError?) -> Unit)

Fetches a single phase by ID from the specified subscription and delivers the result via callback.

Link copied to clipboard
suspend fun updateSubscriptionPhase(subscriptionId: String, phaseId: String, request: SubscriptionPhaseRequest.UpdateSubscriptionPhaseRequest): Pair<SubscriptionPhase?, NetworkingError?>

Updates an existing phase on the specified subscription.

fun updateSubscriptionPhase(subscriptionId: String, phaseId: String, request: SubscriptionPhaseRequest.UpdateSubscriptionPhaseRequest, completionHandler: (SubscriptionPhase?, NetworkingError?) -> Unit)

Updates an existing phase on the specified subscription and delivers the result via callback.