RecurlyClient (Recurly Java library 0.34.0 API)

java.lang.Object
- com.ning.billing.recurly.RecurlyClient

public class RecurlyClient
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static String FETCH_RESOURCE

static String RECURLY_API_VERSION

static String RECURLY_DEBUG_KEY

Fields
Modifier and Type	Field and Description
`static String`	`FETCH_RESOURCE`
`static String`	`RECURLY_API_VERSION`
`static String`	`RECURLY_DEBUG_KEY`

Constructor Summary

Constructors
Constructor and Description
`RecurlyClient(String apiKey)`
`RecurlyClient(String apiKey, String subDomain)`
`RecurlyClient(String apiKey, String host, int port, String version)`
`RecurlyClient(String apiKey, String scheme, String host, int port, String version)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`InvoiceCollection`	`authorizePurchase(Purchase purchase)` Purchases authorize endpoint.
`Subscription`	`cancelSubscription(String subscriptionUuid, SubscriptionUpdate.Timeframe timeframe)` Cancel a subscription
`Subscription`	`cancelSubscription(Subscription subscription)` Cancel a subscription
`void`	`clearBillingInfo(String accountCode)` Clear an account's billing info
`void`	`close()` Close the underlying http client
`void`	`closeAccount(String accountCode)` Close Account
`Subscription`	`convertTrial(String subscriptionUuid)` Convert trial to paid subscription without 3DS token
`Subscription`	`convertTrial(String subscriptionUuid, String ThreeDSecureActionResultTokenId)` Convert trial to paid subscription with 3DS token
`Subscription`	`convertTrialMoto(String subscriptionUuid)` Convert trial to paid subscription when TransactionType = "moto".
`Account`	`createAccount(Account account)` Create Account
`AccountAcquisition`	`createAccountAcquisition(String accountCode, AccountAcquisition acquisition)` Sets the acquisition details for an account
`Adjustment`	`createAccountAdjustment(String accountCode, Adjustment adjustment)`
`Coupon`	`createCoupon(Coupon coupon)` Create a `Coupon`
`Item`	`createItem(Item item)` Create an Item's info
`MeasuredUnit`	`createMeasuredUnit(MeasuredUnit measuredUnit)` Create a MeasuredUnit's info
`BillingInfo`	`createOrUpdateBillingInfo(BillingInfo billingInfo)` Deprecated. Replaced by `createOrUpdateBillingInfo(String, BillingInfo)` Please pass in the account code rather than setting the account on the BillingInfo object
`BillingInfo`	`createOrUpdateBillingInfo(String accountCode, BillingInfo billingInfo)` Update an account's billing info
`Plan`	`createPlan(Plan plan)` Create a Plan's info
`AddOn`	`createPlanAddOn(String planCode, AddOn addOn)` Create an AddOn to a Plan
`ShippingAddress`	`createShippingAddress(String accountCode, ShippingAddress shippingAddress)` Create a shipping address on an existing account
`Subscription`	`createSubscription(Subscription subscription)` Create a subscription
`Transaction`	`createTransaction(Transaction trans)` Creates a `Transaction` through the Recurly API.
`void`	`deleteAccountAcquisition(String accountCode)` Clear the acquisition details for an account
`void`	`deleteAccountAdjustment(String accountCode)`
`void`	`deleteAddOn(String planCode, String addOnCode)` Deletes an `AddOn` for a Plan
`void`	`deleteAdjustment(String adjustmentUuid)`
`void`	`deleteCoupon(String couponCode)` Delete a `Coupon`
`void`	`deleteCouponRedemption(String accountCode)` Deletes a coupon redemption from an account.
`void`	`deleteCouponRedemption(String accountCode, String redemptionUuid)` Deletes a specific redemption.
`void`	`deleteItem(String itemCode)` Deletes a `Item`
`void`	`deletePlan(String planCode)` Deletes a `Plan`
`void`	`deleteShippingAddress(String accountCode, long shippingAddressId)` Delete an existing shipping address
`<T> T`	`doGETWithFullURL(Class<T> clazz, String url)`
`Transaction`	`enterOfflinePayment(Integer invoiceId, Transaction payment)` Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
`Transaction`	`enterOfflinePayment(String invoiceId, Transaction payment)` Enter an offline payment for a manual invoice (beta) - Recurly Enterprise Feature
`BillingInfo`	`fetchBillingInfo(String recurlyToken)` Fetch BillingInfo
`Invoice`	`fetchInvoice(String recurlyToken)` Fetch Invoice
`Subscription`	`fetchSubscription(String recurlyToken)` Fetch Subscription
`Invoice`	`forceCollectInvoice(String invoiceId)` Force collect an invoice
`Invoice`	`forceCollectInvoice(String invoiceId, String transactionType)` Force collect an invoice
`Coupons`	`generateUniqueCodes(String couponCode, Coupon coupon)` Generates unique codes for a bulk coupon.
`Account`	`getAccount(String accountCode)` Get Account
`AccountAcquisition`	`getAccountAcquisition(String accountCode)` Gets the acquisition details for an account
`Adjustments`	`getAccountAdjustments(String accountCode)` Get Account Adjustments
`Adjustments`	`getAccountAdjustments(String accountCode, Adjustments.AdjustmentType type)` Get Account Adjustments
`Adjustments`	`getAccountAdjustments(String accountCode, Adjustments.AdjustmentType type, Adjustments.AdjustmentState state)` Get Account Adjustments
`Adjustments`	`getAccountAdjustments(String accountCode, Adjustments.AdjustmentType type, Adjustments.AdjustmentState state, QueryParams params)` Get Account Adjustments
`AccountBalance`	`getAccountBalance(String accountCode)` Get Account Balance
`Invoices`	`getAccountInvoices(String accountCode)` Lookup an account's invoices
`Invoices`	`getAccountInvoices(String accountCode, InvoiceState state, QueryParams params)` Lookup an account's invoices given query params
`AccountNotes`	`getAccountNotes(String accountCode)` List an account's notes
`Accounts`	`getAccounts()` Get Accounts
`Accounts`	`getAccounts(QueryParams params)` Get Accounts given query params
`Integer`	`getAccountsCount(QueryParams params)` Get number of Accounts matching the query params
`ShippingAddresses`	`getAccountShippingAddresses(String accountCode)` Lookup an account's shipping addresses
`Subscriptions`	`getAccountSubscriptions(String accountCode)` Get the subscriptions for an `Account`.
`Subscriptions`	`getAccountSubscriptions(String accountCode, String status)` Deprecated.
`Subscriptions`	`getAccountSubscriptions(String accountCode, SubscriptionState state, QueryParams params)` Get the subscriptions for an `Account` given query params
`Transactions`	`getAccountTransactions(String accountCode)` Lookup an account's transactions history
`Transactions`	`getAccountTransactions(String accountCode, TransactionState state, TransactionType type, QueryParams params)` Lookup an account's transactions history given query params
`AddOn`	`getAddOn(String planCode, String addOnCode)` Get an AddOn's details
`AddOns`	`getAddOns(String planCode)` Return all the `AddOn` for a `Plan`
`AddOns`	`getAddOns(String planCode, QueryParams params)` Return all the `AddOn` for a `Plan`
`Adjustment`	`getAdjustment(String adjustmentUuid)`
`BillingInfo`	`getBillingInfo(String accountCode)` Lookup an account's billing info
`Accounts`	`getChildAccounts(String accountCode)` Get Child Accounts
`Coupon`	`getCoupon(String couponCode)` Get a Coupon
`Redemption`	`getCouponRedemptionByAccount(String accountCode)` Lookup the first coupon redemption on an account.
`Redemption`	`getCouponRedemptionByInvoice(Integer invoiceNumber)` Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
`Redemption`	`getCouponRedemptionByInvoice(String invoiceId)` Lookup the first coupon redemption on an invoice.
`Redemptions`	`getCouponRedemptionsByAccount(String accountCode)` Lookup all coupon redemptions on an account.
`Redemptions`	`getCouponRedemptionsByAccount(String accountCode, QueryParams params)` Lookup all coupon redemptions on an account given query params.
`Redemptions`	`getCouponRedemptionsByInvoice(Integer invoiceNumber)` Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
`Redemptions`	`getCouponRedemptionsByInvoice(Integer invoiceNumber, QueryParams params)` Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
`Redemptions`	`getCouponRedemptionsByInvoice(String invoiceId)` Lookup all coupon redemptions on an invoice.
`Redemptions`	`getCouponRedemptionsByInvoice(String invoiceId, QueryParams params)` Lookup all coupon redemptions on an invoice given query params.
`Redemptions`	`getCouponRedemptionsBySubscription(String subscriptionUuid, QueryParams params)` Lookup all coupon redemptions on a subscription given query params.
`Coupons`	`getCoupons()` Get Coupons
`Coupons`	`getCoupons(QueryParams params)` Get Coupons given query params
`Integer`	`getCouponsCount(QueryParams params)` Get number of Coupons matching the query params
`CreditPayments`	`getCreditPayments()` Get Credit Payments
`CreditPayments`	`getCreditPayments(QueryParams params)` Get Credit Payments
`CreditPayments`	`getCreditPayments(String accountCode, QueryParams params)` Get Credit Payments for a given account
`GiftCard`	`getGiftCard(Long giftCardId)` Get a Gift Card
`GiftCards`	`getGiftCards()` Get Gift Cards
`GiftCards`	`getGiftCards(QueryParams params)` Get Gift Cards given query params
`Integer`	`getGiftCardsCount(QueryParams params)` Get number of GiftCards matching the query params
`Invoice`	`getInvoice(Integer invoiceId)` Deprecated. Please switch to using a string for invoice ids
`Invoice`	`getInvoice(String invoiceId)` Lookup an invoice given an invoice id
`InputStream`	`getInvoicePdf(Integer invoiceId)` Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
`InputStream`	`getInvoicePdf(String invoiceId)` Fetch invoice pdf
`Invoices`	`getInvoices()` Lookup all invoices
`Invoices`	`getInvoices(QueryParams params)` Return all the invoices given query params
`int`	`getInvoicesCount(QueryParams params)` Return all the invoices given query params
`Subscriptions`	`getInvoiceSubscriptions(String invoiceId)` Return all the subscriptions on an invoice.
`Subscriptions`	`getInvoiceSubscriptions(String invoiceId, QueryParams params)` Return all the subscriptions on an invoice given query params.
`Transactions`	`getInvoiceTransactions(String invoiceId)` Return all the transactions on an invoice.
`Item`	`getItem(String itemCode)` Get a Item's details
`Items`	`getItems()` Return all the items
`MeasuredUnits`	`getMeasuredUnits()` Return all the MeasuredUnits
`Invoices`	`getOriginalInvoices(String invoiceId)` Lookup an invoice's original invoices (e.g.
`Plan`	`getPlan(String planCode)` Get a Plan's details
`Plans`	`getPlans()` Return all the plans
`Plans`	`getPlans(QueryParams params)` Return all the plans given query params
`Integer`	`getPlansCount(QueryParams params)` Get number of Plans matching the query params
`int`	`getRateLimitRemaining()` Returns the number of requests remaining until requests will be denied by rate limiting.
`ShippingAddress`	`getShippingAddress(String accountCode, long shippingAddressId)` Get an existing shipping address
`ShippingMethod`	`getShippingMethod(String shippingMethodCode)` Look up a shipping method
`ShippingMethods`	`getShippingMethods()` Get Shipping Methods for the site
`ShippingMethods`	`getShippingMethods(QueryParams params)` Get Shipping Methods for the site
`Subscription`	`getSubscription(String uuid)` Get a particular `Subscription` by it's UUID
`Subscriptions`	`getSubscriptions()` Get all the subscriptions on the site
`Subscriptions`	`getSubscriptions(SubscriptionState state, QueryParams params)` Get all the subscriptions on the site given some sort and filter params.
`Integer`	`getSubscriptionsCount(QueryParams params)` Get number of Subscriptions matching the query params
`Usages`	`getSubscriptionUsages(String subscriptionCode, String addOnCode, QueryParams params)` Get Subscription Addon Usages
`Transaction`	`getTransaction(String transactionId)` Lookup a transaction
`Transactions`	`getTransactions()` Get site's transaction history
`Transactions`	`getTransactions(TransactionState state, TransactionType type, QueryParams params)` Get site's transaction history
`Integer`	`getTransactionsCount(QueryParams params)` Get number of Transactions matching the query params
`Subscriptions`	`getTransactionSubscriptions(String transactionId)` Get the subscriptions for a `Transaction`.
`Coupons`	`getUniqueCouponCodes(String couponCode, QueryParams params)` Lookup all unique codes for a bulk coupon given query params.
`InvoiceCollection`	`markInvoiceFailed(Integer invoiceId)` Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
`InvoiceCollection`	`markInvoiceFailed(String invoiceId)` Mark an invoice as failed collection
`Invoice`	`markInvoiceSuccessful(Integer invoiceId)` Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
`Invoice`	`markInvoiceSuccessful(String invoiceId)` Mark an invoice as paid successfully - Recurly Enterprise Feature
`void`	`open()` Open the underlying http client
`Subscription`	`pauseSubscription(String subscriptionUuid, int remainingPauseCycles)` Pause a subscription or cancel a scheduled pause on a subscription.
`InvoiceCollection`	`pendingPurchase(Purchase purchase)` Purchases pending endpoint.
`InvoiceCollection`	`postAccountInvoice(String accountCode, Invoice invoice)` Post an invoice: invoice pending charges on an account
`Subscription`	`postponeSubscription(Subscription subscription, org.joda.time.DateTime renewaldate)` Postpone a subscription
`Usage`	`postSubscriptionUsage(String subscriptionCode, String addOnCode, Usage usage)` Post usage to subscription
`GiftCard`	`previewGiftCard(GiftCard giftCard)` Preview a GiftCard
`InvoiceCollection`	`previewPurchase(Purchase purchase)` Purchases preview endpoint
`Subscription`	`previewSubscription(Subscription subscription)` Preview a subscription
`InvoiceCollection`	`purchase(Purchase purchase)` Purchases endpoint
`GiftCard`	`purchaseGiftCard(GiftCard giftCard)` Purchase a GiftCard
`Item`	`reactivateItem(String itemCode)` Reactivating a canceled item
`Subscription`	`reactivateSubscription(Subscription subscription)` Reactivating a canceled subscription
`Redemption`	`redeemCoupon(String couponCode, Redemption redemption)` Redeem a `Coupon` on an account.
`GiftCard`	`redeemGiftCard(String redemptionCode, String accountCode)` Redeem a Gift Card
`Invoice`	`refundInvoice(String invoiceId, Integer amountInCents, RefundMethod method)` Deprecated. Please use refundInvoice(String, InvoiceRefund)
`Invoice`	`refundInvoice(String invoiceId, InvoiceRefund refundOptions)` Refund an invoice given some options Returns the refunded invoice
`Invoice`	`refundInvoice(String invoiceId, List<AdjustmentRefund> lineItems, RefundMethod method)` Deprecated. Please use refundInvoice(String, InvoiceRefund)
`void`	`refundTransaction(String transactionId, BigDecimal amount)` Refund a transaction
`Account`	`reopenAccount(String accountCode)` Reopen Account
`Subscription`	`resumeSubscription(String subscriptionUuid)` Immediately resumes a currently paused subscription.
`void`	`setAcceptLanguage(String language)` Set the Accept-Language header
`void`	`terminateSubscription(Subscription subscription, RefundOption refund)` Terminate a particular `Subscription` by it's UUID
`Account`	`updateAccount(String accountCode, Account account)` Update Account
`AccountAcquisition`	`updateAccountAcquisition(String accountCode, AccountAcquisition acquisition)` Updates the acquisition details for an account
`AddOn`	`updateAddOn(String planCode, String addOnCode, AddOn addOn)` Updates an `AddOn` for a Plan
`Invoice`	`updateInvoice(String invoiceId, Invoice invoice)` Update an invoice
`Item`	`updateItem(String itemCode, Item item)` Update an Item's info
`Plan`	`updatePlan(Plan plan)` Update a Plan's info
`ShippingAddress`	`updateShippingAddress(String accountCode, long shippingAddressId, ShippingAddress shippingAddress)` Update an existing shipping address
`Subscription`	`updateSubscription(String uuid, SubscriptionUpdate subscriptionUpdate)` Update a particular `Subscription` by it's UUID
`Subscription`	`updateSubscriptionNotes(String uuid, SubscriptionNotes subscriptionNotes)` Update to a particular `Subscription`'s notes by it's UUID
`Subscription`	`updateSubscriptionPreview(String uuid, SubscriptionUpdate subscriptionUpdate)` Preview an update to a particular `Subscription` by it's UUID
`Invoice`	`voidInvoice(String invoiceId)` Void Invoice

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - RECURLY_DEBUG_KEY
```
public static final String RECURLY_DEBUG_KEY
```
    See Also:
    
    Constant Field Values
  - RECURLY_API_VERSION
```
public static final String RECURLY_API_VERSION
```
    See Also:
    
    Constant Field Values
  - FETCH_RESOURCE
```
public static final String FETCH_RESOURCE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RecurlyClient
```
public RecurlyClient(String apiKey)
```
  - RecurlyClient
