PHP Class Recurly_Adjustment, recurly-client-php

Inheritance: extends Recurly_Resource

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

Public Methods

Method	Description
create ( )
delete ( )
get ( $adjustment_uuid, $client = null )
refund ( $quantity = null, $prorate = false, $refund_apply_order = 'credit' ) : Recurly_Invoice	Allows you to refund this particular item if it's a part of an invoice. It does this by calling the invoice's refund() Only 'invoiced' adjustments can be refunded.
toRefundAttributes ( $quantity = null, $prorate = false ) : Array	Converts this adjustment into the attributes needed for a refund.

Protected Methods

Method	Description
createUriForAccount ( )
getNodeName ( )
getWriteableAttributes ( )

Method Details

create() public method

public create ( )

createUriForAccount() protected method

protected createUriForAccount ( )

delete() public method

public delete ( )

get() public static method

public static get ( $adjustment_uuid, $client = null )

getNodeName() protected method

protected getNodeName ( )

getWriteableAttributes() protected method

protected getWriteableAttributes ( )

refund() public method

Allows you to refund this particular item if it's a part of an invoice. It does this by calling the invoice's refund() Only 'invoiced' adjustments can be refunded.

public refund ( $quantity = null, $prorate = false, $refund_apply_order = 'credit' ) : Recurly_Invoice
return	Recurly_Invoice	the new refund invoice

toRefundAttributes() public method

Converts this adjustment into the attributes needed for a refund.

public toRefundAttributes ( $quantity = null, $prorate = false ) : Array
return	Array	an array of refund attributes to be fed into invoice->refund()