FrameSDK/com.framepayments.framesdk.productphases/ProductPhasesAPI

ProductPhasesAPI

Provides suspend and callback-based methods for managing pricing phases on products.

Product phases define the billing stages of a subscription-based product. Each operation has two overloads: a coroutine-based suspend function that returns a Pair and a callback-based variant for use outside of coroutine scopes.

Functions

bulkUpdateProductPhases

suspend fun bulkUpdateProductPhases(productId: String, request: ProductPhaseRequest.BulkUpdateProductPhaseRequest): Pair<ListProductPhaseResponse?, NetworkingError?>

Replaces all phases on a product in a single request.

fun bulkUpdateProductPhases(productId: String, request: ProductPhaseRequest.BulkUpdateProductPhaseRequest, completionHandler: (ListProductPhaseResponse?, NetworkingError?) -> Unit)

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

createProductPhase

suspend fun createProductPhase(productId: String, request: ProductPhaseRequest.CreateProductPhaseRequest): Pair<SubscriptionPhase?, NetworkingError?>

Creates a new phase for a product.

fun createProductPhase(productId: String, request: ProductPhaseRequest.CreateProductPhaseRequest, completionHandler: (SubscriptionPhase?, NetworkingError?) -> Unit)

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

deleteProductPhaseWith

suspend fun deleteProductPhaseWith(productId: String, phaseId: String): NetworkingError?

Deletes a specific phase from a product.

fun deleteProductPhaseWith(productId: String, phaseId: String, completionHandler: (NetworkingError?) -> Unit)

Deletes a specific phase from a product and delivers the result via a callback.

getProductPhases

suspend fun getProductPhases(productId: String): Pair<ListProductPhaseResponse?, NetworkingError?>

Retrieves all phases associated with a product.

getProductPhaseWith

suspend fun getProductPhaseWith(productId: String, phaseId: String): Pair<SubscriptionPhase?, NetworkingError?>

Retrieves a specific phase on a product by its identifier.

getProducts

fun getProducts(productId: String, completionHandler: (ListProductPhaseResponse?, NetworkingError?) -> Unit)

Retrieves all phases associated with a product and delivers the result via a callback.

getProductWith

fun getProductWith(productId: String, phaseId: String, completionHandler: (SubscriptionPhase?, NetworkingError?) -> Unit)

Retrieves a specific phase on a product by its identifier and delivers the result via a callback.

updateProductPhase

suspend fun updateProductPhase(productId: String, phaseId: String, request: ProductPhaseRequest.UpdateProductPhaseRequest): Pair<SubscriptionPhase?, NetworkingError?>

Updates a specific phase on a product.

fun updateProductPhase(productId: String, phaseId: String, request: ProductPhaseRequest.UpdateProductPhaseRequest, completionHandler: (SubscriptionPhase?, NetworkingError?) -> Unit)

Updates a specific phase on a product and delivers the result via a callback.