```
public RecurlyClient(String apiKey,
                     String subDomain)
```
  - RecurlyClient
```
public RecurlyClient(String apiKey,
                     String host,
                     int port,
                     String version)
```
  - RecurlyClient
```
public RecurlyClient(String apiKey,
                     String scheme,
                     String host,
                     int port,
                     String version)
```
- Method Detail
  - open
```
public void open()
          throws NoSuchAlgorithmException,
                 KeyManagementException
```
    Open the underlying http client
    
    Throws:
    
    NoSuchAlgorithmException
    
    KeyManagementException
  - close
```
public void close()
```
    Close the underlying http client
  - setAcceptLanguage
```
public void setAcceptLanguage(String language)
```
    Set the Accept-Language header
    Sets the Accept-Language header for all requests made by this client. Note: this is not thread-safe! See https://github.com/killbilling/recurly-java-library/pull/298 for more details about thread safety.
    
    Parameters:
    
    language - The language to set in the header. E.g., "en-US"
  - getRateLimitRemaining
```
public int getRateLimitRemaining()
```
    Returns the number of requests remaining until requests will be denied by rate limiting.
    
    Returns:
    
    Number of requests remaining. Value is valid (> -1) after a successful API call.
  - createAccount
```
public Account createAccount(Account account)
```
    Create Account
    Creates a new account. You may optionally include billing information.
    
    Parameters:
    
    account - account object
    
    Returns:
    
    the newly created account object on success, null otherwise
  - getAccounts
