C# Class Recurly.Account

An account in Recurly. https://dev.recurly.com/docs/get-account

Inheritance: Recurly.RecurlyEntity

Mostrar archivo Open project: recurly/recurly-client-net Class Usage Examples

Public Methods

Method	Description
Account ( string accountCode ) : System
Account ( string accountCode, BillingInfo billingInfo ) : System	Creates a new account with required billing information
Close ( ) : void	Close the account and cancel any active subscriptions (if there is one). Note: This does not create a refund for any time remaining.
Create ( ) : void	Create a new account in Recurly
DeleteBillingInfo ( ) : void	Delete an account's billing info.
Equals ( Account account ) : bool
Equals ( object obj ) : bool
GetActiveRedemption ( ) : CouponRedemption	Returns the first active coupon redemptions on this account
GetActiveRedemptions ( ) : RecurlyList	Returns all active coupon redemptions on this account
GetAdjustments ( Adjustment type = Adjustment.AdjustmentType.All, Adjustment state = Adjustment.AdjustmentState.Any ) : RecurlyList	Gets all adjustments for this account, by type
GetHashCode ( ) : int
GetInvoices ( ) : RecurlyList	Returns a list of invoices for this account
GetNotes ( ) : RecurlyList
GetShippingAddresses ( ) : RecurlyList	Gets all shipping addresses
GetSubscriptions ( Subscription state = Subscription.SubscriptionState.All ) : RecurlyList	Returns a list of subscriptions for this account
GetTransactions ( TransactionList state = TransactionList.TransactionState.All, TransactionList type = TransactionList.TransactionType.All ) : RecurlyList	Returns a list of transactions for this account, by transaction type
InvoicePendingCharges ( ) : Invoice	Posts pending charges on an account
NewAdjustment ( string currency, int unitAmountInCents, string description = "", int quantity = 1, string accountingCode = "", bool taxExempt = false ) : Adjustment	Returns a new adjustment (credit or charge) for this account
PreviewInvoicePendingCharges ( ) : Invoice	Previews a new invoice for the pending charges on an account
RedeemCoupon ( string couponCode, string currency, string subscriptionUuid = null ) : CouponRedemption	Redeems a coupon on this account
Reopen ( ) : void	Reopen an existing account in Recurly
ToString ( ) : string
Update ( ) : void	Update an existing account in Recurly

Private Methods

Method	Description
Account ( ) : System
Account ( XmlTextReader xmlReader ) : System
ReadXml ( XmlTextReader reader ) : void
WriteXml ( XmlTextWriter xmlWriter ) : void

Method Details

Account() public method

public Account ( string accountCode ) : System
accountCode	string
return	System

Account() public method

Creates a new account with required billing information

public Account ( string accountCode, BillingInfo billingInfo ) : System
accountCode	string
billingInfo	BillingInfo
return	System

Close() public method

Close the account and cancel any active subscriptions (if there is one). Note: This does not create a refund for any time remaining.

public Close ( ) : void
return	void

Create() public method

Create a new account in Recurly

public Create ( ) : void
return	void

DeleteBillingInfo() public method

Delete an account's billing info.

public DeleteBillingInfo ( ) : void
return	void

Equals() public method

public Equals ( Account account ) : bool
account	Account
return	bool

Equals() public method

public Equals ( object obj ) : bool
obj	object
return	bool

GetActiveRedemption() public method

Returns the first active coupon redemptions on this account

public GetActiveRedemption ( ) : CouponRedemption
return	CouponRedemption

GetActiveRedemptions() public method

Returns all active coupon redemptions on this account

public GetActiveRedemptions ( ) : RecurlyList
return	RecurlyList

GetAdjustments() public method

Gets all adjustments for this account, by type

public GetAdjustments ( Adjustment type = Adjustment.AdjustmentType.All, Adjustment state = Adjustment.AdjustmentState.Any ) : RecurlyList
type	Adjustment	Adjustment type to retrieve. Optional, default: All.
state	Adjustment	State of the Adjustments to retrieve. Optional, default: Any.
return	RecurlyList

GetHashCode() public method

public GetHashCode ( ) : int
return	int

GetInvoices() public method

Returns a list of invoices for this account

public GetInvoices ( ) : RecurlyList
return	RecurlyList

GetNotes() public method

public GetNotes ( ) : RecurlyList
return	RecurlyList

GetShippingAddresses() public method

Gets all shipping addresses

public GetShippingAddresses ( ) : RecurlyList
return	RecurlyList

GetSubscriptions() public method

Returns a list of subscriptions for this account

public GetSubscriptions ( Subscription state = Subscription.SubscriptionState.All ) : RecurlyList
state	Subscription
return	RecurlyList

GetTransactions() public method

Returns a list of transactions for this account, by transaction type

public GetTransactions ( TransactionList state = TransactionList.TransactionState.All, TransactionList type = TransactionList.TransactionType.All ) : RecurlyList
state	TransactionList	Transactions of this state will be retrieved. Optional, default: All.
type	TransactionList	Transactions of this type will be retrieved. Optional, default: All.
return	RecurlyList

InvoicePendingCharges() public method

Posts pending charges on an account

public InvoicePendingCharges ( ) : Invoice
return	Invoice

NewAdjustment() public method

Returns a new adjustment (credit or charge) for this account

public NewAdjustment ( string currency, int unitAmountInCents, string description = "", int quantity = 1, string accountingCode = "", bool taxExempt = false ) : Adjustment
currency	string	Currency, 3-letter ISO code.
unitAmountInCents	int	Positive amount for a charge, negative amount for a credit. Max 10,000,000.
description	string	Description of the adjustment for the invoice.
quantity	int	Quantity, defaults to 1.
accountingCode	string	Accounting code. Max of 20 characters.
taxExempt	bool
return	Adjustment

PreviewInvoicePendingCharges() public method

Previews a new invoice for the pending charges on an account

public PreviewInvoicePendingCharges ( ) : Invoice
return	Invoice

RedeemCoupon() public method

Redeems a coupon on this account

public RedeemCoupon ( string couponCode, string currency, string subscriptionUuid = null ) : CouponRedemption
couponCode	string
currency	string
subscriptionUuid	string
return	CouponRedemption

Reopen() public method

Reopen an existing account in Recurly

public Reopen ( ) : void
return	void

ToString() public method

public ToString ( ) : string
return	string

Update() public method

Update an existing account in Recurly

public Update ( ) : void
return	void