com.apruve.models

Class Subscription

java.lang.Object

com.apruve.models.LineItem

com.apruve.models.Subscription

public class Subscription
extends LineItem

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SUBSCRIPTIONS_PATH

Fields inherited from class com.apruve.models.LineItem

LINE_ITEM_PATH

Constructor Summary

Constructors

Constructor and Description
Subscription()

Method Summary

Modifier and Type	Method and Description
static ApruveResponse<SubscriptionCancelResponse>	cancel(String subscriptionId) Cancels the Subscription with the given ID.
static ApruveResponse<Subscription>	get(String suscriptionId) Get the Subscription with the given ID
Date	getCanceledAt()
static String	getCancelPath(String subscriptionId)
Date	getEndAt()
Date	getLastChargeAt()
Date	getNextChargeAt()
Date	getStartAt()
static String	getSubscriptionsPath()
void	setCanceledAt(Date canceledAt)
void	setEndAt(Date endAt)
void	setLastChargeAt(Date lastChargeAt)
void	setNextChargeAt(Date nextChargeAt)
void	setStartAt(Date startAt)
protected String	subscriptionValues()
String	toJson()
String	toString()
ApruveResponse<SubscriptionUpdateResponse>	update() Updates the Subscription state at Apruve to match the current object state.

Methods inherited from class com.apruve.models.LineItem

get, getAll, getAmountCents, getApiUrl, getDescription, getId, getLineItemsPath, getMerchantNotes, getPaymentRequestId, getPlanCode, getPriceEachCents, getQuantity, getSku, getSubscriptionUrl, getTitle, getVariantInfo, getVendor, getViewProductUrl, setAmountCents, setApiUrl, setDescription, setId, setMerchantNotes, setPaymentRequestId, setPlanCode, setPriceEachCents, setQuantity, setSku, setSubscriptionUrl, setTitle, setVariantInfo, setVendor, setViewProductUrl, toValueString

Methods inherited from class java.lang.Object

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

Field Detail

SUBSCRIPTIONS_PATH

protected static String SUBSCRIPTIONS_PATH

Constructor Detail

Subscription

public Subscription()

Method Detail

toString

public String toString()

Overrides:

toString in class LineItem

toJson

public String toJson()

Overrides:

toJson in class LineItem

subscriptionValues

protected String subscriptionValues()

Overrides:

subscriptionValues in class LineItem

get

public static ApruveResponse<Subscription> get(String suscriptionId)

Get the Subscription with the given ID

Parameters:

suscriptionId - The ID of the Subscription to get

Returns:

Subscription, or null if not found

See Also:

https://www.apruve.com/doc/developers/rest-api/

update

public ApruveResponse<SubscriptionUpdateResponse> update()

Updates the Subscription state at Apruve to match the current object state.

Only the following fields are updated by this API call, and then only if the Subscription has not been canceled (i.e., canceledAt is null):

• quantity
• amountCents
• priceEachCents

Changes to any other fields are ignored.

Returns:

SubscriptionUpdateResponse, or null if the Subscription does not exist

See Also:

https://www.apruve.com/doc/developers/rest-api/

cancel

public static ApruveResponse<SubscriptionCancelResponse> cancel(String subscriptionId)

Cancels the Subscription with the given ID. This cannot be undone once completed, so use with care!

Returns:

SubscriptionCancelResponse

See Also:

https://www.apruve.com/doc/developers/rest-api/

getStartAt

public Date getStartAt()

setStartAt

public void setStartAt(Date startAt)

getNextChargeAt

public Date getNextChargeAt()

setNextChargeAt

public void setNextChargeAt(Date nextChargeAt)

getLastChargeAt

public Date getLastChargeAt()

setLastChargeAt

public void setLastChargeAt(Date lastChargeAt)

getEndAt

public Date getEndAt()

setEndAt

public void setEndAt(Date endAt)

getCanceledAt

public Date getCanceledAt()

setCanceledAt

public void setCanceledAt(Date canceledAt)

getSubscriptionsPath

public static String getSubscriptionsPath()

getCancelPath

public static String getCancelPath(String subscriptionId)