| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe\Service; |
| 6 |
|
| 7 |
class InvoiceItemService extends \Stripe\Service\AbstractService |
| 8 |
{ |
| 9 |
/** |
| 10 |
* Returns a list of your invoice items. Invoice items are returned sorted by |
| 11 |
* creation date, with the most recently created invoice items appearing first. |
| 12 |
* |
| 13 |
* @param null|array $params |
| 14 |
* @param null|array|\Stripe\Util\RequestOptions $opts |
| 15 |
* |
| 16 |
* @throws \Stripe\Exception\ApiErrorException if the request fails |
| 17 |
* |
| 18 |
* @return \Stripe\Collection<\Stripe\InvoiceItem> |
| 19 |
*/ |
| 20 |
public function all($params = null, $opts = null) |
| 21 |
{ |
| 22 |
return $this->requestCollection('get', '/v1/invoiceitems', $params, $opts); |
| 23 |
} |
| 24 |
|
| 25 |
/** |
| 26 |
* Creates an item to be added to a draft invoice (up to 250 items per invoice). If |
| 27 |
* no invoice is specified, the item will be on the next invoice created for the |
| 28 |
* customer specified. |
| 29 |
* |
| 30 |
* @param null|array $params |
| 31 |
* @param null|array|\Stripe\Util\RequestOptions $opts |
| 32 |
* |
| 33 |
* @throws \Stripe\Exception\ApiErrorException if the request fails |
| 34 |
* |
| 35 |
* @return \Stripe\InvoiceItem |
| 36 |
*/ |
| 37 |
public function create($params = null, $opts = null) |
| 38 |
{ |
| 39 |
return $this->request('post', '/v1/invoiceitems', $params, $opts); |
| 40 |
} |
| 41 |
|
| 42 |
/** |
| 43 |
* Deletes an invoice item, removing it from an invoice. Deleting invoice items is |
| 44 |
* only possible when they’re not attached to invoices, or if it’s attached to a |
| 45 |
* draft invoice. |
| 46 |
* |
| 47 |
* @param string $id |
| 48 |
* @param null|array $params |
| 49 |
* @param null|array|\Stripe\Util\RequestOptions $opts |
| 50 |
* |
| 51 |
* @throws \Stripe\Exception\ApiErrorException if the request fails |
| 52 |
* |
| 53 |
* @return \Stripe\InvoiceItem |
| 54 |
*/ |
| 55 |
public function delete($id, $params = null, $opts = null) |
| 56 |
{ |
| 57 |
return $this->request('delete', $this->buildPath('/v1/invoiceitems/%s', $id), $params, $opts); |
| 58 |
} |
| 59 |
|
| 60 |
/** |
| 61 |
* Retrieves the invoice item with the given ID. |
| 62 |
* |
| 63 |
* @param string $id |
| 64 |
* @param null|array $params |
| 65 |
* @param null|array|\Stripe\Util\RequestOptions $opts |
| 66 |
* |
| 67 |
* @throws \Stripe\Exception\ApiErrorException if the request fails |
| 68 |
* |
| 69 |
* @return \Stripe\InvoiceItem |
| 70 |
*/ |
| 71 |
public function retrieve($id, $params = null, $opts = null) |
| 72 |
{ |
| 73 |
return $this->request('get', $this->buildPath('/v1/invoiceitems/%s', $id), $params, $opts); |
| 74 |
} |
| 75 |
|
| 76 |
/** |
| 77 |
* Updates the amount or description of an invoice item on an upcoming invoice. |
| 78 |
* Updating an invoice item is only possible before the invoice it’s attached to is |
| 79 |
* closed. |
| 80 |
* |
| 81 |
* @param string $id |
| 82 |
* @param null|array $params |
| 83 |
* @param null|array|\Stripe\Util\RequestOptions $opts |
| 84 |
* |
| 85 |
* @throws \Stripe\Exception\ApiErrorException if the request fails |
| 86 |
* |
| 87 |
* @return \Stripe\InvoiceItem |
| 88 |
*/ |
| 89 |
public function update($id, $params = null, $opts = null) |
| 90 |
{ |
| 91 |
return $this->request('post', $this->buildPath('/v1/invoiceitems/%s', $id), $params, $opts); |
| 92 |
} |
| 93 |
} |
| 94 |
|
