Package com.chargebee.models

Class Subscription

java.lang.Object

com.chargebee.internal.Resource<Subscription>

com.chargebee.models.Subscription

public class Subscription
extends Resource<Subscription>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Subscription.AddChargeAtTermEndRequest
static class	Subscription.Addon
static class	Subscription.BillingOverride
static enum	Subscription.BillingPeriodUnit
static class	Subscription.CancelForItemsRequest
static enum	Subscription.CancelReason
static class	Subscription.CancelRequest
static class	Subscription.ChangeTermEndRequest
static class	Subscription.ChargeAddonAtTermEndRequest
static class	Subscription.ChargedEventBasedAddon
static class	Subscription.ChargedItem
static class	Subscription.ChargeFutureRenewalsRequest
static class	Subscription.ContractTerm
static class	Subscription.Coupon
static class	Subscription.CreateForCustomerRequest
static class	Subscription.CreateRequest
static class	Subscription.CreateWithItemsRequest
static class	Subscription.Discount
static class	Subscription.EditAdvanceInvoiceScheduleRequest
static class	Subscription.EventBasedAddon
static class	Subscription.ImportContractTermRequest
static class	Subscription.ImportForCustomerRequest
static class	Subscription.ImportForItemsRequest
static class	Subscription.ImportSubscriptionRequest
static class	Subscription.ImportUnbilledChargesRequest
static class	Subscription.ItemTier
static class	Subscription.MoveRequest
static class	Subscription.OverrideBillingProfileRequest
static class	Subscription.PauseRequest
static class	Subscription.ReactivateRequest
static class	Subscription.ReferralInfo
static class	Subscription.RegenerateInvoiceRequest
static class	Subscription.RemoveAdvanceInvoiceScheduleRequest
static class	Subscription.RemoveCouponsRequest
static class	Subscription.RemoveScheduledCancellationRequest
static class	Subscription.ResumeRequest
static class	Subscription.ShippingAddress
static enum	Subscription.Status
static class	Subscription.SubscriptionContractTermsForSubscriptionRequest
static class	Subscription.SubscriptionItem
static class	Subscription.SubscriptionListRequest
static class	Subscription.UpdateForItemsRequest
static class	Subscription.UpdateRequest

Field Summary

Fields inherited from class com.chargebee.internal.Resource

jsonObj

Constructor Summary

Constructors

Constructor	Description
Subscription(String jsonStr)
Subscription(org.json.JSONObject jsonObj)

Method Summary

