net.billforward.model

Class Subscription

java.lang.Object

net.billforward.model.BillingEntity

net.billforward.model.InsertableEntity<TEntityType>

net.billforward.model.MutableEntity<Subscription>

net.billforward.model.Subscription

public class Subscription
extends MutableEntity<Subscription>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Subscription.SubscriptionState
static class	Subscription.SubscriptionType

Field Summary

Fields

Modifier and Type	Field and Description
protected String	accountID
protected Date	actualStartDate
protected String	changedBy
protected Date	created
protected Date	currentPeriodEnd
protected Date	currentPeriodEndExplicit
protected Date	currentPeriodStart
protected String	description
protected Date	effectiveStartDate
protected String	id
protected String	locked
protected String	managedBy
protected String	name
protected String	organizationID
protected List<PaymentMethodSubscriptionLink>	paymentMethodSubscriptionLinks
protected List<PricingComponentValue>	pricingComponentValues
protected String	productID
protected RatePlan	productRatePlan
protected String	productRatePlanID
protected static ResourcePath	resourcePath
protected String	state
protected Date	subscriptionEnd
protected String	type
protected Date	updated

Fields inherited from class net.billforward.model.BillingEntity

m_client, PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor and Description
Subscription()
Subscription(BillForwardClient client_)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPaymentMethod(PaymentMethod paymentMethod)
CancellationAmendment	cancelAtPeriodEnd() Cancel subscription at the current period end
CancellationAmendment	cancelImmediately() Cancels a subscription immediately
static Subscription	create(Subscription subscription)
String	getAccountID()
Date	getActualStartDate()
static Subscription[]	getAll()
static Subscription[]	getByAccountID(String accountID)
static Subscription	getByID(String ID)
static Subscription[]	getByProductID(String productID)
static Subscription[]	getByRatePlanID(String ratePlanID)
static Subscription[]	getByState(Subscription.SubscriptionState state_)
String	getChangedBy()
Date	getCreated()
Date	getCurrentPeriodEnd()
Date	getCurrentPeriodEndExplicit()
Date	getCurrentPeriodStart()
String	getDescription()
Date	getEffectiveStartDate()
String	getID()
String	getManagedBy()
String	getName()
List<PricingComponentValue>	getPricingComponentValues()
String	getProductID()
RatePlan	getProductRatePlan()
String	getProductRatePlanID()
protected ResourcePath	getResourcePath()
Subscription.SubscriptionState	getState()
String	getStateAsString()
Date	getSubscriptionEnd()
Subscription.SubscriptionType	getType()
String	getTypeAsString()
Date	getUpdated()
protected static ResourcePath	ResourcePath()
void	setAccountID(String accountID)
void	setActualStartDate(Date actualStartDate)
void	setCurrentPeriodEnd(Date currentPeriodEnd)
void	setCurrentPeriodEndExplicit(Date currentPeriodEndExplicit)
void	setCurrentPeriodStart(Date currentPeriodStart)
void	setDescription(String description)
void	setEffectiveStartDate(Date effectiveStartDate)
void	setManagedBy(String managedBy)
void	setName(String name)
void	setPricingComponentValues(List<PricingComponentValue> pricingComponentValues)
void	setProductID(String productID)
void	setProductRatePlanID(String productRatePlanID)
void	setState(Subscription.SubscriptionState state)
void	setSubscriptionEnd(Date subscriptionEnd)
void	setType(Subscription.SubscriptionType type)
PricingComponentValueChangeAmendment	upgrade(HashMap<String,Integer> changes_) Upgrade or downgrade the subscription to the new value.
PricingComponentValueChangeAmendment	upgrade(List<ComponentChange> changes_) Upgrade or downgrade the subscription to the new value.
PricingComponentValueChangeAmendment	upgrade(String name, int newValue) Upgrade or downgrade the subscription to the new value.

Methods inherited from class net.billforward.model.MutableEntity

save

Methods inherited from class net.billforward.model.InsertableEntity

create, create, retire

Methods inherited from class net.billforward.model.BillingEntity

getAll, getByID, getByID, getByIDPostPath, getClient, setClient, toString

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

accountID

protected String accountID

organizationID

protected String organizationID

productID

protected String productID

productRatePlanID

protected String productRatePlanID

name

protected String name

description

protected String description

type

protected String type

state

protected String state

currentPeriodStart

protected Date currentPeriodStart

currentPeriodEnd

protected Date currentPeriodEnd

effectiveStartDate

protected Date effectiveStartDate

actualStartDate

protected Date actualStartDate

subscriptionEnd

protected Date subscriptionEnd

currentPeriodEndExplicit

protected Date currentPeriodEndExplicit

locked

protected String locked

managedBy

protected String managedBy

updated

protected Date updated

changedBy

protected String changedBy

created

protected Date created

productRatePlan

protected RatePlan productRatePlan

paymentMethodSubscriptionLinks

protected List<PaymentMethodSubscriptionLink> paymentMethodSubscriptionLinks

pricingComponentValues

protected List<PricingComponentValue> pricingComponentValues

resourcePath

protected static ResourcePath resourcePath

Constructor Detail

Subscription

public Subscription(BillForwardClient client_)

Subscription

public Subscription()

Method Detail

getID

public String getID()

getAccountID

public String getAccountID()

setAccountID

public void setAccountID(String accountID)

getProductID

public String getProductID()

setProductID

public void setProductID(String productID)

getProductRatePlanID

public String getProductRatePlanID()

setProductRatePlanID

public void setProductRatePlanID(String productRatePlanID)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getTypeAsString

public String getTypeAsString()

getType

public Subscription.SubscriptionType getType()

setType

public void setType(Subscription.SubscriptionType type)

getStateAsString

public String getStateAsString()

getState

public Subscription.SubscriptionState getState()