```
public Accounts getAccounts()
```
    Get Accounts
    Returns information about all accounts.
    
    Returns:
    
    Accounts on success, null otherwise
  - getAccounts
```
public Accounts getAccounts(QueryParams params)
```
    Get Accounts given query params
    Returns information about all accounts.
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    Accounts on success, null otherwise
  - getAccountsCount
```
public Integer getAccountsCount(QueryParams params)
```
    Get number of Accounts matching the query params
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    Integer on success, null otherwise
  - getCoupons
```
public Coupons getCoupons()
```
    Get Coupons
    Returns information about all accounts.
    
    Returns:
    
    Coupons on success, null otherwise
  - getCoupons
```
public Coupons getCoupons(QueryParams params)
```
    Get Coupons given query params
    Returns information about all accounts.
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    Coupons on success, null otherwise
  - getCouponsCount
```
public Integer getCouponsCount(QueryParams params)
```
    Get number of Coupons matching the query params
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    Integer on success, null otherwise
  - getAccount
```
public Account getAccount(String accountCode)
```
    Get Account
    Returns information about a single account.
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    account object on success, null otherwise
  - updateAccount
```
public Account updateAccount(String accountCode,
                             Account account)
```
    Update Account
    Updates an existing account.
    
    Parameters:
    
    accountCode - recurly account id
    
    account - account object
    
    Returns:
    
    the updated account object on success, null otherwise
  - getAccountBalance
```
public AccountBalance getAccountBalance(String accountCode)
```
    Get Account Balance
    Retrieves the remaining balance on the account
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    the updated AccountBalance if success, null otherwise
  - closeAccount
```
public void closeAccount(String accountCode)
```
    Close Account
    Marks an account as closed and cancels any active subscriptions. Any saved billing information will also be permanently removed from the account.
    
    Parameters:
    
    accountCode - recurly account id
  - reopenAccount
```
public Account reopenAccount(String accountCode)
```
    Reopen Account
    Transitions a closed account back to active.
    
    Parameters:
    
    accountCode - recurly account id
  - getChildAccounts
```
public Accounts getChildAccounts(String accountCode)
```
    Get Child Accounts
    Returns information about a the child accounts of an account.
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    Accounts on success, null otherwise
  - getAccountAdjustments
```
public Adjustments getAccountAdjustments(String accountCode)
```
    Get Account Adjustments
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    the adjustments on the account
  - getAccountAdjustments
```
public Adjustments getAccountAdjustments(String accountCode,
                                         Adjustments.AdjustmentType type)
```
    Get Account Adjustments
    
    Parameters:
    
    accountCode - recurly account id
    
    type - Adjustments.AdjustmentType
    
    Returns:
    
    the adjustments on the account
  - getAccountAdjustments
```
public Adjustments getAccountAdjustments(String accountCode,
                                         Adjustments.AdjustmentType type,
                                         Adjustments.AdjustmentState state)
```
    Get Account Adjustments
    
    Parameters:
    
    accountCode - recurly account id
    
    type - Adjustments.AdjustmentType
    
    state - Adjustments.AdjustmentState
    
    Returns:
    
    the adjustments on the account
  - getAccountAdjustments
```
public Adjustments getAccountAdjustments(String accountCode,
                                         Adjustments.AdjustmentType type,
                                         Adjustments.AdjustmentState state,
                                         QueryParams params)
```
    Get Account Adjustments
    
    Parameters:
    
    accountCode - recurly account id
    
    type - Adjustments.AdjustmentType
    
    state - Adjustments.AdjustmentState
    
    params - QueryParams
    
    Returns:
    
    the adjustments on the account
  - getAdjustment
```
public Adjustment getAdjustment(String adjustmentUuid)
```
  - createAccountAdjustment
```
public Adjustment createAccountAdjustment(String accountCode,
                                          Adjustment adjustment)
```
  - deleteAccountAdjustment
```
public void deleteAccountAdjustment(String accountCode)
```
  - deleteAdjustment
```
public void deleteAdjustment(String adjustmentUuid)
```
  - createSubscription
```
public Subscription createSubscription(Subscription subscription)
```
    Create a subscription
    Creates a subscription for an account.
    
    Parameters:
    
    subscription - Subscription object
    
    Returns:
    
    the newly created Subscription object on success, null otherwise
  - previewSubscription
```
public Subscription previewSubscription(Subscription subscription)
```
    Preview a subscription
    Previews a subscription for an account.
    
    Parameters:
    
    subscription - Subscription object
    
    Returns:
    
    the newly created Subscription object on success, null otherwise
  - getSubscription
```
public Subscription getSubscription(String uuid)
```
    Get a particular Subscription by it's UUID
    Returns information about a single subscription.
    
    Parameters:
    
    uuid - UUID of the subscription to lookup
    
    Returns:
    
    Subscription
  - cancelSubscription
```
public Subscription cancelSubscription(Subscription subscription)
```
    Cancel a subscription
    Cancel a subscription so it remains active and then expires at the end of the current bill cycle.
    
    Parameters:
    
    subscription - Subscription object
    
    Returns:
    
    Subscription
  - cancelSubscription
