FileMaster
Search
Toggle Dark Mode
Home
/
.
/
wp-content
/
plugins
/
ameliabooking
/
vendor
/
stripe
/
stripe-php
/
lib
/
Entitlements
Edit File: Feature.php
<?php // File generated from our OpenAPI spec namespace AmeliaStripe\Entitlements; /** * A feature represents a monetizable ability or functionality in your system. * Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer. * * @property string $id Unique identifier for the object. * @property string $object String representing the object's type. Objects of the same type share the same value. * @property bool $active Inactive features cannot be attached to new products and will not be returned from the features list endpoint. * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode. * @property string $lookup_key A unique key you provide as your own system identifier. This may be up to 80 characters. * @property \AmeliaStripe\StripeObject $metadata Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. * @property string $name The feature's name, for your own purpose, not meant to be displayable to the customer. */ class Feature extends \AmeliaStripe\ApiResource { const OBJECT_NAME = 'entitlements.feature'; use \AmeliaStripe\ApiOperations\Update; /** * Creates a feature. * * @param null|array{expand?: string[], lookup_key: string, metadata?: array<string, string>, name: string} $params * @param null|array|string $options * * @return Feature the created resource * * @throws \AmeliaStripe\Exception\ApiErrorException if the request fails */ public static function create($params = null, $options = null) { self::_validateParams($params); $url = static::classUrl(); list($response, $opts) = static::_staticRequest('post', $url, $params, $options); $obj = \AmeliaStripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; } /** * Retrieve a list of features. * * @param null|array{archived?: bool, ending_before?: string, expand?: string[], limit?: int, lookup_key?: string, starting_after?: string} $params * @param null|array|string $opts * * @return \AmeliaStripe\Collection<Feature> of ApiResources * * @throws \AmeliaStripe\Exception\ApiErrorException if the request fails */ public static function all($params = null, $opts = null) { $url = static::classUrl(); return static::_requestPage($url, \AmeliaStripe\Collection::class, $params, $opts); } /** * Retrieves a feature. * * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key * @param null|array|string $opts * * @return Feature * * @throws \AmeliaStripe\Exception\ApiErrorException if the request fails */ public static function retrieve($id, $opts = null) { $opts = \AmeliaStripe\Util\RequestOptions::parse($opts); $instance = new static($id, $opts); $instance->refresh(); return $instance; } /** * Update a feature’s metadata or permanently deactivate it. * * @param string $id the ID of the resource to update * @param null|array{active?: bool, expand?: string[], metadata?: null|array<string, string>, name?: string} $params * @param null|array|string $opts * * @return Feature the updated resource * * @throws \AmeliaStripe\Exception\ApiErrorException if the request fails */ public static function update($id, $params = null, $opts = null) { self::_validateParams($params); $url = static::resourceUrl($id); list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); $obj = \AmeliaStripe\Util\Util::convertToStripeObject($response->json, $opts); $obj->setLastResponse($response); return $obj; } }
Save
Back