setState

public void setState(Subscription.SubscriptionState state)

getCurrentPeriodStart

public Date getCurrentPeriodStart()

setCurrentPeriodStart

public void setCurrentPeriodStart(Date currentPeriodStart)

getCurrentPeriodEnd

public Date getCurrentPeriodEnd()

setCurrentPeriodEnd

public void setCurrentPeriodEnd(Date currentPeriodEnd)

getEffectiveStartDate

public Date getEffectiveStartDate()

setEffectiveStartDate

public void setEffectiveStartDate(Date effectiveStartDate)

getActualStartDate

public Date getActualStartDate()

setActualStartDate

public void setActualStartDate(Date actualStartDate)

getSubscriptionEnd

public Date getSubscriptionEnd()

setSubscriptionEnd

public void setSubscriptionEnd(Date subscriptionEnd)

getCurrentPeriodEndExplicit

public Date getCurrentPeriodEndExplicit()

setCurrentPeriodEndExplicit

public void setCurrentPeriodEndExplicit(Date currentPeriodEndExplicit)

getManagedBy

public String getManagedBy()

setManagedBy

public void setManagedBy(String managedBy)

getUpdated

public Date getUpdated()

getChangedBy

public String getChangedBy()

getCreated

public Date getCreated()

getProductRatePlan

public RatePlan getProductRatePlan()

getPricingComponentValues

public List<PricingComponentValue> getPricingComponentValues()

setPricingComponentValues

public void setPricingComponentValues(List<PricingComponentValue> pricingComponentValues)

create

public static Subscription create(Subscription subscription)
                           throws AuthenticationException,
                                  InvalidRequestException,
                                  APIConnectionException,
                                  CardException,
                                  APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getByID

public static Subscription getByID(String ID)
                            throws AuthenticationException,
                                   InvalidRequestException,
                                   APIConnectionException,
                                   CardException,
                                   APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getByAccountID

public static Subscription[] getByAccountID(String accountID)
                                     throws AuthenticationException,
                                            InvalidRequestException,
                                            APIConnectionException,
                                            CardException,
                                            APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getByState

public static Subscription[] getByState(Subscription.SubscriptionState state_)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getByRatePlanID

public static Subscription[] getByRatePlanID(String ratePlanID)
                                      throws AuthenticationException,
                                             InvalidRequestException,
                                             APIConnectionException,
                                             CardException,
                                             APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getByProductID

public static Subscription[] getByProductID(String productID)
                                     throws AuthenticationException,
                                            InvalidRequestException,
                                            APIConnectionException,
                                            CardException,
                                            APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getAll

public static Subscription[] getAll()
                             throws AuthenticationException,
                                    InvalidRequestException,
                                    APIConnectionException,
                                    CardException,
                                    APIException

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

getResourcePath

protected ResourcePath getResourcePath()

Specified by:

getResourcePath in class BillingEntity

ResourcePath

protected static ResourcePath ResourcePath()

addPaymentMethod

public void addPaymentMethod(PaymentMethod paymentMethod)

cancelImmediately

public CancellationAmendment cancelImmediately()
                                        throws AuthenticationException,
                                               InvalidRequestException,
                                               APIConnectionException,
                                               CardException,
                                               APIException

Cancels a subscription immediately

Returns:

The amendment associated with the cancellation

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

cancelAtPeriodEnd

public CancellationAmendment cancelAtPeriodEnd()
                                        throws AuthenticationException,
                                               InvalidRequestException,
                                               APIConnectionException,
                                               CardException,
                                               APIException

Cancel subscription at the current period end

Returns:

The amendment associated with the cancellation

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

upgrade

public PricingComponentValueChangeAmendment upgrade(String name,
                                           int newValue)
                                             throws AuthenticationException,
                                                    InvalidRequestException,
                                                    APIConnectionException,
                                                    CardException,
                                                    APIException

Upgrade or downgrade the subscription to the new value.

If the new value is greater than the existing value a downgrade will occur. If the new value is less than the existing value an upgrade will occur. By default upgrades happen immediately and the upgrade cost is added to the next invoice. Downgrades happen at the end of the current billing period, with no refunds.

Parameters:

name - The name of the Pricing Component to upgrade

newValue - The new value of the pricing component

Returns:

The component change amendment which encapsulates the upgrade.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

upgrade

public PricingComponentValueChangeAmendment upgrade(HashMap<String,Integer> changes_)
                                             throws AuthenticationException,
                                                    InvalidRequestException,
                                                    APIConnectionException,
                                                    CardException,
                                                    APIException

Upgrade or downgrade the subscription to the new value.

If the new value is greater than the existing value a downgrade will occur. If the new value is less than the existing value an upgrade will occur. By default upgrades happen immediately and the upgrade cost is added to the next invoice. Downgrades happen at the end of the current billing period, with no refunds.

Parameters:

name - The name of the Pricing Component to upgrade

newValue - The new value of the pricing component

Returns:

The component change amendment which encapsulates the upgrade.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException

upgrade

public PricingComponentValueChangeAmendment upgrade(List<ComponentChange> changes_)
                                             throws AuthenticationException,
                                                    InvalidRequestException,
                                                    APIConnectionException,
                                                    CardException,
                                                    APIException

Upgrade or downgrade the subscription to the new value.

If the new value is greater than the existing value a downgrade will occur. If the new value is less than the existing value an upgrade will occur. By default upgrades happen immediately and the upgrade cost is added to the next invoice. Downgrades happen at the end of the current billing period, with no refunds.

Parameters:

name - The name of the Pricing Component to upgrade

newValue - The new value of the pricing component

Returns:

The component change amendment which encapsulates the upgrade.

Throws:

AuthenticationException

InvalidRequestException

APIConnectionException

CardException

APIException