CreditNoteService.php — GiveWP – Donation Plugin and Fundraising Platform 4.16.3

give / vendor / stripe / stripe-php / lib / Service / CreditNoteService.php

give / vendor / stripe / stripe-php / lib / Service Last commit date

CreditNoteService.php

157 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4
5	namespace Stripe\Service;
6
7	class CreditNoteService extends \Stripe\Service\AbstractService
8	{
9	/**
10	* Returns a list of credit notes.
11	*
12	* @param null\|array $params
13	* @param null\|array\|\Stripe\Util\RequestOptions $opts
14	*
15	* @throws \Stripe\Exception\ApiErrorException if the request fails
16	*
17	* @return \Stripe\Collection<\Stripe\CreditNote>
18	*/
19	public function all($params = null, $opts = null)
20	{
21	return $this->requestCollection('get', '/v1/credit_notes', $params, $opts);
22	}
23
24	/**
25	* When retrieving a credit note, you’ll get a <strong>lines</strong> property
26	* containing the the first handful of those items. There is also a URL where you
27	* can retrieve the full (paginated) list of line items.
28	*
29	* @param string $parentId
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\Collection<\Stripe\CreditNoteLineItem>
36	*/
37	public function allLines($parentId, $params = null, $opts = null)
38	{
39	return $this->requestCollection('get', $this->buildPath('/v1/credit_notes/%s/lines', $parentId), $params, $opts);
40	}
41
42	/**
43	* Issue a credit note to adjust the amount of a finalized invoice. For a
44	* <code>status=open</code> invoice, a credit note reduces its
45	* <code>amount_due</code>. For a <code>status=paid</code> invoice, a credit note
46	* does not affect its <code>amount_due</code>. Instead, it can result in any
47	* combination of the following:.
48	*
49	* <ul> <li>Refund: create a new refund (using <code>refund_amount</code>) or link
50	* an existing refund (using <code>refund</code>).</li> <li>Customer balance
51	* credit: credit the customer’s balance (using <code>credit_amount</code>) which
52	* will be automatically applied to their next invoice when it’s finalized.</li>
53	* <li>Outside of Stripe credit: record the amount that is or will be credited
54	* outside of Stripe (using <code>out_of_band_amount</code>).</li> </ul>
55	*
56	* For post-payment credit notes the sum of the refund, credit and outside of
57	* Stripe amounts must equal the credit note total.
58	*
59	* You may issue multiple credit notes for an invoice. Each credit note will
60	* increment the invoice’s <code>pre_payment_credit_notes_amount</code> or
61	* <code>post_payment_credit_notes_amount</code> depending on its
62	* <code>status</code> at the time of credit note creation.
63	*
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\CreditNote
70	*/
71	public function create($params = null, $opts = null)
72	{
73	return $this->request('post', '/v1/credit_notes', $params, $opts);
74	}
75
76	/**
77	* Get a preview of a credit note without creating it.
78	*
79	* @param null\|array $params
80	* @param null\|array\|\Stripe\Util\RequestOptions $opts
81	*
82	* @throws \Stripe\Exception\ApiErrorException if the request fails
83	*
84	* @return \Stripe\CreditNote
85	*/
86	public function preview($params = null, $opts = null)
87	{
88	return $this->request('get', '/v1/credit_notes/preview', $params, $opts);
89	}
90
91	/**
92	* When retrieving a credit note preview, you’ll get a <strong>lines</strong>
93	* property containing the first handful of those items. This URL you can retrieve
94	* the full (paginated) list of line items.
95	*
96	* @param null\|array $params
97	* @param null\|array\|\Stripe\Util\RequestOptions $opts
98	*
99	* @throws \Stripe\Exception\ApiErrorException if the request fails
100	*
101	* @return \Stripe\Collection<\Stripe\CreditNote>
102	*/
103	public function previewLines($params = null, $opts = null)
104	{
105	return $this->requestCollection('get', '/v1/credit_notes/preview/lines', $params, $opts);
106	}
107
108	/**
109	* Retrieves the credit note object with the given identifier.
110	*
111	* @param string $id
112	* @param null\|array $params
113	* @param null\|array\|\Stripe\Util\RequestOptions $opts
114	*
115	* @throws \Stripe\Exception\ApiErrorException if the request fails
116	*
117	* @return \Stripe\CreditNote
118	*/
119	public function retrieve($id, $params = null, $opts = null)
120	{
121	return $this->request('get', $this->buildPath('/v1/credit_notes/%s', $id), $params, $opts);
122	}
123
124	/**
125	* Updates an existing credit note.
126	*
127	* @param string $id
128	* @param null\|array $params
129	* @param null\|array\|\Stripe\Util\RequestOptions $opts
130	*
131	* @throws \Stripe\Exception\ApiErrorException if the request fails
132	*
133	* @return \Stripe\CreditNote
134	*/
135	public function update($id, $params = null, $opts = null)
136	{
137	return $this->request('post', $this->buildPath('/v1/credit_notes/%s', $id), $params, $opts);
138	}
139
140	/**
141	* Marks a credit note as void. Learn more about <a
142	* href="/docs/billing/invoices/credit-notes#voiding">voiding credit notes</a>.
143	*
144	* @param string $id
145	* @param null\|array $params
146	* @param null\|array\|\Stripe\Util\RequestOptions $opts
147	*
148	* @throws \Stripe\Exception\ApiErrorException if the request fails
149	*
150	* @return \Stripe\CreditNote
151	*/
152	public function voidCreditNote($id, $params = null, $opts = null)
153	{
154	return $this->request('post', $this->buildPath('/v1/credit_notes/%s/void', $id), $params, $opts);
155	}
156	}
157