Modifier and Type	Method	Description
Timestamp	activatedAt()
String	activeId()
static Subscription.AddChargeAtTermEndRequest	addChargeAtTermEnd(String id)
List<Subscription.Addon>	addons()
String	affiliateToken()
Long	arr()	Deprecated.
Boolean	autoCloseInvoices()
AutoCollection	autoCollection()
String	baseCurrencyCode()
Subscription.BillingOverride	billingOverride()
Integer	billingPeriod()
Subscription.BillingPeriodUnit	billingPeriodUnit()
String	businessEntityId()
static Subscription.CancelRequest	cancel(String id)
static Subscription.CancelForItemsRequest	cancelForItems(String id)
Timestamp	cancelledAt()
Subscription.CancelReason	cancelReason()
String	cancelReasonCode()
Timestamp	cancelScheduleCreatedAt()
Timestamp	changesScheduledAt()
static Subscription.ChangeTermEndRequest	changeTermEnd(String id)
Channel	channel()
static Subscription.ChargeAddonAtTermEndRequest	chargeAddonAtTermEnd(String id)
List<Subscription.ChargedEventBasedAddon>	chargedEventBasedAddons()
List<Subscription.ChargedItem>	chargedItems()
static Subscription.ChargeFutureRenewalsRequest	chargeFutureRenewals(String id)
Subscription.ContractTerm	contractTerm()
Integer	contractTermBillingCycleOnRenewal()
static Subscription.SubscriptionContractTermsForSubscriptionRequest	contractTermsForSubscription(String id)
String	coupon()	Deprecated.
List<Subscription.Coupon>	coupons()
static Subscription.CreateRequest	create()
Timestamp	createdAt()
String	createdFromIp()
static Subscription.CreateForCustomerRequest	createForCustomer(String id)
Boolean	createPendingInvoices()
static Subscription.CreateWithItemsRequest	createWithItems(String id)
String	currencyCode()
Timestamp	currentTermEnd()
Timestamp	currentTermStart()
String	customerId()
static Request	delete(String id)
Boolean	deleted()
List<Subscription.Discount>	discounts()
Integer	dueInvoicesCount()
Timestamp	dueSince()
static Subscription.EditAdvanceInvoiceScheduleRequest	editAdvanceInvoiceSchedule(String id)
List<Subscription.EventBasedAddon>	eventBasedAddons()
BigDecimal	exchangeRate()
Integer	freePeriod()
FreePeriodUnit	freePeriodUnit()
String	giftId()
Boolean	hasScheduledAdvanceInvoices()
Boolean	hasScheduledChanges()
String	id()
static Subscription.ImportContractTermRequest	importContractTerm(String id)
static Subscription.ImportForCustomerRequest	importForCustomer(String id)
static Subscription.ImportForItemsRequest	importForItems(String id)
static Subscription.ImportSubscriptionRequest	importSubscription()
static Subscription.ImportUnbilledChargesRequest	importUnbilledCharges(String id)
String	invoiceNotes()
List<Subscription.ItemTier>	itemTiers()
static Subscription.SubscriptionListRequest	list()
static ListRequest	listDiscounts(String id)
org.json.JSONObject	metadata()	Deprecated.
org.json.JSONObject	metaData()
static Subscription.MoveRequest	move(String id)
Long	mrr()
Integer	netTermDays()
Timestamp	nextBillingAt()
OfflinePaymentMethod	offlinePaymentMethod()
static Subscription.OverrideBillingProfileRequest	overrideBillingProfile(String id)
Boolean	overrideRelationship()
static Subscription.PauseRequest	pause(String id)
Timestamp	pauseDate()
String	paymentSourceId()
Long	planAmount()
String	planAmountInDecimal()
Integer	planFreeQuantity()
String	planFreeQuantityInDecimal()
String	planId()
Integer	planQuantity()
String	planQuantityInDecimal()
Long	planUnitPrice()
String	planUnitPriceInDecimal()
String	poNumber()
static Subscription.ReactivateRequest	reactivate(String id)
Subscription.ReferralInfo	referralInfo()
static Subscription.RegenerateInvoiceRequest	regenerateInvoice(String id)
Integer	remainingBillingCycles()
static Subscription.RemoveAdvanceInvoiceScheduleRequest	removeAdvanceInvoiceSchedule(String id)
static Subscription.RemoveCouponsRequest	removeCoupons(String id)
static Subscription.RemoveScheduledCancellationRequest	removeScheduledCancellation(String id)
static Request	removeScheduledChanges(String id)
static Request	removeScheduledPause(String id)
static Request	removeScheduledResumption(String id)
Long	resourceVersion()
static Subscription.ResumeRequest	resume(String id)
Timestamp	resumeDate()
static Request	retrieve(String id)
static Request	retrieveAdvanceInvoiceSchedule(String id)
static Request	retrieveWithScheduledChanges(String id)
Long	setupFee()
Subscription.ShippingAddress	shippingAddress()
Timestamp	startDate()
Timestamp	startedAt()
Subscription.Status	status()
List<Subscription.SubscriptionItem>	subscriptionItems()
static ListRequest	subscriptionsForCustomer(String id)	Deprecated.
Long	totalDues()
Timestamp	trialEnd()
TrialEndAction	trialEndAction()
Timestamp	trialStart()
static Subscription.UpdateRequest	update(String id)
Timestamp	updatedAt()
static Subscription.UpdateForItemsRequest	updateForItems(String id)

Methods inherited from class com.chargebee.internal.Resource

