Файл: vendor/stripe/stripe-php/lib/Service/PromotionCodeService.php
Строк: 82
<?php
// File generated from our OpenAPI spec
namespace StripeService;
class PromotionCodeService extends StripeServiceAbstractService
{
/**
* Returns a list of your promotion codes.
*
* @param null|array $params
* @param null|array|StripeUtilRequestOptions $opts
*
* @throws StripeExceptionApiErrorException if the request fails
*
* @return StripeCollection<StripePromotionCode>
*/
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/promotion_codes', $params, $opts);
}
/**
* A promotion code points to a coupon. You can optionally restrict the code to a
* specific customer, redemption limit, and expiration date.
*
* @param null|array $params
* @param null|array|StripeUtilRequestOptions $opts
*
* @throws StripeExceptionApiErrorException if the request fails
*
* @return StripePromotionCode
*/
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/promotion_codes', $params, $opts);
}
/**
* Retrieves the promotion code with the given ID. In order to retrieve a promotion
* code by the customer-facing <code>code</code> use <a
* href="/docs/api/promotion_codes/list">list</a> with the desired
* <code>code</code>.
*
* @param string $id
* @param null|array $params
* @param null|array|StripeUtilRequestOptions $opts
*
* @throws StripeExceptionApiErrorException if the request fails
*
* @return StripePromotionCode
*/
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/promotion_codes/%s', $id), $params, $opts);
}
/**
* Updates the specified promotion code by setting the values of the parameters
* passed. Most fields are, by design, not editable.
*
* @param string $id
* @param null|array $params
* @param null|array|StripeUtilRequestOptions $opts
*
* @throws StripeExceptionApiErrorException if the request fails
*
* @return StripePromotionCode
*/
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/promotion_codes/%s', $id), $params, $opts);
}
}