BillingPortalServiceFactory.php
4 years ago
ConfigurationService.php
2 years ago
SessionService.php
4 years ago
ConfigurationService.php
74 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | |
| 5 | namespace Stripe\Service\BillingPortal; |
| 6 | |
| 7 | class ConfigurationService extends \Stripe\Service\AbstractService |
| 8 | { |
| 9 | /** |
| 10 | * Returns a list of configurations that describe the functionality of the customer |
| 11 | * portal. |
| 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\BillingPortal\Configuration> |
| 19 | */ |
| 20 | public function all($params = null, $opts = null) |
| 21 | { |
| 22 | return $this->requestCollection('get', '/v1/billing_portal/configurations', $params, $opts); |
| 23 | } |
| 24 | |
| 25 | /** |
| 26 | * Creates a configuration that describes the functionality and behavior of a |
| 27 | * PortalSession. |
| 28 | * |
| 29 | * @param null|array $params |
| 30 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 31 | * |
| 32 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 33 | * |
| 34 | * @return \Stripe\BillingPortal\Configuration |
| 35 | */ |
| 36 | public function create($params = null, $opts = null) |
| 37 | { |
| 38 | return $this->request('post', '/v1/billing_portal/configurations', $params, $opts); |
| 39 | } |
| 40 | |
| 41 | /** |
| 42 | * Retrieves a configuration that describes the functionality of the customer |
| 43 | * portal. |
| 44 | * |
| 45 | * @param string $id |
| 46 | * @param null|array $params |
| 47 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 48 | * |
| 49 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 50 | * |
| 51 | * @return \Stripe\BillingPortal\Configuration |
| 52 | */ |
| 53 | public function retrieve($id, $params = null, $opts = null) |
| 54 | { |
| 55 | return $this->request('get', $this->buildPath('/v1/billing_portal/configurations/%s', $id), $params, $opts); |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Updates a configuration that describes the functionality of the customer portal. |
| 60 | * |
| 61 | * @param string $id |
| 62 | * @param null|array $params |
| 63 | * @param null|array|\Stripe\Util\RequestOptions $opts |
| 64 | * |
| 65 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 66 | * |
| 67 | * @return \Stripe\BillingPortal\Configuration |
| 68 | */ |
| 69 | public function update($id, $params = null, $opts = null) |
| 70 | { |
| 71 | return $this->request('post', $this->buildPath('/v1/billing_portal/configurations/%s', $id), $params, $opts); |
| 72 | } |
| 73 | } |
| 74 |