com.apruve.models

Class SubscriptionAdjustment

java.lang.Object

com.apruve.models.SubscriptionAdjustment

public class SubscriptionAdjustment
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriptionAdjustment.SubscriptionAdjustmentStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SUBSCRIPTION_ADJUSTMENTS_PATH

Constructor Summary

Constructors

Constructor and Description
SubscriptionAdjustment()

Method Summary

Methods

Modifier and Type	Method and Description
ApruveResponse<SubscriptionAdjustmentCreateResponse>	create(String subscriptionId) Create this SubscriptionAdjustment on the Apruve servers.
static ApruveResponse<SubscriptionAdjustmentDeleteResponse>	delete(String subscriptionId, String adjustmentId) Delete the specified SubscriptionAdjustment from the Apruve servers.
static ApruveResponse<SubscriptionAdjustment>	get(String subscriptionId, String adjustmentId) Get the SubscriptionAdjustment with the given ID
static ApruveResponse<List<SubscriptionAdjustment>>	getAllAdjustments(String subscriptionId) Get all SubscriptionAdjustments for the specified Subscription.
Integer	getAmountCents()
String	getDescription()
String	getId()
Integer	getPriceEachCents()
Integer	getQuantity()
String	getSku()
SubscriptionAdjustment.SubscriptionAdjustmentStatus	getStatus()
static String	getSubscriptionAdjustmentsPath(String subscriptionId)
String	getTitle()
String	getVariantInfo()
String	getVendor()
URL	getViewProductUrl()
void	setAmountCents(Integer amountCents)
void	setDescription(String description)
void	setId(String id)
void	setPriceEachCents(Integer priceEachCents)
void	setQuantity(Integer quantity)
void	setSku(String sku)
void	setStatus(SubscriptionAdjustment.SubscriptionAdjustmentStatus status)
void	setTitle(String title)
void	setVariantInfo(String variantInfo)
void	setVendor(String vendor)
void	setViewProductUrl(URL viewProductUrl)
String	toJson()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SUBSCRIPTION_ADJUSTMENTS_PATH

protected static final String SUBSCRIPTION_ADJUSTMENTS_PATH

Constructor Detail

SubscriptionAdjustment

public SubscriptionAdjustment()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

toJson

public String toJson()

get

public static ApruveResponse<SubscriptionAdjustment> get(String subscriptionId,
                                         String adjustmentId)

Get the SubscriptionAdjustment with the given ID

Parameters:

subscriptionId - The ID of the Subscription that owns the SubscriptionAdjustment

adjustmentId - The ID of the SubscriptionAdjustment

Returns:

Subscription, or null if not found

See Also:

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

getAllAdjustments

public static ApruveResponse<List<SubscriptionAdjustment>> getAllAdjustments(String subscriptionId)

Get all SubscriptionAdjustments for the specified Subscription.

Parameters:

subscriptionId - The ID of the Subscription that owns the SubscriptionAdjustment

Returns:

List of SubscriptionAdjustment

See Also:

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

create

public ApruveResponse<SubscriptionAdjustmentCreateResponse> create(String subscriptionId)

Create this SubscriptionAdjustment on the Apruve servers.

Parameters:

subscriptionId - The ID of the Subscription that will own the SubscriptionAdjustment

Returns:

SubscriptionAdjustmentCreateResponse

See Also:

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

delete

public static ApruveResponse<SubscriptionAdjustmentDeleteResponse> delete(String subscriptionId,
                                                          String adjustmentId)

Delete the specified SubscriptionAdjustment from the Apruve servers. This is only allowed for SubscriptionAdjustments that are not in APPLIED status.

Parameters:

subscriptionId - The ID of the Subscription that will own the SubscriptionAdjustment

adjustmentId - The ID of the SubscriptionAdjustment to delete

Returns:

SubscriptionAdjustmentDeleteResponse

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getAmountCents

public Integer getAmountCents()

setAmountCents

public void setAmountCents(Integer amountCents)

getPriceEachCents

public Integer getPriceEachCents()

setPriceEachCents

public void setPriceEachCents(Integer priceEachCents)

getQuantity

public Integer getQuantity()

setQuantity

public void setQuantity(Integer quantity)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getVariantInfo

public String getVariantInfo()

setVariantInfo

public void setVariantInfo(String variantInfo)

getSku

public String getSku()

setSku

public void setSku(String sku)

getVendor

public String getVendor()

setVendor

public void setVendor(String vendor)

getViewProductUrl

public URL getViewProductUrl()

setViewProductUrl

public void setViewProductUrl(URL viewProductUrl)

getId

public String getId()

setId

public void setId(String id)

getStatus

public SubscriptionAdjustment.SubscriptionAdjustmentStatus getStatus()

setStatus

public void setStatus(SubscriptionAdjustment.SubscriptionAdjustmentStatus status)

getSubscriptionAdjustmentsPath

public static String getSubscriptionAdjustmentsPath(String subscriptionId)