com.braintreegateway

Class SubscriptionRequest

java.lang.Object

com.braintreegateway.Request

com.braintreegateway.SubscriptionRequest

public class SubscriptionRequest
extends Request

Provides a fluent interface to build up requests around Subscriptions.

Field Summary

Fields

Modifier and Type	Field and Description
private ModificationsRequest	addOnsRequest
private Integer	billingDayOfMonth
private SubscriptionDescriptorRequest	descriptorRequest
private ModificationsRequest	discountsRequest
private Calendar	firstBillingDate
private Boolean	hasTrialPeriod
private String	id
private String	merchantAccountId
private Boolean	neverExpires
private Integer	numberOfBillingCycles
private SubscriptionOptionsRequest	options
private String	paymentMethodNonce
private String	paymentMethodToken
private String	planId
private BigDecimal	price
private Integer	trialDuration
private Subscription.DurationUnit	trialDurationUnit

Constructor Summary

Constructors

Constructor and Description
SubscriptionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
ModificationsRequest	addOns()
SubscriptionRequest	billingDayOfMonth(Integer billingDayOfMonth)
protected RequestBuilder	buildRequest(String root)
SubscriptionDescriptorRequest	descriptor()
ModificationsRequest	discounts()
SubscriptionRequest	firstBillingDate(Calendar firstBillingDate)
SubscriptionRequest	id(String id)
SubscriptionRequest	merchantAccountId(String merchantAccountId)
SubscriptionRequest	neverExpires(Boolean neverExpires)
SubscriptionRequest	numberOfBillingCycles(Integer numberOfBillingCycles)
SubscriptionOptionsRequest	options()
SubscriptionRequest	paymentMethodNonce(String nonce)
SubscriptionRequest	paymentMethodToken(String token)
SubscriptionRequest	planId(String id)
SubscriptionRequest	price(BigDecimal price)
String	toXML()
SubscriptionRequest	trialDuration(Integer trialDuration)
SubscriptionRequest	trialDurationUnit(Subscription.DurationUnit trialDurationUnit)
SubscriptionRequest	trialPeriod(Boolean hasTrialPeriod)

Methods inherited from class com.braintreegateway.Request

buildXMLElement, buildXMLElement, getKind, toQueryString, toQueryString

Methods inherited from class java.lang.Object

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

Field Detail

addOnsRequest

private ModificationsRequest addOnsRequest

billingDayOfMonth

private Integer billingDayOfMonth

descriptorRequest

private SubscriptionDescriptorRequest descriptorRequest

discountsRequest

private ModificationsRequest discountsRequest

firstBillingDate

private Calendar firstBillingDate

hasTrialPeriod

private Boolean hasTrialPeriod

id

private String id

merchantAccountId

private String merchantAccountId

neverExpires

private Boolean neverExpires

numberOfBillingCycles

private Integer numberOfBillingCycles

options

private SubscriptionOptionsRequest options

paymentMethodToken

private String paymentMethodToken

paymentMethodNonce

private String paymentMethodNonce

planId

private String planId

price

private BigDecimal price

trialDuration

private Integer trialDuration

trialDurationUnit

private Subscription.DurationUnit trialDurationUnit

Constructor Detail

SubscriptionRequest

public SubscriptionRequest()

Method Detail

addOns

public ModificationsRequest addOns()

billingDayOfMonth

public SubscriptionRequest billingDayOfMonth(Integer billingDayOfMonth)

descriptor

public SubscriptionDescriptorRequest descriptor()

discounts

public ModificationsRequest discounts()

firstBillingDate

public SubscriptionRequest firstBillingDate(Calendar firstBillingDate)

id

public SubscriptionRequest id(String id)

merchantAccountId

public SubscriptionRequest merchantAccountId(String merchantAccountId)

neverExpires

public SubscriptionRequest neverExpires(Boolean neverExpires)

numberOfBillingCycles

public SubscriptionRequest numberOfBillingCycles(Integer numberOfBillingCycles)

options

public SubscriptionOptionsRequest options()

paymentMethodToken

public SubscriptionRequest paymentMethodToken(String token)

paymentMethodNonce

public SubscriptionRequest paymentMethodNonce(String nonce)

planId

public SubscriptionRequest planId(String id)

price

public SubscriptionRequest price(BigDecimal price)

toXML

public String toXML()

Overrides:

toXML in class Request

trialDuration

public SubscriptionRequest trialDuration(Integer trialDuration)

trialDurationUnit

public SubscriptionRequest trialDurationUnit(Subscription.DurationUnit trialDurationUnit)

trialPeriod

public SubscriptionRequest trialPeriod(Boolean hasTrialPeriod)

buildRequest

protected RequestBuilder buildRequest(String root)