com.ning.billing.recurly

Class RecurlyClient

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_DEBUG_KEY
static String	RECURLY_PAGE_SIZE_KEY

Constructor Summary

Constructors

Constructor and Description
RecurlyClient(String apiKey)
RecurlyClient(String apiKey, String host, int port, String version)

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	clearBillingInfo(String accountCode) Clear an account's billing info You may remove any stored billing information for an account.
void	close() Close the underlying http client
void	closeAccount(String accountCode) Close Account Marks an account as closed and cancels any active subscriptions.
Account	createAccount(Account account) Create Account Creates a new account.
Adjustment	createAccountAdjustment(String accountCode, Adjustment adjustment)
Coupon	createCoupon(Coupon coupon) Create a Coupon
BillingInfo	createOrUpdateBillingInfo(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.
Plan	createPlan(Plan plan) Create a Plan's info
AddOn	createPlanAddOn(String planCode, AddOn addOn) Create an AddOn to a Plan
Subscription	createSubscription(Subscription subscription) Create a subscription Creates a subscription for an account.
Transaction	createTransaction(Transaction trans) Creates a Transaction through the Recurly API.
void	deleteAccountAdjustment(String accountCode)
void	deleteAddOn(String planCode, String addOnCode) Deletes a AddOn for a Plan
void	deleteCoupon(String couponCode) Delete a Coupon
void	deleteCouponRedemption(String accountCode) Deletes a coupon from an account.
void	deletePlan(String planCode) Deletes a Plan
<T> T	doGETWithFullURL(Class<T> clazz, String url)
BillingInfo	fetchBillingInfo(String recurlyToken) Fetch BillingInfo Returns billing info from a recurly.js token.
Invoice	fetchInvoice(String recurlyToken) Fetch Invoice Returns invoice from a recurly.js token.
Subscription	fetchSubscription(String recurlyToken) Fetch Subscription Returns subscription from a recurly.js token.
Account	getAccount(String accountCode) Get Account Returns information about a single account.
Adjustments	getAccountAdjustments(String accountCode, Adjustments.AdjustmentType type)
Adjustments	getAccountAdjustments(String accountCode, Adjustments.AdjustmentType type, Adjustments.AdjustmentState state)
Invoices	getAccountInvoices(String accountCode) Lookup an account's invoices Returns the account's invoices
Accounts	getAccounts() Get Accounts Returns information about all accounts.
Subscriptions	getAccountSubscriptions(String accountCode) Get the subscriptions for an Account.
Subscriptions	getAccountSubscriptions(String accountCode, String status) Get the subscriptions for an account.
Transactions	getAccountTransactions(String accountCode) Lookup an account's transactions history Returns the account's transaction history
AddOn	getAddOn(String planCode, String addOnCode) Get an AddOn's details
AddOns	getAddOns(String planCode) Return all the AddOn for a Plan
BillingInfo	getBillingInfo(String accountCode) Lookup an account's billing info Returns only the account's current billing information.
Coupon	getCoupon(String couponCode) Get a Coupon
Redemption	getCouponRedemptionByAccount(String accountCode) Lookup a coupon redemption on an invoice.
Redemption	getCouponRedemptionByInvoice(Integer invoiceNumber) Lookup a coupon redemption on an invoice.
Coupons	getCoupons()
static Integer	getPageSize() Returns the page Size to use when querying.
static String	getPageSizeGetParam()
Plan	getPlan(String planCode) Get a Plan's details
Plans	getPlans() Return all the plans
Subscription	getSubscription(String uuid) Get a particular Subscription by it's UUID Returns information about a single account.
Transaction	getTransaction(String transactionId) Lookup a transaction
void	open() Open the underlying http client
Subscription	reactivateSubscription(Subscription subscription) Reactivating a canceled subscription Reactivate a canceled subscription so it renews at the end of the current bill cycle.
Redemption	redeemCoupon(String couponCode, Redemption redemption) Redeem a Coupon on an account.
void	refundTransaction(String transactionId, BigDecimal amount) Refund a transaction
void	terminateSubscription(Subscription subscription, RefundOption refund) Terminate a particular Subscription by it's UUID
Account	updateAccount(String accountCode, Account account) Update Account Updates an existing account.
Subscription	updateSubscription(String uuid, SubscriptionUpdate subscriptionUpdate) Update a particular Subscription by it's UUID Returns information about a single account.

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_PAGE_SIZE_KEY

public static final String RECURLY_PAGE_SIZE_KEY

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 host,
             int port,
             String version)

Method Detail

getPageSize

public static Integer getPageSize()

Returns the page Size to use when querying. The page size is set as System.property: recurly.page.size

getPageSizeGetParam

public static String getPageSizeGetParam()

open

public void open()

Open the underlying http client

close

public void close()

Close the underlying http client

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:

account object on success, null otherwise

getCoupons

public Coupons getCoupons()

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

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

getAccountAdjustments

public Adjustments getAccountAdjustments(String accountCode,
                                Adjustments.AdjustmentType type)

getAccountAdjustments

public Adjustments getAccountAdjustments(String accountCode,
                                Adjustments.AdjustmentType type,
                                Adjustments.AdjustmentState state)

createAccountAdjustment

public Adjustment createAccountAdjustment(String accountCode,
                                 Adjustment adjustment)

deleteAccountAdjustment

public void deleteAccountAdjustment(String accountCode)

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

getSubscription

public Subscription getSubscription(String uuid)

Get a particular Subscription by it's UUID

Returns information about a single account.

Parameters:

uuid - UUID of the subscription to lookup

Returns:

Subscriptions for the specified user

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:

-?-

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:

-?-

updateSubscription

public Subscription updateSubscription(String uuid,
                              SubscriptionUpdate subscriptionUpdate)

Update a particular Subscription by it's UUID

Returns information about a single account.

Parameters:

uuid - UUID of the subscription to update

Returns:

Subscription the updated subscription

getAccountSubscriptions

public Subscriptions getAccountSubscriptions(String accountCode)

Get the subscriptions for an Account.

Returns information about a single Account.

Parameters:

accountCode - recurly account id

Returns:

Subscriptions for the specified user

getAccountSubscriptions

public Subscriptions getAccountSubscriptions(String accountCode,
                                    String status)

Get the subscriptions for an account.

Returns information about a single account.

Parameters:

accountCode - recurly account id

status - Only accounts in this status will be returned

Returns:

Subscriptions for the specified user

createOrUpdateBillingInfo

public BillingInfo createOrUpdateBillingInfo(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:

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

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

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

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

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

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

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

Returns:

the AddOn objects as identified by the passed plan ID

deleteAddOn

public void deleteAddOn(String planCode,
               String addOnCode)

Deletes a AddOn for a Plan

Parameters:

planCode - The Plan object.

addOnCode - The AddOn object to delete.

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 a coupon redemption on an invoice.

Parameters:

accountCode - recurly account id

Returns:

the coupon redemption for this account on success, null otherwise

getCouponRedemptionByInvoice

public Redemption getCouponRedemptionByInvoice(Integer invoiceNumber)

Lookup a coupon redemption on an invoice.

Parameters:

invoiceNumber - invoice number

Returns:

the coupon redemption for this invoice on success, null otherwise

deleteCouponRedemption

public void deleteCouponRedemption(String accountCode)

Deletes a coupon from an account.

Parameters:

accountCode - recurly account id

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

doGETWithFullURL

public <T> T doGETWithFullURL(Class<T> clazz,
                     String url)