ZSSubscriptionDetail

final public class ZSSubscriptionDetail : NSObject

ZSSubscriptonDetails will have the details of a particular subscription. It will have have the plan related details and the status of the subscription along with the expiry details.

  • A unique identifier of a particular subscription.

    Declaration

    Swift

    public var subscriptionId: String

  • A unique number for the subscription, auto generated based on predefined preferences while the subscription is created.

    Declaration

    Swift

    public var subscriptionNumber: String

  • The current status of the subscription.

    Declaration

    Swift

    public var status: ZSSubscriptionDetail.SubscriptionStatus

  • Formatted value of the subscription’s status.

    Declaration

    Swift

    public var statusFormatted: String

  • The renewal amount for the subscription.

    Declaration

    Swift

    public var amount: Double

  • The renewal amount for the subscription along with currency.

    Declaration

    Swift

    public var amountFormatted: String?

  • The interval in which the subscription has to be renewed. For example - 3 Months (3 is the interval here), 2 Weeks (2 is the interval here)

    Declaration

    Swift

    public var interval: Int

  • Referece id of the subscription.

    Declaration

    Swift

    public var referenceId: String

  • Name of the product under which the subscription is present.

    Declaration

    Swift

    public var productName: String

  • Name of the plan for which the subscription is created.

    Declaration

    Swift

    public var planName: String

  • Code configured for the plan.

    Declaration

    Swift

    public var planCode: String

  • Name of the plan for which the subscription is created.

    Declaration

    Swift

    public var planDescription: String

  • The remaining days available in trial period for the subscription.

    Declaration

    Swift

    public var trialRemainingDays: Int

  • Cancelled date of the subscription. Cancellation date.

    Declaration

    Swift

    public var cancelledDate: Date?

  • Formatted cancelled date of the subscription. Cancellation date.

    Declaration

    Swift

    public var cancelledDateFormatted: String?

  • Current term ending date of the subscription.

    Declaration

    Swift

    public var currentTermEndsDate: Date?

  • Formatted current term ending date of the subscription.

    Declaration

    Swift

    public var currentTermEndsDateFormatted: String?

  • The start date of the trial period.

    Declaration

    Swift

    public var trialStartsDate: Date?

  • Formatted the start date of the trial period.

    Declaration

    Swift

    public var trialStartsDateFormatted: String?

  • The end date of the trial period.

    Declaration

    Swift

    public var trialEndsDate: Date?

  • Formatted the end date of the trial period.

    Declaration

    Swift

    public var trialEndsDateFormatted: String?

  • The next billing retry date of the subscription.

    Declaration

    Swift

    public var nextRetryDate: Date?

  • Formatted value of the next retry date.

    Declaration

    Swift

    public var nextRetryDateFormatted: String?

  • Custom fields configured in Zoho Billing for the ZSSubscriptionDetail.

    Declaration

    Swift

    public var customFields: [ZSCustomField]

  • The name of the subscription.

    Declaration

    Swift

    public var name: String

  • Intervalconfigured for the plan for which the subscription is created. Example - Monthly, Yearly.

    Declaration

    Swift

    public var intervalUnit: ZSPlanInterval

  • Next billing date of the subscription. Next renewal date.

    Declaration

    Swift

    public var nextBillingDate: Date?

  • Formatted next billing date of the subscription. Next renewal date.

    Declaration

    Swift

    public var nextBillingDateFormatted: String?

  • The source from where the subscription was created.

    Declaration

    Swift

    public var source: ZSSubscriptionDetail.SubscriptionSource

  • The current status of the subscription.

    See more

    Declaration

    Swift

    public enum SubscriptionStatus : Int

  • The source from where the subscription was created.

    See more

    Declaration

    Swift

    public enum SubscriptionSource : Int