Package com.chargebee.models

Class Plan

java.lang.Object

com.chargebee.internal.Resource<Plan>

com.chargebee.models.Plan

public class Plan
extends Resource<Plan>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Plan.AddonApplicability
static class	Plan.ApplicableAddon
static class	Plan.AttachedAddon
static enum	Plan.ChargeModel	Deprecated.
static class	Plan.CopyRequest
static class	Plan.CreateRequest
static class	Plan.EventBasedAddon
static enum	Plan.PeriodUnit
static class	Plan.PlanListRequest
static enum	Plan.ShippingFrequencyPeriodUnit
static enum	Plan.Status
static class	Plan.TaxProvidersField
static class	Plan.Tier
static enum	Plan.TrialEndAction
static enum	Plan.TrialPeriodUnit
static class	Plan.UpdateRequest

Field Summary

Fields inherited from class com.chargebee.internal.Resource

jsonObj

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	accountingCategory1()
String	accountingCategory2()
String	accountingCategory3()
String	accountingCategory4()
String	accountingCode()
Plan.AddonApplicability	addonApplicability()
List<Plan.ApplicableAddon>	applicableAddons()
Timestamp	archivedAt()
List<Plan.AttachedAddon>	attachedAddons()
AvalaraSaleType	avalaraSaleType()
Integer	avalaraServiceType()
Integer	avalaraTransactionType()
Integer	billingCycles()
Channel	channel()
Plan.ChargeModel	chargeModel()	Deprecated.
String	claimUrl()
static Plan.CopyRequest	copy()
static Plan.CreateRequest	create()
String	currencyCode()
static Request	delete(String id)
String	description()
Double	downgradePenalty()	Deprecated.
Boolean	enabledInHostedPages()
Boolean	enabledInPortal()
List<Plan.EventBasedAddon>	eventBasedAddons()
Integer	freeQuantity()
String	freeQuantityInDecimal()
Boolean	giftable()
String	hsnCode()
String	id()
String	invoiceName()
String	invoiceNotes()
Boolean	isShippable()
static Plan.PlanListRequest	list()
org.json.JSONObject	metaData()
String	name()
Integer	period()
Plan.PeriodUnit	periodUnit()
Long	price()
String	priceInDecimal()
PricingModel	pricingModel()
String	redirectUrl()
Long	resourceVersion()
static Request	retrieve(String id)
Long	setupCost()
Integer	shippingFrequencyPeriod()
Plan.ShippingFrequencyPeriodUnit	shippingFrequencyPeriodUnit()
Boolean	showDescriptionInInvoices()
Boolean	showDescriptionInQuotes()
String	sku()
Plan.Status	status()
Boolean	taxable()
String	taxCode()
String	taxjarProductCode()
String	taxProfileId()
List<Plan.TaxProvidersField>	taxProvidersFields()
List<Plan.Tier>	tiers()
Plan.TrialEndAction	trialEndAction()
Integer	trialPeriod()
Plan.TrialPeriodUnit	trialPeriodUnit()
static Request	unarchive(String id)
static Plan.UpdateRequest	update(String id)
Timestamp	updatedAt()

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

Plan

public Plan(String jsonStr)

Plan

public Plan(org.json.JSONObject jsonObj)

Method Details

id

public String id()

name

public String name()

invoiceName

public String invoiceName()

description

public String description()

price

public Long price()

currencyCode

public String currencyCode()

period

public Integer period()

periodUnit

public Plan.PeriodUnit periodUnit()

trialPeriod

public Integer trialPeriod()

trialPeriodUnit

public Plan.TrialPeriodUnit trialPeriodUnit()

trialEndAction

public Plan.TrialEndAction trialEndAction()

pricingModel

public PricingModel pricingModel()

chargeModel

@Deprecated
public Plan.ChargeModel chargeModel()

Deprecated.

freeQuantity

public Integer freeQuantity()

setupCost

public Long setupCost()

downgradePenalty

@Deprecated
public Double downgradePenalty()

Deprecated.

status

public Plan.Status status()

archivedAt

public Timestamp archivedAt()

billingCycles

public Integer billingCycles()

redirectUrl

public String redirectUrl()

enabledInHostedPages

public Boolean enabledInHostedPages()

enabledInPortal

public Boolean enabledInPortal()

addonApplicability

public Plan.AddonApplicability addonApplicability()

taxCode

public String taxCode()

hsnCode

public String hsnCode()

taxjarProductCode

public String taxjarProductCode()

avalaraSaleType

public AvalaraSaleType avalaraSaleType()

avalaraTransactionType

public Integer avalaraTransactionType()

avalaraServiceType

public Integer avalaraServiceType()

sku

public String sku()

accountingCode

public String accountingCode()

accountingCategory1

public String accountingCategory1()

accountingCategory2

public String accountingCategory2()

accountingCategory3

public String accountingCategory3()

accountingCategory4

public String accountingCategory4()

isShippable

public Boolean isShippable()

shippingFrequencyPeriod

public Integer shippingFrequencyPeriod()

shippingFrequencyPeriodUnit

public Plan.ShippingFrequencyPeriodUnit shippingFrequencyPeriodUnit()

resourceVersion

public Long resourceVersion()

updatedAt

public Timestamp updatedAt()

giftable

public Boolean giftable()

claimUrl

public String claimUrl()

freeQuantityInDecimal

public String freeQuantityInDecimal()

priceInDecimal

public String priceInDecimal()

channel

public Channel channel()

invoiceNotes

public String invoiceNotes()

taxable

public Boolean taxable()

taxProfileId

public String taxProfileId()

metaData

public org.json.JSONObject metaData()

tiers

public List<Plan.Tier> tiers()

taxProvidersFields

public List<Plan.TaxProvidersField> taxProvidersFields()

applicableAddons

public List<Plan.ApplicableAddon> applicableAddons()

attachedAddons

public List<Plan.AttachedAddon> attachedAddons()

eventBasedAddons

public List<Plan.EventBasedAddon> eventBasedAddons()

showDescriptionInInvoices

public Boolean showDescriptionInInvoices()

showDescriptionInQuotes

public Boolean showDescriptionInQuotes()

create

public static Plan.CreateRequest create()

update

public static Plan.UpdateRequest update(String id)

list

public static Plan.PlanListRequest list()

retrieve

public static Request retrieve(String id)

delete

public static Request delete(String id)

copy

public static Plan.CopyRequest copy()

unarchive

public static Request unarchive(String id)