FrameSDK/com.framepayments.framesdk.subscriptionphases/SubscriptionPhaseRequest/CreateSubscriptionPhaseRequest

CreateSubscriptionPhaseRequest

data class CreateSubscriptionPhaseRequest(val ordinal: Int, val pricingType: PhasePricingType, val durationType: PhaseDurationType, val name: String?, val amountCents: Int?, val discountPercentage: Float?, val periodCount: Int?, val interval: String?, val intervalCount: Int?)

Request body for creating a new subscription phase.

Constructors

CreateSubscriptionPhaseRequest

constructor(ordinal: Int, pricingType: PhasePricingType, durationType: PhaseDurationType, name: String?, amountCents: Int?, discountPercentage: Float?, periodCount: Int?, interval: String?, intervalCount: Int?)

Properties

@SerializedName(value = "amount_cents")

val amountCents: Int?

Billed amount in the smallest currency unit (e.g. cents).

discountPercentage

@SerializedName(value = "discount_percentage")

val discountPercentage: Float?

Percentage discount to apply to the phase amount.

@SerializedName(value = "duration_type")

val durationType: PhaseDurationType

Whether the phase is finite or infinite.

val interval: String?

Billing interval unit (e.g. "month", "year").

@SerializedName(value = "interval_count")

val intervalCount: Int?

Number of interval units between each billing cycle.

val name: String?

Human-readable label for the phase.

val ordinal: Int

Position of this phase in the subscription's phase sequence.

@SerializedName(value = "period_count")

val periodCount: Int?

Number of billing periods the phase spans; required when durationType is PhaseDurationType.FINITE.

@SerializedName(value = "pricing_type")

val pricingType: PhasePricingType

Pricing strategy for the phase.