```
public Subscription cancelSubscription(String subscriptionUuid,
                                       SubscriptionUpdate.Timeframe timeframe)
```
    Cancel a subscription
    Cancel a subscription so it remains active and then expires at the end of the current bill cycle.
    
    Parameters:
    
    subscriptionUuid - String uuid of the subscription to cancel
    
    timeframe - SubscriptionUpdate.TimeFrame the timeframe in which to cancel. Only accepts bill_date or term_end
    
    Returns:
    
    Subscription
  - pauseSubscription
```
public Subscription pauseSubscription(String subscriptionUuid,
                                      int remainingPauseCycles)
```
    Pause a subscription or cancel a scheduled pause on a subscription.
    * For an active subscription without a pause scheduled already, this will schedule a pause period to begin at the next renewal date for the specified number of billing cycles (remaining_pause_cycles). * When a scheduled pause already exists, this will update the remaining pause cycles with the new value sent. When zero (0) remaining_pause_cycles is sent for a subscription with a scheduled pause, the pause will be canceled. * For a paused subscription, the remaining_pause_cycles will adjust the length of the current pause period. Sending zero (0) in the remaining_pause_cycles field will cause the subscription to be resumed at the next renewal date.
    
    Parameters:
    
    subscriptionUuid - The uuid for the subscription you wish to pause.
    
    remainingPauseCycles - The number of billing cycles that the subscription will be paused.
    
    Returns:
    
    Subscription
  - convertTrialMoto
```
public Subscription convertTrialMoto(String subscriptionUuid)
```
    Convert trial to paid subscription when TransactionType = "moto".
    
    Parameters:
    
    subscriptionUuid - The uuid for the subscription you want to convert from trial to paid.
    
    Returns:
    
    Subscription
  - convertTrial
```
public Subscription convertTrial(String subscriptionUuid)
```
    Convert trial to paid subscription without 3DS token
    
    Parameters:
    
    subscriptionUuid - The uuid for the subscription you want to convert from trial to paid.
    
    Returns:
    
    Subscription
  - convertTrial
```
public Subscription convertTrial(String subscriptionUuid,
                                 String ThreeDSecureActionResultTokenId)
```
    Convert trial to paid subscription with 3DS token
    
    Parameters:
    
    subscriptionUuid - The uuid for the subscription you want to convert from trial to paid.
    
    ThreeDSecureActionResultTokenId - 3DS secure action result token id in billing info.
    
    Returns:
    
    Subscription
  - resumeSubscription
```
public Subscription resumeSubscription(String subscriptionUuid)
```
    Immediately resumes a currently paused subscription.
    For a paused subscription, this will immediately resume the subscription from the pause, produce an invoice, and return the newly resumed subscription. Any at-renewal subscription changes will be immediately applied when the subscription resumes.
    
    Parameters:
    
    subscriptionUuid - The uuid for the subscription you wish to pause.
    
    Returns:
    
    Subscription
  - postponeSubscription
```
public Subscription postponeSubscription(Subscription subscription,
                                         org.joda.time.DateTime renewaldate)
```
    Postpone a subscription
    postpone a subscription, setting a new renewal date.
    
    Parameters:
    
    subscription - Subscription object
    
    Returns:
    
    Subscription
  - terminateSubscription
```
public void terminateSubscription(Subscription subscription,
                                  RefundOption refund)
```
    Terminate a particular Subscription by it's UUID
    
    Parameters:
    
    subscription - Subscription to terminate
  - reactivateSubscription
```
public Subscription reactivateSubscription(Subscription subscription)
```
    Reactivating a canceled subscription
    Reactivate a canceled subscription so it renews at the end of the current bill cycle.
    
    Parameters:
    
    subscription - Subscription object
    
    Returns:
    
    Subscription
  - updateSubscription
```
public Subscription updateSubscription(String uuid,
                                       SubscriptionUpdate subscriptionUpdate)
```
    Update a particular Subscription by it's UUID
    Returns information about a single subscription.
    
    Parameters:
    
    uuid - UUID of the subscription to update
    
    subscriptionUpdate - subscriptionUpdate object
    
    Returns:
    
    Subscription the updated subscription
  - updateSubscriptionPreview
```
public Subscription updateSubscriptionPreview(String uuid,
                                              SubscriptionUpdate subscriptionUpdate)
```
    Preview an update to a particular Subscription by it's UUID
    Returns information about a single subscription.
    
    Parameters:
    
    uuid - UUID of the subscription to preview an update for
    
    Returns:
    
    Subscription the updated subscription preview
  - updateSubscriptionNotes
```
public Subscription updateSubscriptionNotes(String uuid,
                                            SubscriptionNotes subscriptionNotes)
```
    Update to a particular Subscription's notes by it's UUID
    Returns information about a single subscription.
    
    Parameters:
    
    uuid - UUID of the subscription to preview an update for
    
    subscriptionNotes - SubscriptionNotes object
    
    Returns:
    
    Subscription the updated subscription
  - getAccountSubscriptions
```
public Subscriptions getAccountSubscriptions(String accountCode)
```
    Get the subscriptions for an Account.
    Returns subscriptions associated with an account
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    Subscriptions on the account
  - getSubscriptions
```
public Subscriptions getSubscriptions()
```
    Get all the subscriptions on the site
    Returns all the subscriptions on the site
    
    Returns:
    
    Subscriptions on the site
  - getSubscriptions
```
public Subscriptions getSubscriptions(SubscriptionState state,
                                      QueryParams params)
```
    Get all the subscriptions on the site given some sort and filter params.
    Returns all the subscriptions on the site
    
    Parameters:
    
    state - SubscriptionState
    
    params - QueryParams
    
    Returns:
    
    Subscriptions on the site
  - getSubscriptionsCount
```
public Integer getSubscriptionsCount(QueryParams params)
```
    Get number of Subscriptions matching the query params
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    Integer on success, null otherwise
  - getAccountSubscriptions
```
public Subscriptions getAccountSubscriptions(String accountCode,
                                             SubscriptionState state,
                                             QueryParams params)
```
    Get the subscriptions for an Account given query params
    Returns subscriptions associated with an account
    
    Parameters:
    
    accountCode - recurly account id
    
    state - SubscriptionState
    
    params - QueryParams
    
    Returns:
    
    Subscriptions on the account
  - getInvoiceSubscriptions
```
public Subscriptions getInvoiceSubscriptions(String invoiceId)
```
    Return all the subscriptions on an invoice.
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
    
    Returns:
    
    all the subscriptions on the invoice
  - getInvoiceSubscriptions
```
public Subscriptions getInvoiceSubscriptions(String invoiceId,
                                             QueryParams params)
```
    Return all the subscriptions on an invoice given query params.
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
    
    params - QueryParams
    
    Returns:
    
    all the subscriptions on the invoice
  - postSubscriptionUsage
```
public Usage postSubscriptionUsage(String subscriptionCode,
                                   String addOnCode,
                                   Usage usage)
```
    Post usage to subscription
    
    Parameters:
    
    subscriptionCode - The recurly id of the Subscription
    
    addOnCode - recurly id of AddOn
    
    usage - the usage to post on recurly
    
    Returns:
    
    the Usage object as identified by the passed in object
  - getSubscriptionUsages
```
public Usages getSubscriptionUsages(String subscriptionCode,
                                    String addOnCode,
                                    QueryParams params)
```
    Get Subscription Addon Usages
    
    Parameters:
    
    subscriptionCode - The recurly id of the Subscription
    
    addOnCode - recurly id of AddOn
    
    Returns:
    
    Usages for the specified subscription and addOn
  - getAccountSubscriptions
```
@Deprecated
public Subscriptions getAccountSubscriptions(String accountCode,
                                                         String status)
```
    Deprecated.
    
    Get the subscriptions for an account. This is deprecated. Please use getAccountSubscriptions(String, Subscriptions.State, QueryParams)
    Returns information about a single account.
    
    Parameters:
    
    accountCode - recurly account id
    
    status - Only accounts in this status will be returned
    
    Returns:
    
    Subscriptions on the account
  - createOrUpdateBillingInfo
