PHP Class Cartalyst\Stripe\Api\Invoices

Inheritance: extends Api
Show file Open project: cartalyst/stripe

Public Methods

Method Description
all ( array $parameters = [] ) : array Lists all invoices.
create ( string $customerId, array $parameters = [] ) : array Creates a new invoice.
find ( string $invoiceId ) : array Retrieves an existing invoice.
lineItems ( string $invoiceId, array $parameters = [] ) : array Retrieves an existing invoice line items.
pay ( string $invoiceId ) : array Pays the given invoice.
upcomingInvoice ( string $customerId, string $subscriptionId = null ) : array Retrieves the given customer upcoming invoices.
update ( string $invoiceId, array $parameters = [] ) : array Updates an existing invoice.

Method Details

all() public method

Lists all invoices.
public all ( array $parameters = [] ) : array
$parameters array
return array

create() public method

Creates a new invoice.
public create ( string $customerId, array $parameters = [] ) : array
$customerId string
$parameters array
return array

find() public method

Retrieves an existing invoice.
public find ( string $invoiceId ) : array
$invoiceId string
return array

lineItems() public method

Retrieves an existing invoice line items.
public lineItems ( string $invoiceId, array $parameters = [] ) : array
$invoiceId string
$parameters array
return array

pay() public method

Pays the given invoice.
public pay ( string $invoiceId ) : array
$invoiceId string
return array

upcomingInvoice() public method

Retrieves the given customer upcoming invoices.
public upcomingInvoice ( string $customerId, string $subscriptionId = null ) : array
$customerId string
$subscriptionId string
return array

update() public method

Updates an existing invoice.
public update ( string $invoiceId, array $parameters = [] ) : array
$invoiceId string
$parameters array
return array