public class SubscriptionGateway extends Object
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 http://www.braintreepaymentsolutions.com/gateway/subscription-api| Modifier and Type | Field and Description |
|---|---|
private Configuration |
configuration |
private Http |
http |
| Constructor and Description |
|---|
SubscriptionGateway(Http http,
Configuration configuration) |
| Modifier and Type | Method and 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. |
Result<Transaction> |
retryCharge(String subscriptionId) |
Result<Transaction> |
retryCharge(String subscriptionId,
BigDecimal amount) |
private Result<Transaction> |
retryCharge(SubscriptionTransactionRequest txnRequest) |
ResourceCollection<Subscription> |
search(SubscriptionSearchRequest searchRequest)
Search for a
Subscription. |
Result<Subscription> |
update(String id,
SubscriptionRequest request)
Updates a
Subscription. |
private Http http
private Configuration configuration
public SubscriptionGateway(Http http, Configuration configuration)
public Result<Subscription> cancel(String id)
Subscription with the given id.id - of the Subscription to cancel.Result.public Result<Subscription> create(SubscriptionRequest request)
Subscription.request - the request.Result.public Result<Subscription> delete(String customerId, String id)
public Subscription find(String id)
Subscription by id.id - the id of the Subscription.Subscription or raises a NotFoundException.public Result<Subscription> update(String id, SubscriptionRequest request)
Subscription.id - the id of the Subscription.request - the request.Result.public ResourceCollection<Subscription> search(SubscriptionSearchRequest searchRequest)
Subscription.searchRequest - the SubscriptionSearchRequest.Result.List<Subscription> fetchSubscriptions(SubscriptionSearchRequest search, List<String> ids)
private Result<Transaction> retryCharge(SubscriptionTransactionRequest txnRequest)
public Result<Transaction> retryCharge(String subscriptionId)
public Result<Transaction> retryCharge(String subscriptionId, BigDecimal amount)
Copyright © 2013-2017. All Rights Reserved.