```
public BillingInfo createOrUpdateBillingInfo(String accountCode,
                                             BillingInfo billingInfo)
```
    Update an account's billing info
    When new or updated credit card information is updated, the billing information is only saved if the credit card is valid. If the account has a past due invoice, the outstanding balance will be collected to validate the billing information.
    If the account does not exist before the API request, the account will be created if the billing information is valid.
    Please note: this API end-point may be used to import billing information without security codes (CVV). Recurly recommends requiring CVV from your customers when collecting new or updated billing information.
    
    Parameters:
    
    accountCode - recurly account id
    
    billingInfo - billing info object to create or update
    
    Returns:
    
    the newly created or update billing info object on success, null otherwise
  - createOrUpdateBillingInfo
```
@Deprecated
public BillingInfo createOrUpdateBillingInfo(BillingInfo billingInfo)
```
    Deprecated. Replaced by createOrUpdateBillingInfo(String, BillingInfo) Please pass in the account code rather than setting the account on the BillingInfo object
    
    Update an account's billing info
    When new or updated credit card information is updated, the billing information is only saved if the credit card is valid. If the account has a past due invoice, the outstanding balance will be collected to validate the billing information.
    If the account does not exist before the API request, the account will be created if the billing information is valid.
    Please note: this API end-point may be used to import billing information without security codes (CVV). Recurly recommends requiring CVV from your customers when collecting new or updated billing information.
    
    Parameters:
    
    billingInfo - billing info object to create or update
    
    Returns:
    
    the newly created or update billing info object on success, null otherwise
  - getBillingInfo
```
public BillingInfo getBillingInfo(String accountCode)
```
    Lookup an account's billing info
    Returns only the account's current billing information.
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    the current billing info object associated with this account on success, null otherwise
  - clearBillingInfo
```
public void clearBillingInfo(String accountCode)
```
    Clear an account's billing info
    You may remove any stored billing information for an account. If the account has a subscription, the renewal will go into past due unless you update the billing info before the renewal occurs
    
    Parameters:
    
    accountCode - recurly account id
  - getAccountNotes
```
public AccountNotes getAccountNotes(String accountCode)
```
    List an account's notes
    Returns the account's notes
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    the notes associated with this account on success, null otherwise
  - getAccountTransactions
```
public Transactions getAccountTransactions(String accountCode)
```
    Lookup an account's transactions history
    Returns the account's transaction history
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    the transaction history associated with this account on success, null otherwise
  - getAccountTransactions
```
public Transactions getAccountTransactions(String accountCode,
                                           TransactionState state,
                                           TransactionType type,
                                           QueryParams params)
```
    Lookup an account's transactions history given query params
    Returns the account's transaction history
    
    Parameters:
    
    accountCode - recurly account id
    
    state - TransactionState
    
    type - TransactionType
    
    params - QueryParams
    
    Returns:
    
    the transaction history associated with this account on success, null otherwise
  - getTransactions
```
public Transactions getTransactions()
```
    Get site's transaction history
    All transactions on the site
    
    Returns:
    
    the transaction history of the site on success, null otherwise
  - getTransactions
```
public Transactions getTransactions(TransactionState state,
                                    TransactionType type,
                                    QueryParams params)
```
    Get site's transaction history
    All transactions on the site
    
    Parameters:
    
    state - TransactionState
    
    type - TransactionType
    
    params - QueryParams
    
    Returns:
    
    the transaction history of the site on success, null otherwise
  - getTransactionsCount
```
public Integer getTransactionsCount(QueryParams params)
```
    Get number of Transactions matching the query params
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    Integer on success, null otherwise
  - getTransaction
```
public Transaction getTransaction(String transactionId)
```
    Lookup a transaction
    
    Parameters:
    
    transactionId - recurly transaction id
    
    Returns:
    
    the transaction if found, null otherwise
  - createTransaction
```
public Transaction createTransaction(Transaction trans)
```
    Creates a Transaction through the Recurly API.
    
    Parameters:
    
    trans - The Transaction to create
    
    Returns:
    
    The created Transaction object
  - refundTransaction
```
public void refundTransaction(String transactionId,
                              @Nullable
                              BigDecimal amount)
```
    Refund a transaction
    
    Parameters:
    
    transactionId - recurly transaction id
    
    amount - amount to refund, null for full refund
  - getTransactionSubscriptions
```
public Subscriptions getTransactionSubscriptions(String transactionId)
```
    Get the subscriptions for a Transaction.
    Returns subscriptions associated with a transaction
    
    Parameters:
    
    transactionId - recurly transaction id
    
    Returns:
    
    Subscriptions on the transaction
  - getInvoice
```
@Deprecated
public Invoice getInvoice(Integer invoiceId)
```
    Deprecated. Please switch to using a string for invoice ids
    
    Lookup an invoice
    Returns the invoice given an integer id
    
    Parameters:
    
    invoiceId - Recurly Invoice ID
    
    Returns:
    
    the invoice
  - getInvoice
```
public Invoice getInvoice(String invoiceId)
```
    Lookup an invoice given an invoice id
    Returns the invoice given a string id. The invoice may or may not have acountry code prefix (ex: IE1023). For more information on invoicing and prefixes, see: https://docs.recurly.com/docs/site-settings#section-invoice-prefixing
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
    
    Returns:
    
    the invoice
  - updateInvoice
```
public Invoice updateInvoice(String invoiceId,
                             Invoice invoice)
```
    Update an invoice
    Updates an existing invoice.
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
    
    Returns:
    
    the updated invoice object on success, null otherwise
  - getInvoicePdf
```
@Deprecated
public InputStream getInvoicePdf(Integer invoiceId)
```
    Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
    
    Fetch invoice pdf
    Returns the invoice pdf as an inputStream
    
    Parameters:
    
    invoiceId - Recurly Invoice ID
    
    Returns:
    
    the invoice pdf as an inputStream
  - getInvoicePdf
```
public InputStream getInvoicePdf(String invoiceId)
```
    Fetch invoice pdf
    Returns the invoice pdf as an inputStream
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
    
    Returns:
    
    the invoice pdf as an inputStream
  - getInvoices
```
public Invoices getInvoices()
```
    Lookup all invoices
    Returns all invoices on the site
    
    Returns:
    
    the invoices associated with this site on success, null otherwise
  - getInvoices
```
public Invoices getInvoices(QueryParams params)
```
    Return all the invoices given query params
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    all invoices matching the query
  - getInvoicesCount
```
public int getInvoicesCount(QueryParams params)
```
    Return all the invoices given query params
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    the count of invoices matching the query
  - getInvoiceTransactions
```
public Transactions getInvoiceTransactions(String invoiceId)
```
    Return all the transactions on an invoice. Only use this endpoint if you have more than 500 transactions on an invoice.
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
    
    Returns:
    
    all the transactions on the invoice
  - getAccountInvoices
```
public Invoices getAccountInvoices(String accountCode)
```
    Lookup an account's invoices
    Returns the account's invoices
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    the invoices associated with this account on success, null otherwise
  - getOriginalInvoices
```
public Invoices getOriginalInvoices(String invoiceId)
```
    Lookup an invoice's original invoices (e.g. a refund invoice has original_invoices)
    Returns the invoice's original invoices
    
    Parameters:
    
    invoiceId - the invoice id
    
    Returns:
    
    the original invoices associated with this invoice on success. Throws RecurlyAPIError if not found
  - refundInvoice
```
@Deprecated
public Invoice refundInvoice(String invoiceId,
                                         Integer amountInCents,
                                         RefundMethod method)
```
    Deprecated. Please use refundInvoice(String, InvoiceRefund)
    
    Refund an invoice given an open amount
    Returns the refunded invoice
    
    Parameters:
    
    invoiceId - The id of the invoice to refund
    
    amountInCents - The open amount to refund
    
    method - If credit line items exist on the invoice, this parameter specifies which refund method to use first
    
    Returns:
    
    the refunded invoice
  - refundInvoice
