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

UpdateSubscriptionPhaseRequest

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

Request body for partially updating an existing subscription phase.

Only non-null fields are sent to the API; omitted fields remain unchanged.

Constructors

Link copied to clipboard
constructor(ordinal: Int? = null, pricingType: PhasePricingType? = null, durationType: PhaseDurationType? = null, name: String? = null, amountCents: Int? = null, discountPercentage: Float? = null, periodCount: Int? = null, interval: String? = null, intervalCount: Int? = null)

Properties

Link copied to clipboard
@SerializedName(value = "amount_cents")
val amountCents: Int? = null

Updated billed amount in the smallest currency unit.

Link copied to clipboard
@SerializedName(value = "discount_percentage")
val discountPercentage: Float? = null

Updated percentage discount for the phase.

Link copied to clipboard
@SerializedName(value = "duration_type")
val durationType: PhaseDurationType? = null

Updated duration type for the phase.

Link copied to clipboard
val interval: String? = null

Updated billing interval unit.

Link copied to clipboard
@SerializedName(value = "interval_count")
val intervalCount: Int? = null

Updated number of interval units between billing cycles.

Link copied to clipboard
val name: String? = null

Updated human-readable label for the phase.

Link copied to clipboard
val ordinal: Int? = null

Updated position of the phase in the subscription's phase sequence.

Link copied to clipboard
@SerializedName(value = "period_count")
val periodCount: Int? = null

Updated number of billing periods for a finite phase.

Link copied to clipboard
@SerializedName(value = "pricing_type")
val pricingType: PhasePricingType? = null

Updated pricing strategy for the phase.