Package com.xero.models.appstore

Class Subscription

java.lang.Object

com.xero.models.appstore.Subscription

public class Subscription
extends Object

Subscription

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Subscription.StatusEnum	Status of the subscription.

Constructor Summary

Constructors

Constructor	Description
Subscription()

Method Summary

Modifier and Type	Method	Description
Subscription	addPlansItem(Plan plansItem)	List of plans for the subscription.
Subscription	currentPeriodEnd(org.threeten.bp.LocalDateTime currentPeriodEnd)	End of the current period that the subscription has been invoiced for.
Subscription	endDate(org.threeten.bp.LocalDateTime endDate)	If the subscription has been canceled, this is the date when the subscription ends.
boolean	equals(Object o)
org.threeten.bp.LocalDateTime	getCurrentPeriodEnd()	End of the current period that the subscription has been invoiced for.
org.threeten.bp.LocalDateTime	getEndDate()	If the subscription has been canceled, this is the date when the subscription ends.
UUID	getId()	The unique identifier of the subscription
UUID	getOrganisationId()	The Xero generated unique identifier for the organisation
List<Plan>	getPlans()	List of plans for the subscription.
org.threeten.bp.LocalDateTime	getStartDate()	Date when the subscription was first created.
Subscription.StatusEnum	getStatus()	Status of the subscription.
Boolean	getTestMode()	Boolean used to indicate if the subscription is in test mode
int	hashCode()
Subscription	id(UUID id)	The unique identifier of the subscription
Subscription	organisationId(UUID organisationId)	The Xero generated unique identifier for the organisation
Subscription	plans(List<Plan> plans)	List of plans for the subscription.
void	setCurrentPeriodEnd(org.threeten.bp.LocalDateTime currentPeriodEnd)	End of the current period that the subscription has been invoiced for.
void	setEndDate(org.threeten.bp.LocalDateTime endDate)	If the subscription has been canceled, this is the date when the subscription ends.
void	setId(UUID id)	The unique identifier of the subscription
void	setOrganisationId(UUID organisationId)	The Xero generated unique identifier for the organisation
void	setPlans(List<Plan> plans)	List of plans for the subscription.
void	setStartDate(org.threeten.bp.LocalDateTime startDate)	Date when the subscription was first created.
void	setStatus(Subscription.StatusEnum status)	Status of the subscription.
void	setTestMode(Boolean testMode)	Boolean used to indicate if the subscription is in test mode
Subscription	startDate(org.threeten.bp.LocalDateTime startDate)	Date when the subscription was first created.
Subscription	status(Subscription.StatusEnum status)	Status of the subscription.
Subscription	testMode(Boolean testMode)	Boolean used to indicate if the subscription is in test mode
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Subscription

public Subscription()

Method Details

currentPeriodEnd

public Subscription currentPeriodEnd(org.threeten.bp.LocalDateTime currentPeriodEnd)

End of the current period that the subscription has been invoiced for.

Parameters:

currentPeriodEnd - LocalDateTime

Returns:

Subscription

getCurrentPeriodEnd

public org.threeten.bp.LocalDateTime getCurrentPeriodEnd()

End of the current period that the subscription has been invoiced for.

Returns:

currentPeriodEnd

setCurrentPeriodEnd

public void setCurrentPeriodEnd(org.threeten.bp.LocalDateTime currentPeriodEnd)

End of the current period that the subscription has been invoiced for.

Parameters:

currentPeriodEnd - LocalDateTime

endDate

public Subscription endDate(org.threeten.bp.LocalDateTime endDate)

If the subscription has been canceled, this is the date when the subscription ends. If null, the subscription is active and has not been cancelled

Parameters:

endDate - LocalDateTime

Returns:

Subscription

getEndDate

public org.threeten.bp.LocalDateTime getEndDate()

If the subscription has been canceled, this is the date when the subscription ends. If null, the subscription is active and has not been cancelled

Returns:

endDate

setEndDate

public void setEndDate(org.threeten.bp.LocalDateTime endDate)

If the subscription has been canceled, this is the date when the subscription ends. If null, the subscription is active and has not been cancelled

Parameters:

endDate - LocalDateTime

id

public Subscription id(UUID id)

The unique identifier of the subscription

Parameters:

id - UUID

Returns:

Subscription

getId

public UUID getId()

The unique identifier of the subscription

Returns:

id

setId

public void setId(UUID id)

The unique identifier of the subscription

Parameters:

id - UUID

organisationId

public Subscription organisationId(UUID organisationId)

The Xero generated unique identifier for the organisation

Parameters:

organisationId - UUID

Returns:

Subscription

getOrganisationId

public UUID getOrganisationId()

The Xero generated unique identifier for the organisation

Returns:

organisationId

setOrganisationId

public void setOrganisationId(UUID organisationId)

The Xero generated unique identifier for the organisation

Parameters:

organisationId - UUID

plans

public Subscription plans(List<Plan> plans)

List of plans for the subscription.

Parameters:

plans - List<Plan>

Returns:

Subscription

addPlansItem

public Subscription addPlansItem(Plan plansItem)

List of plans for the subscription.

Parameters:

plansItem - Plan

Returns:

Subscription

getPlans

public List<Plan> getPlans()

List of plans for the subscription.

Returns:

plans

setPlans

public void setPlans(List<Plan> plans)

List of plans for the subscription.

Parameters:

plans - List<Plan>

startDate

public Subscription startDate(org.threeten.bp.LocalDateTime startDate)

Date when the subscription was first created.

Parameters:

startDate - LocalDateTime

Returns:

Subscription

getStartDate

public org.threeten.bp.LocalDateTime getStartDate()

Date when the subscription was first created.

Returns:

startDate

setStartDate

public void setStartDate(org.threeten.bp.LocalDateTime startDate)

Date when the subscription was first created.

Parameters:

startDate - LocalDateTime

status

public Subscription status(Subscription.StatusEnum status)

Status of the subscription. Available statuses are ACTIVE, CANCELED, and PAST_DUE.

Parameters:

status - StatusEnum

Returns:

Subscription

getStatus

public Subscription.StatusEnum getStatus()

Status of the subscription. Available statuses are ACTIVE, CANCELED, and PAST_DUE.

Returns:

status

setStatus

public void setStatus(Subscription.StatusEnum status)

Status of the subscription. Available statuses are ACTIVE, CANCELED, and PAST_DUE.

Parameters:

status - StatusEnum

testMode

public Subscription testMode(Boolean testMode)

Boolean used to indicate if the subscription is in test mode

Parameters:

testMode - Boolean

Returns:

Subscription

getTestMode

public Boolean getTestMode()

Boolean used to indicate if the subscription is in test mode

Returns:

testMode

setTestMode

public void setTestMode(Boolean testMode)

Boolean used to indicate if the subscription is in test mode

Parameters:

testMode - Boolean

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object