```
@Deprecated
public Invoice refundInvoice(String invoiceId,
                                         List<AdjustmentRefund> lineItems,
                                         RefundMethod method)
```
    Deprecated. Please use refundInvoice(String, InvoiceRefund)
    
    Refund an invoice given some line items
    Returns the refunded invoice
    
    Parameters:
    
    invoiceId - The id of the invoice to refund
    
    lineItems - The list of adjustment refund objects
    
    method - If credit line items exist on the invoice, this parameter specifies which refund method to use first
    
    Returns:
    
    the refunded invoice
  - refundInvoice
```
public Invoice refundInvoice(String invoiceId,
                             InvoiceRefund refundOptions)
```
    Refund an invoice given some options
    Returns the refunded invoice
    
    Parameters:
    
    invoiceId - The id of the invoice to refund
    
    refundOptions - The options for the refund
    
    Returns:
    
    the refunded invoice
  - getAccountShippingAddresses
```
public ShippingAddresses getAccountShippingAddresses(String accountCode)
```
    Lookup an account's shipping addresses
    Returns the account's shipping addresses
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    the shipping addresses associated with this account on success, null otherwise
  - getShippingAddress
```
public ShippingAddress getShippingAddress(String accountCode,
                                          long shippingAddressId)
```
    Get an existing shipping address
    
    Parameters:
    
    accountCode - recurly account id
    
    shippingAddressId - the shipping address id to fetch
    
    Returns:
    
    the newly created shipping address on success
  - createShippingAddress
```
public ShippingAddress createShippingAddress(String accountCode,
                                             ShippingAddress shippingAddress)
```
    Create a shipping address on an existing account
    
    Parameters:
    
    accountCode - recurly account id
    
    shippingAddress - the shipping address request data
    
    Returns:
    
    the newly created shipping address on success
  - updateShippingAddress
```
public ShippingAddress updateShippingAddress(String accountCode,
                                             long shippingAddressId,
                                             ShippingAddress shippingAddress)
```
    Update an existing shipping address
    
    Parameters:
    
    accountCode - recurly account id
    
    shippingAddressId - the shipping address id to update
    
    shippingAddress - the shipping address request data
    
    Returns:
    
    the updated shipping address on success
  - deleteShippingAddress
```
public void deleteShippingAddress(String accountCode,
                                  long shippingAddressId)
```
    Delete an existing shipping address
    
    Parameters:
    
    accountCode - recurly account id
    
    shippingAddressId - the shipping address id to delete
  - getAccountInvoices
```
public Invoices getAccountInvoices(String accountCode,
                                   InvoiceState state,
                                   QueryParams params)
```
    Lookup an account's invoices given query params
    Returns the account's invoices
    
    Parameters:
    
    accountCode - recurly account id
    
    state - InvoiceState state of the invoices
    
    params - QueryParams
    
    Returns:
    
    the invoices associated with this account on success, null otherwise
  - postAccountInvoice
```
public InvoiceCollection postAccountInvoice(String accountCode,
                                            Invoice invoice)
```
    Post an invoice: invoice pending charges on an account
    Returns an invoice collection
    
    Parameters:
    
    accountCode -
    
    Returns:
    
    the invoice collection that was generated on success, null otherwise
  - markInvoiceSuccessful
```
@Deprecated
public Invoice markInvoiceSuccessful(Integer invoiceId)
```
    Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
    
    Mark an invoice as paid successfully - Recurly Enterprise Feature
    
    Parameters:
    
    invoiceId - Recurly Invoice ID
  - markInvoiceSuccessful
```
public Invoice markInvoiceSuccessful(String invoiceId)
```
    Mark an invoice as paid successfully - Recurly Enterprise Feature
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
  - markInvoiceFailed
```
@Deprecated
public InvoiceCollection markInvoiceFailed(Integer invoiceId)
```
    Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
    
    Mark an invoice as failed collection
    
    Parameters:
    
    invoiceId - Recurly Invoice ID
  - markInvoiceFailed
```
public InvoiceCollection markInvoiceFailed(String invoiceId)
```
    Mark an invoice as failed collection
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
  - forceCollectInvoice
```
public Invoice forceCollectInvoice(String invoiceId)
```
    Force collect an invoice
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
  - forceCollectInvoice
```
public Invoice forceCollectInvoice(String invoiceId,
                                   String transactionType)
```
    Force collect an invoice
    
    Parameters:
    
    transactionType - String The gateway transaction type. Currency accepts value "moto".
    
    invoiceId - String Recurly Invoice ID
  - voidInvoice
```
public Invoice voidInvoice(String invoiceId)
```
    Void Invoice
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
  - enterOfflinePayment
```
@Deprecated
public Transaction enterOfflinePayment(Integer invoiceId,
                                                   Transaction payment)
```
    Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
    
    Enter an offline payment for a manual invoice (beta) - Recurly Enterprise Feature
    
    Parameters:
    
    invoiceId - Recurly Invoice ID
    
    payment - The external payment
  - enterOfflinePayment
```
public Transaction enterOfflinePayment(String invoiceId,
                                       Transaction payment)
```
    Enter an offline payment for a manual invoice (beta) - Recurly Enterprise Feature
    
    Parameters:
    
    invoiceId - String Recurly Invoice ID
    
    payment - The external payment
  - createItem
```
public Item createItem(Item item)
```
    Create an Item's info
    
    Parameters:
    
    item - The item to create on recurly
    
    Returns:
    
    the item object as identified by the passed in ID
  - updateItem
```
public Item updateItem(String itemCode,
                       Item item)
```
    Update an Item's info
    
    Parameters:
    
    item - The Item to update on recurly
    
    Returns:
    
    the updated item object
  - getItem
```
public Item getItem(String itemCode)
```
    Get a Item's details
    
    Parameters:
    
    itemCode - recurly id of item
    
    Returns:
    
    the item object as identified by the passed in ID
  - getItems
```
public Items getItems()
```
    Return all the items
    
    Returns:
    
    the item object as identified by the passed in ID
  - deleteItem
```
public void deleteItem(String itemCode)
```
    Deletes a Item
    
    Parameters:
    
    itemCode - The Item object to delete.
  - reactivateItem
```
public Item reactivateItem(String itemCode)
```
    Reactivating a canceled item
    Reactivate a canceled item.
    
    Parameters:
    
    item - Item object
    
    Returns:
    
    Item
  - createPlan
```
public Plan createPlan(Plan plan)
```
    Create a Plan's info
    
    Parameters:
    
    plan - The plan to create on recurly
    
    Returns:
    
    the plan object as identified by the passed in ID
  - updatePlan
```
public Plan updatePlan(Plan plan)
```
    Update a Plan's info
    
    Parameters:
    
    plan - The plan to update on recurly
    
    Returns:
    
    the updated plan object
  - getPlan
```
public Plan getPlan(String planCode)
```
    Get a Plan's details
    
    Parameters:
    
    planCode - recurly id of plan
    
    Returns:
    
    the plan object as identified by the passed in ID
  - getPlans
```
public Plans getPlans()
```
    Return all the plans
    
    Returns:
    
    the plan object as identified by the passed in ID
  - getPlans
```
public Plans getPlans(QueryParams params)
```
    Return all the plans given query params
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    the plan object as identified by the passed in ID
  - getPlansCount
```
public Integer getPlansCount(QueryParams params)
```
    Get number of Plans matching the query params
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    Integer on success, null otherwise
  - deletePlan
```
public void deletePlan(String planCode)
```
    Deletes a Plan
    
    Parameters:
    
    planCode - The Plan object to delete.
  - createPlanAddOn
```
public AddOn createPlanAddOn(String planCode,
                             AddOn addOn)
```
    Create an AddOn to a Plan
    
    Parameters:
    
    planCode - The planCode of the Plan to create within recurly
    
    addOn - The AddOn to create within recurly
    
    Returns:
    
    the AddOn object as identified by the passed in object
  - getAddOn