apiVersionCheck, nullCheck, nullCheckWithoutEncoding, optBigDecimal, optBoolean, optDouble, optEnum, optInteger, optJSONArray, optJSONObject, optList, optLong, optMap, optString, optSubResource, optTimestamp, reqBigDecimal, reqBoolean, reqDouble, reqEnum, reqInteger, reqJSONArray, reqJSONObject, reqList, reqLong, reqMap, reqString, reqSubResource, reqTimestamp, toJson, toString, uri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Subscription

public Subscription(String jsonStr)

Subscription

public Subscription(org.json.JSONObject jsonObj)

Method Details

id

public String id()

currencyCode

public String currencyCode()

planId

public String planId()

planQuantity

public Integer planQuantity()

planUnitPrice

public Long planUnitPrice()

setupFee

public Long setupFee()

billingPeriod

public Integer billingPeriod()

billingPeriodUnit

public Subscription.BillingPeriodUnit billingPeriodUnit()

startDate

public Timestamp startDate()

trialEnd

public Timestamp trialEnd()

remainingBillingCycles

public Integer remainingBillingCycles()

poNumber

public String poNumber()

autoCollection

public AutoCollection autoCollection()

planQuantityInDecimal

public String planQuantityInDecimal()

planUnitPriceInDecimal

public String planUnitPriceInDecimal()

customerId

public String customerId()

planAmount

public Long planAmount()

planFreeQuantity

public Integer planFreeQuantity()

status

public Subscription.Status status()

trialStart

public Timestamp trialStart()

trialEndAction

public TrialEndAction trialEndAction()

currentTermStart

public Timestamp currentTermStart()

currentTermEnd

public Timestamp currentTermEnd()

nextBillingAt

public Timestamp nextBillingAt()

createdAt

public Timestamp createdAt()

startedAt

public Timestamp startedAt()

activatedAt

public Timestamp activatedAt()

giftId

public String giftId()

contractTermBillingCycleOnRenewal

public Integer contractTermBillingCycleOnRenewal()

overrideRelationship

public Boolean overrideRelationship()

pauseDate

public Timestamp pauseDate()

resumeDate

public Timestamp resumeDate()

cancelledAt

public Timestamp cancelledAt()

cancelReason

public Subscription.CancelReason cancelReason()

affiliateToken

public String affiliateToken()

createdFromIp

public String createdFromIp()

resourceVersion

public Long resourceVersion()

updatedAt

public Timestamp updatedAt()

hasScheduledAdvanceInvoices

public Boolean hasScheduledAdvanceInvoices()

hasScheduledChanges

public Boolean hasScheduledChanges()

paymentSourceId

public String paymentSourceId()

planFreeQuantityInDecimal

public String planFreeQuantityInDecimal()

planAmountInDecimal

public String planAmountInDecimal()

cancelScheduleCreatedAt

public Timestamp cancelScheduleCreatedAt()

offlinePaymentMethod

public OfflinePaymentMethod offlinePaymentMethod()

channel

public Channel channel()

netTermDays

public Integer netTermDays()

activeId

public String activeId()

subscriptionItems

public List<Subscription.SubscriptionItem> subscriptionItems()

itemTiers

public List<Subscription.ItemTier> itemTiers()

chargedItems

public List<Subscription.ChargedItem> chargedItems()

dueInvoicesCount

public Integer dueInvoicesCount()

dueSince

public Timestamp dueSince()

totalDues

public Long totalDues()

mrr

public Long mrr()

arr

@Deprecated
public Long arr()

Deprecated.

exchangeRate

public BigDecimal exchangeRate()

baseCurrencyCode

public String baseCurrencyCode()

addons

public List<Subscription.Addon> addons()

eventBasedAddons

public List<Subscription.EventBasedAddon> eventBasedAddons()

chargedEventBasedAddons

public List<Subscription.ChargedEventBasedAddon> chargedEventBasedAddons()

coupon

@Deprecated
public String coupon()

Deprecated.

coupons

public List<Subscription.Coupon> coupons()

shippingAddress

public Subscription.ShippingAddress shippingAddress()

referralInfo

public Subscription.ReferralInfo referralInfo()

billingOverride

public Subscription.BillingOverride billingOverride()

