Plan (ChargeBee Java 2.28.0 API)

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 and Description
`static class`	`Plan.AddonApplicability`
`static class`	`Plan.ApplicableAddon`
`static class`	`Plan.AttachedAddon`
`static class`	`Plan.ChargeModel` Deprecated.
`static class`	`Plan.CopyRequest`
`static class`	`Plan.CreateRequest`
`static class`	`Plan.EventBasedAddon`
`static class`	`Plan.PeriodUnit`
`static class`	`Plan.PlanListRequest`
`static class`	`Plan.ShippingFrequencyPeriodUnit`
`static class`	`Plan.Status`
`static class`	`Plan.Tier`
`static class`	`Plan.TrialEndAction`
`static class`	`Plan.TrialPeriodUnit`
`static class`	`Plan.UpdateRequest`

Field Summary
- Fields inherited from class com.chargebee.internal.Resource
  jsonObj

Constructor Summary

Constructors
Constructor and Description

Plan(org.json.JSONObject jsonObj)

Plan(String jsonStr)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and 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()`
`Integer`	`price()`
`String`	`priceInDecimal()`
`PricingModel`	`pricingModel()`
`String`	`redirectUrl()`
`Long`	`resourceVersion()`
`static Request`	`retrieve(String id)`
`Integer`	`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.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, optBigDecimal, optBoolean, optDouble, optEnum, optInteger, optJSONArray, optJSONObject, optList, optLong, optString, optSubResource, optTimestamp, reqBigDecimal, reqBoolean, reqDouble, reqEnum, reqInteger, reqJSONArray, reqJSONObject, reqList, reqLong, reqString, reqSubResource, reqTimestamp, toJson, toString, uri

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Plan
```
public Plan(String jsonStr)
```

Plan

public Plan(org.json.JSONObject jsonObj)

Method Detail

id
```
public String id()
```

name
```
public String name()
```

invoiceName
```
public String invoiceName()
```

description
```
public String description()
```

price
```
public Integer 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 Integer 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()
```

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)

Class Plan

Nested Class Summary

Field Summary

Fields inherited from class com.chargebee.internal.Resource

Constructor Summary

Method Summary

Methods inherited from class com.chargebee.internal.Resource

Methods inherited from class java.lang.Object

Constructor Detail

Plan

Plan

Method Detail

id

name

invoiceName

description

price

currencyCode

period

periodUnit

trialPeriod

trialPeriodUnit

trialEndAction

pricingModel

chargeModel

freeQuantity

setupCost

downgradePenalty

status

archivedAt

billingCycles

redirectUrl

enabledInHostedPages

enabledInPortal

addonApplicability

taxCode

hsnCode

taxjarProductCode

avalaraSaleType

avalaraTransactionType

avalaraServiceType

sku

accountingCode

accountingCategory1

accountingCategory2

accountingCategory3

accountingCategory4

isShippable

shippingFrequencyPeriod

shippingFrequencyPeriodUnit

resourceVersion

updatedAt

giftable

claimUrl

freeQuantityInDecimal

priceInDecimal

channel

invoiceNotes

taxable

taxProfileId

metaData

tiers

applicableAddons

attachedAddons

eventBasedAddons

showDescriptionInInvoices

showDescriptionInQuotes

create

update

list

retrieve

delete

copy

unarchive