PHP Class Recurly_Invoice, recurly-client-php

Inheritance: extends Recurly_Resource
Exibir arquivo Open project: recurly/recurly-client-php Class Usage Examples

Public Methods

Method Description
get ( $invoiceNumber, $client = null ) : Recurly_Invoice Lookup an invoice by its ID
getInvoicePdf ( $invoiceNumber, $locale = null, $client = null ) Retrieve the PDF version of an invoice
getPdf ( $locale = null ) Retrieve the PDF version of this invoice
invoiceNumberWithPrefix ( )
invoicePendingCharges ( $accountCode, $attributes = [], $client = null ) : Recurly_Invoice Creates an invoice for an account using its pending charges
markFailed ( )
markSuccessful ( )
previewPendingCharges ( $accountCode, $attributes = [], $client = null ) : Recurly_Invoice Previews an invoice for an account using its pending charges
refund ( $line_items, $refund_apply_order = 'credit' ) : Recurly_Invoice Refunds given line items from an invoice and returns new refund invoice
refundAmount ( $amount_in_cents, $refund_apply_order = 'credit' ) : Recurly_Invoice Refunds an open amount from the invoice and returns a new refund invoice

Protected Methods

Method Description
createRefundInvoice ( $xml_string )
getNodeName ( )
getWriteableAttributes ( )
uri ( )
uriForInvoice ( $invoiceNumber )

Method Details

createRefundInvoice() protected method

protected createRefundInvoice ( $xml_string )

get() public static method

Lookup an invoice by its ID
public static get ( $invoiceNumber, $client = null ) : Recurly_Invoice
return Recurly_Invoice invoice

getInvoicePdf() public static method

Retrieve the PDF version of an invoice
public static getInvoicePdf ( $invoiceNumber, $locale = null, $client = null )

getNodeName() protected method

protected getNodeName ( )

getPdf() public method

Retrieve the PDF version of this invoice
public getPdf ( $locale = null )

getWriteableAttributes() protected method

protected getWriteableAttributes ( )

invoiceNumberWithPrefix() public method

invoicePendingCharges() public static method

Creates an invoice for an account using its pending charges
public static invoicePendingCharges ( $accountCode, $attributes = [], $client = null ) : Recurly_Invoice
return Recurly_Invoice invoice on success

markFailed() public method

public markFailed ( )

markSuccessful() public method

public markSuccessful ( )

previewPendingCharges() public static method

Previews an invoice for an account using its pending charges
public static previewPendingCharges ( $accountCode, $attributes = [], $client = null ) : Recurly_Invoice
return Recurly_Invoice invoice on success

refund() public method

Refunds given line items from an invoice and returns new refund invoice
public refund ( $line_items, $refund_apply_order = 'credit' ) : Recurly_Invoice
return Recurly_Invoice a new refund invoice

refundAmount() public method

Refunds an open amount from the invoice and returns a new refund invoice
public refundAmount ( $amount_in_cents, $refund_apply_order = 'credit' ) : Recurly_Invoice
return Recurly_Invoice a new refund invoice

uri() protected method

protected uri ( )

uriForInvoice() protected static method

protected static uriForInvoice ( $invoiceNumber )