```
public AddOn getAddOn(String planCode,
                      String addOnCode)
```
    Get an AddOn's details
    
    Parameters:
    
    addOnCode - recurly id of AddOn
    
    planCode - recurly id of Plan
    
    Returns:
    
    the AddOn object as identified by the passed in plan and add-on IDs
  - getAddOns
```
public AddOns getAddOns(String planCode)
```
    Return all the AddOn for a Plan
    
    Parameters:
    
    planCode -
    
    Returns:
    
    the AddOn objects as identified by the passed plan ID
  - getAddOns
```
public AddOns getAddOns(String planCode,
                        QueryParams params)
```
    Return all the AddOn for a Plan
    
    Parameters:
    
    planCode -
    
    params - QueryParams
    
    Returns:
    
    the AddOn objects as identified by the passed plan ID
  - deleteAddOn
```
public void deleteAddOn(String planCode,
                        String addOnCode)
```
    Deletes an AddOn for a Plan
    
    Parameters:
    
    planCode - The Plan object.
    
    addOnCode - The AddOn object to delete.
  - updateAddOn
```
public AddOn updateAddOn(String planCode,
                         String addOnCode,
                         AddOn addOn)
```
    Updates an AddOn for a Plan
    
    Parameters:
    
    planCode - The Plan object.
    
    addOnCode - The AddOn object to update.
    
    addOn - The updated AddOn data.
    
    Returns:
    
    the updated AddOn object.
  - createCoupon
```
public Coupon createCoupon(Coupon coupon)
```
    Create a Coupon
    
    Parameters:
    
    coupon - The coupon to create on recurly
    
    Returns:
    
    the Coupon object
  - getCoupon
```
public Coupon getCoupon(String couponCode)
```
    Get a Coupon
    
    Parameters:
    
    couponCode - The code for the Coupon
    
    Returns:
    
    The Coupon object as identified by the passed in code
  - deleteCoupon
```
public void deleteCoupon(String couponCode)
```
    Delete a Coupon
    
    Parameters:
    
    couponCode - The code for the Coupon
  - redeemCoupon
```
public Redemption redeemCoupon(String couponCode,
                               Redemption redemption)
```
    Redeem a Coupon on an account.
    
    Parameters:
    
    couponCode - redeemed coupon id
    
    Returns:
    
    the Coupon object
  - getCouponRedemptionByAccount
```
public Redemption getCouponRedemptionByAccount(String accountCode)
```
    Lookup the first coupon redemption on an account.
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    the coupon redemption for this account on success, null otherwise
  - getCouponRedemptionsByAccount
```
public Redemptions getCouponRedemptionsByAccount(String accountCode)
```
    Lookup all coupon redemptions on an account.
    
    Parameters:
    
    accountCode - recurly account id
    
    Returns:
    
    the coupon redemptions for this account on success, null otherwise
  - getCouponRedemptionsByAccount
```
public Redemptions getCouponRedemptionsByAccount(String accountCode,
                                                 QueryParams params)
```
    Lookup all coupon redemptions on an account given query params.
    
    Parameters:
    
    accountCode - recurly account id
    
    params - QueryParams
    
    Returns:
    
    the coupon redemptions for this account on success, null otherwise
  - getCouponRedemptionByInvoice
```
@Deprecated
public Redemption getCouponRedemptionByInvoice(Integer invoiceNumber)
```
    Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
    
    Lookup the first coupon redemption on an invoice.
    
    Parameters:
    
    invoiceNumber - invoice number
    
    Returns:
    
    the coupon redemption for this invoice on success, null otherwise
  - getCouponRedemptionByInvoice
```
public Redemption getCouponRedemptionByInvoice(String invoiceId)
```
    Lookup the first coupon redemption on an invoice.
    
    Parameters:
    
    invoiceId - String invoice id
    
    Returns:
    
    the coupon redemption for this invoice on success, null otherwise
  - getCouponRedemptionsByInvoice
```
@Deprecated
public Redemptions getCouponRedemptionsByInvoice(Integer invoiceNumber)
```
    Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
    
    Lookup all coupon redemptions on an invoice.
    
    Parameters:
    
    invoiceNumber - invoice number
    
    Returns:
    
    the coupon redemptions for this invoice on success, null otherwise
  - getCouponRedemptionsByInvoice
```
public Redemptions getCouponRedemptionsByInvoice(String invoiceId)
```
    Lookup all coupon redemptions on an invoice.
    
    Parameters:
    
    invoiceId - String invoice id
    
    Returns:
    
    the coupon redemptions for this invoice on success, null otherwise
  - getCouponRedemptionsByInvoice
```
@Deprecated
public Redemptions getCouponRedemptionsByInvoice(Integer invoiceNumber,
                                                             QueryParams params)
```
    Deprecated. Prefer using Invoice#getId() as the id param (which is a String)
    
    Lookup all coupon redemptions on an invoice given query params.
    
    Parameters:
    
    invoiceNumber - invoice number
    
    params - QueryParams
    
    Returns:
    
    the coupon redemptions for this invoice on success, null otherwise
  - getCouponRedemptionsByInvoice
```
public Redemptions getCouponRedemptionsByInvoice(String invoiceId,
                                                 QueryParams params)
```
    Lookup all coupon redemptions on an invoice given query params.
    
    Parameters:
    
    invoiceId - String invoice id
    
    params - QueryParams
    
    Returns:
    
    the coupon redemptions for this invoice on success, null otherwise
  - getCouponRedemptionsBySubscription
```
public Redemptions getCouponRedemptionsBySubscription(String subscriptionUuid,
                                                      QueryParams params)
```
    Lookup all coupon redemptions on a subscription given query params.
    
    Parameters:
    
    subscriptionUuid - String subscription uuid
    
    params - QueryParams
    
    Returns:
    
    the coupon redemptions for this subscription on success, null otherwise
  - deleteCouponRedemption
```
public void deleteCouponRedemption(String accountCode)
```
    Deletes a coupon redemption from an account.
    
    Parameters:
    
    accountCode - recurly account id
  - deleteCouponRedemption
```
public void deleteCouponRedemption(String accountCode,
                                   String redemptionUuid)
```
    Deletes a specific redemption.
    
    Parameters:
    
    accountCode - recurly account id
    
    redemptionUuid - recurly coupon redemption uuid
  - generateUniqueCodes
```
public Coupons generateUniqueCodes(String couponCode,
                                   Coupon coupon)
```
    Generates unique codes for a bulk coupon.
    
    Parameters:
    
    couponCode - recurly coupon code (must have been created as type: bulk)
    
    coupon - A coupon with number of unique codes set
  - getUniqueCouponCodes
```
public Coupons getUniqueCouponCodes(String couponCode,
                                    QueryParams params)
```
    Lookup all unique codes for a bulk coupon given query params.
    
    Parameters:
    
    couponCode - String coupon code
    
    params - QueryParams
    
    Returns:
    
    the unique coupon codes for the coupon code on success, null otherwise
  - fetchSubscription
```
public Subscription fetchSubscription(String recurlyToken)
```
    Fetch Subscription
    Returns subscription from a recurly.js token.
    
    Parameters:
    
    recurlyToken - token given by recurly.js
    
    Returns:
    
    subscription object on success, null otherwise
  - fetchBillingInfo
```
public BillingInfo fetchBillingInfo(String recurlyToken)
```
    Fetch BillingInfo
    Returns billing info from a recurly.js token.
    
    Parameters:
    
    recurlyToken - token given by recurly.js
    
    Returns:
    
    billing info object on success, null otherwise
  - fetchInvoice
```
public Invoice fetchInvoice(String recurlyToken)
```
    Fetch Invoice
    Returns invoice from a recurly.js token.
    
    Parameters:
    
    recurlyToken - token given by recurly.js
    
    Returns:
    
    invoice object on success, null otherwise
  - getGiftCards
```
public GiftCards getGiftCards(QueryParams params)
```
    Get Gift Cards given query params
    Returns information about all gift cards.
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    gitfcards object on success, null otherwise
  - getGiftCards
