FrameSDK/com.framepayments.framesdk.subscriptions/Subscription

Subscription

data class Subscription(val id: String?, val description: String?, val currentPeriodStart: Int?, val currentPeriodEnd: Int?, val livemode: Boolean?, val plan: SubscriptionPlan?, val currency: String?, val status: String?, val quantity: Int?, val customer: String?, val defaultPaymentMethod: String?, val subscriptionObject: String?, val created: Int?, val startDate: Int?)

Represents a recurring billing subscription for a customer.

Constructors

constructor(id: String?, description: String?, currentPeriodStart: Int?, currentPeriodEnd: Int?, livemode: Boolean?, plan: SubscriptionPlan?, currency: String?, status: String?, quantity: Int?, customer: String?, defaultPaymentMethod: String?, subscriptionObject: String?, created: Int?, startDate: Int?)

Properties

val created: Int?

Unix timestamp of when the subscription was created.

val currency: String?

Three-letter ISO currency code used for billing.

currentPeriodEnd

@SerializedName(value = "current_period_end")

val currentPeriodEnd: Int?

Unix timestamp marking the end of the current billing period.

currentPeriodStart

@SerializedName(value = "current_period_start")

val currentPeriodStart: Int?

Unix timestamp marking the start of the current billing period.

val customer: String?

ID of the customer this subscription belongs to.

defaultPaymentMethod

@SerializedName(value = "default_payment_method")

val defaultPaymentMethod: String?

ID of the payment method used for recurring charges.

val description: String?

Optional description of the subscription.

val id: String?

Unique identifier for the subscription.

val livemode: Boolean?

Whether the subscription exists in live mode (true) or test mode (false).

val plan: SubscriptionPlan?

The billing plan associated with this subscription.

val quantity: Int?

Number of units of the plan included in this subscription.

@SerializedName(value = "start_date")

val startDate: Int?

Unix timestamp of when the subscription billing began.

val status: String?

Current status of the subscription (e.g., "active", "cancelled", "past_due").

subscriptionObject

@SerializedName(value = "object")

val subscriptionObject: String?

String identifier for the object type, always "subscription".