Package com.braintreegateway

Class SubscriptionGateway

java.lang.Object

com.braintreegateway.SubscriptionGateway

public class SubscriptionGateway
extends Object

Provides methods to interact with Subscriptions. Including create, find, update, cancel, etc. This class does not need to be instantiated directly. Instead, use BraintreeGateway.subscription() to get an instance of this class:

 BraintreeGateway gateway = new BraintreeGateway(...);
 gateway.subscription().create(...)
 

For more detailed information on Subscriptions, see https://developer.paypal.com/braintree/docs/reference/response/subscription/java

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	configuration
private Http	http

Constructor Summary

Constructors

Constructor	Description
SubscriptionGateway(Http http, Configuration configuration)

Method Summary

Modifier and Type	Method	Description
Result<Subscription>	cancel(String id)	Cancels the Subscription with the given id.
Result<Subscription>	create(SubscriptionRequest request)	Creates a Subscription.
Result<Subscription>	delete(String customerId, String id)
(package private) List<Subscription>	fetchSubscriptions(SubscriptionSearchRequest search, List<String> ids)
Subscription	find(String id)	Finds a Subscription by id.
private Result<Transaction>	retryCharge(SubscriptionTransactionRequest txnRequest)
Result<Transaction>	retryCharge(String subscriptionId)
Result<Transaction>	retryCharge(String subscriptionId, Boolean submitForSettlement)
Result<Transaction>	retryCharge(String subscriptionId, BigDecimal amount)
Result<Transaction>	retryCharge(String subscriptionId, BigDecimal amount, Boolean submitForSettlement)
ResourceCollection<Subscription>	search(SubscriptionSearchRequest searchRequest)	Search for a Subscription.
Result<Subscription>	update(String id, SubscriptionRequest request)	Updates a Subscription.

Methods inherited from class java.lang.Object

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

Field Detail

http

private Http http

configuration

private Configuration configuration

Constructor Detail

SubscriptionGateway

public SubscriptionGateway(Http http,
                           Configuration configuration)

Method Detail

cancel

public Result<Subscription> cancel(String id)

Cancels the Subscription with the given id.

Parameters:

id - of the Subscription to cancel.

Returns:

a Result.

create

public Result<Subscription> create(SubscriptionRequest request)

Creates a Subscription.

Parameters:

request - the request.

Returns:

a Result.

delete

public Result<Subscription> delete(String customerId,
                                   String id)

find

public Subscription find(String id)

Finds a Subscription by id.

Parameters:

id - the id of the Subscription.

Returns:

the Subscription or raises a NotFoundException.

update

public Result<Subscription> update(String id,
                                   SubscriptionRequest request)

Updates a Subscription.

Parameters:

id - the id of the Subscription.

request - the request.

Returns:

a Result.

search

public ResourceCollection<Subscription> search(SubscriptionSearchRequest searchRequest)

Search for a Subscription.

Parameters:

searchRequest - the SubscriptionSearchRequest.

Returns:

a Result.

fetchSubscriptions

List<Subscription> fetchSubscriptions(SubscriptionSearchRequest search,
                                      List<String> ids)

retryCharge

private Result<Transaction> retryCharge(SubscriptionTransactionRequest txnRequest)

retryCharge

public Result<Transaction> retryCharge(String subscriptionId)

retryCharge

public Result<Transaction> retryCharge(String subscriptionId,
                                       BigDecimal amount)

retryCharge

public Result<Transaction> retryCharge(String subscriptionId,
                                       Boolean submitForSettlement)

retryCharge

public Result<Transaction> retryCharge(String subscriptionId,
                                       BigDecimal amount,
                                       Boolean submitForSettlement)