```
public GiftCards getGiftCards()
```
    Get Gift Cards
    Returns information about all gift cards.
    
    Returns:
    
    gitfcards object on success, null otherwise
  - getGiftCardsCount
```
public Integer getGiftCardsCount(QueryParams params)
```
    Get number of GiftCards matching the query params
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    Integer on success, null otherwise
  - getGiftCard
```
public GiftCard getGiftCard(Long giftCardId)
```
    Get a Gift Card
    
    Parameters:
    
    giftCardId - The id for the GiftCard
    
    Returns:
    
    The GiftCard object as identified by the passed in id
  - redeemGiftCard
```
public GiftCard redeemGiftCard(String redemptionCode,
                               String accountCode)
```
    Redeem a Gift Card
    
    Parameters:
    
    redemptionCode - The redemption code the GiftCard
    
    accountCode - The account code for the Account
    
    Returns:
    
    The updated GiftCard object as identified by the passed in id
  - purchaseGiftCard
```
public GiftCard purchaseGiftCard(GiftCard giftCard)
```
    Purchase a GiftCard
    
    Parameters:
    
    giftCard - The giftCard data
    
    Returns:
    
    the giftCard object
  - previewGiftCard
```
public GiftCard previewGiftCard(GiftCard giftCard)
```
    Preview a GiftCard
    
    Parameters:
    
    giftCard - The giftCard data
    
    Returns:
    
    the giftCard object
  - getMeasuredUnits
```
public MeasuredUnits getMeasuredUnits()
```
    Return all the MeasuredUnits
    
    Returns:
    
    the MeasuredUnits object as identified by the passed in ID
  - createMeasuredUnit
```
public MeasuredUnit createMeasuredUnit(MeasuredUnit measuredUnit)
```
    Create a MeasuredUnit's info
    
    Parameters:
    
    measuredUnit - The measuredUnit to create on recurly
    
    Returns:
    
    the measuredUnit object as identified by the passed in ID
  - purchase
```
public InvoiceCollection purchase(Purchase purchase)
```
    Purchases endpoint
    https://dev.recurly.com/docs/create-purchase
    
    Parameters:
    
    purchase - The purchase data
    
    Returns:
    
    The created invoice collection
  - previewPurchase
```
public InvoiceCollection previewPurchase(Purchase purchase)
```
    Purchases preview endpoint
    https://dev.recurly.com/docs/preview-purchase
    
    Parameters:
    
    purchase - The purchase data
    
    Returns:
    
    The preview invoice collection
  - authorizePurchase
```
public InvoiceCollection authorizePurchase(Purchase purchase)
```
    Purchases authorize endpoint. Generate an authorized invoice for the purchase. Runs validations + but does not run any transactions. This endpoint will create a + pending purchase that can be activated at a later time once payment + has been completed on an external source (e.g. Adyen's Hosted + Payment Pages).
    https://dev.recurly.com/docs/authorize-purchase
    
    Parameters:
    
    purchase - The purchase data
    
    Returns:
    
    The authorized invoice collection
  - pendingPurchase
```
public InvoiceCollection pendingPurchase(Purchase purchase)
```
    Purchases pending endpoint. Use for Adyen HPP transaction requests. Runs validations + but does not run any transactions.
    https://dev.recurly.com/docs/pending-purchase
    
    Parameters:
    
    purchase - The purchase data
    
    Returns:
    
    The authorized invoice collection
  - createAccountAcquisition
```
public AccountAcquisition createAccountAcquisition(String accountCode,
                                                   AccountAcquisition acquisition)
```
    Sets the acquisition details for an account
    https://dev.recurly.com/docs/create-account-acquisition
    
    Parameters:
    
    accountCode - The account's account code
    
    acquisition - The AccountAcquisition data
    
    Returns:
    
    The created AccountAcquisition object
  - getAccountAcquisition
```
public AccountAcquisition getAccountAcquisition(String accountCode)
```
    Gets the acquisition details for an account
    https://dev.recurly.com/docs/create-account-acquisition
    
    Parameters:
    
    accountCode - The account's account code
    
    Returns:
    
    The created AccountAcquisition object
  - updateAccountAcquisition
```
public AccountAcquisition updateAccountAcquisition(String accountCode,
                                                   AccountAcquisition acquisition)
```
    Updates the acquisition details for an account
    https://dev.recurly.com/docs/update-account-acquisition
    
    Parameters:
    
    accountCode - The account's account code
    
    acquisition - The AccountAcquisition data
    
    Returns:
    
    The created AccountAcquisition object
  - deleteAccountAcquisition
```
public void deleteAccountAcquisition(String accountCode)
```
    Clear the acquisition details for an account
    https://dev.recurly.com/docs/clear-account-acquisition
    
    Parameters:
    
    accountCode - The account's account code
  - getCreditPayments
```
public CreditPayments getCreditPayments()
```
    Get Credit Payments
    Returns information about all credit payments.
    
    Returns:
    
    CreditPayments on success, null otherwise
  - getCreditPayments
```
public CreditPayments getCreditPayments(QueryParams params)
```
    Get Credit Payments
    Returns information about all credit payments.
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    CreditPayments on success, null otherwise
  - getCreditPayments
```
public CreditPayments getCreditPayments(String accountCode,
                                        QueryParams params)
```
    Get Credit Payments for a given account
    Returns information about all credit payments.
    
    Parameters:
    
    accountCode - The account code to filter
    
    params - QueryParams
    
    Returns:
    
    CreditPayments on success, null otherwise
  - getShippingMethods
```
public ShippingMethods getShippingMethods()
```
    Get Shipping Methods for the site
    https://dev.recurly.com/docs/list-shipping-methods
    
    Returns:
    
    ShippingMethods on success, null otherwise
  - getShippingMethods
```
public ShippingMethods getShippingMethods(QueryParams params)
```
    Get Shipping Methods for the site
    https://dev.recurly.com/docs/list-shipping-methods
    
    Parameters:
    
    params - QueryParams
    
    Returns:
    
    ShippingMethods on success, null otherwise
  - getShippingMethod
```
public ShippingMethod getShippingMethod(String shippingMethodCode)
```
    Look up a shipping method
    https://dev.recurly.com/docs/lookup-shipping-method
    
    Parameters:
    
    shippingMethodCode - The code for the ShippingMethod
    
    Returns:
    
    The ShippingMethod object as identified by the passed in code
  - doGETWithFullURL
```
public <T> T doGETWithFullURL(Class<T> clazz,
                              String url)
```

Class RecurlyClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RECURLY_DEBUG_KEY

RECURLY_API_VERSION

FETCH_RESOURCE

Constructor Detail

RecurlyClient

RecurlyClient

RecurlyClient

RecurlyClient

Method Detail

open

close

setAcceptLanguage

getRateLimitRemaining

createAccount

getAccounts

getAccounts

getAccountsCount

getCoupons

getCoupons

getCouponsCount

getAccount

updateAccount

getAccountBalance

closeAccount

reopenAccount

getChildAccounts

getAccountAdjustments

getAccountAdjustments

getAccountAdjustments

getAccountAdjustments

getAdjustment

createAccountAdjustment

deleteAccountAdjustment

deleteAdjustment

createSubscription

previewSubscription

getSubscription

cancelSubscription

cancelSubscription

pauseSubscription

convertTrialMoto

convertTrial

convertTrial

resumeSubscription

postponeSubscription

terminateSubscription

reactivateSubscription

updateSubscription

updateSubscriptionPreview

updateSubscriptionNotes

getAccountSubscriptions

getSubscriptions

getSubscriptions

getSubscriptionsCount

getAccountSubscriptions

getInvoiceSubscriptions

getInvoiceSubscriptions

postSubscriptionUsage

getSubscriptionUsages

getAccountSubscriptions

createOrUpdateBillingInfo

createOrUpdateBillingInfo

getBillingInfo

clearBillingInfo

getAccountNotes

getAccountTransactions

getAccountTransactions

getTransactions

getTransactions

getTransactionsCount

getTransaction

createTransaction

refundTransaction

getTransactionSubscriptions