invoiceNotes

public String invoiceNotes()

metaData

public org.json.JSONObject metaData()

deleted

public Boolean deleted()

changesScheduledAt

public Timestamp changesScheduledAt()

contractTerm

public Subscription.ContractTerm contractTerm()

cancelReasonCode

public String cancelReasonCode()

freePeriod

public Integer freePeriod()

freePeriodUnit

public FreePeriodUnit freePeriodUnit()

createPendingInvoices

public Boolean createPendingInvoices()

autoCloseInvoices

public Boolean autoCloseInvoices()

discounts

public List<Subscription.Discount> discounts()

businessEntityId

public String businessEntityId()

metadata

@Deprecated
public org.json.JSONObject metadata()

Deprecated.

create

public static Subscription.CreateRequest create()

createForCustomer

public static Subscription.CreateForCustomerRequest createForCustomer(String id)

createWithItems

public static Subscription.CreateWithItemsRequest createWithItems(String id)

list

public static Subscription.SubscriptionListRequest list()

subscriptionsForCustomer

@Deprecated
public static ListRequest subscriptionsForCustomer(String id)

Deprecated.

contractTermsForSubscription

public static Subscription.SubscriptionContractTermsForSubscriptionRequest contractTermsForSubscription(String id)

listDiscounts

public static ListRequest listDiscounts(String id)

retrieve

public static Request retrieve(String id)

retrieveWithScheduledChanges

public static Request retrieveWithScheduledChanges(String id)

removeScheduledChanges

public static Request removeScheduledChanges(String id)

removeScheduledCancellation

public static Subscription.RemoveScheduledCancellationRequest removeScheduledCancellation(String id)

removeCoupons

public static Subscription.RemoveCouponsRequest removeCoupons(String id)

update

public static Subscription.UpdateRequest update(String id)

updateForItems

public static Subscription.UpdateForItemsRequest updateForItems(String id)

changeTermEnd

public static Subscription.ChangeTermEndRequest changeTermEnd(String id)

reactivate

public static Subscription.ReactivateRequest reactivate(String id)

addChargeAtTermEnd

public static Subscription.AddChargeAtTermEndRequest addChargeAtTermEnd(String id)

chargeAddonAtTermEnd

public static Subscription.ChargeAddonAtTermEndRequest chargeAddonAtTermEnd(String id)

chargeFutureRenewals

public static Subscription.ChargeFutureRenewalsRequest chargeFutureRenewals(String id)

editAdvanceInvoiceSchedule

public static Subscription.EditAdvanceInvoiceScheduleRequest editAdvanceInvoiceSchedule(String id)

retrieveAdvanceInvoiceSchedule

public static Request retrieveAdvanceInvoiceSchedule(String id)

removeAdvanceInvoiceSchedule

public static Subscription.RemoveAdvanceInvoiceScheduleRequest removeAdvanceInvoiceSchedule(String id)

regenerateInvoice

public static Subscription.RegenerateInvoiceRequest regenerateInvoice(String id)

importSubscription

public static Subscription.ImportSubscriptionRequest importSubscription()

importForCustomer

public static Subscription.ImportForCustomerRequest importForCustomer(String id)

importContractTerm

public static Subscription.ImportContractTermRequest importContractTerm(String id)

importUnbilledCharges

public static Subscription.ImportUnbilledChargesRequest importUnbilledCharges(String id)

importForItems

public static Subscription.ImportForItemsRequest importForItems(String id)

overrideBillingProfile

public static Subscription.OverrideBillingProfileRequest overrideBillingProfile(String id)

delete

public static Request delete(String id)

pause

public static Subscription.PauseRequest pause(String id)

cancel

public static Subscription.CancelRequest cancel(String id)

cancelForItems

public static Subscription.CancelForItemsRequest cancelForItems(String id)

resume

public static Subscription.ResumeRequest resume(String id)

removeScheduledPause

public static Request removeScheduledPause(String id)

removeScheduledResumption

public static Request removeScheduledResumption(String id)

move

public static Subscription.MoveRequest move(String id)