Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Features API

A feature indicates some benefit that is received as a result of having an active subscription. This translates to tags being applied to the subscriber's account allowing access to some resource to be controlled.There are three types of feature - `access`, `promotion`, and `usage`.The `access` feature is designed to simply give access to some resource, for example a streaming service. If its tag is present on the subscriber's account then access to that resource should be provided.The `promotion` feature coupled with the [promotions service](/docs/promotions-builder/overview) allows subscribers to get access to a specific promotion. This is achieved using a tag which is used as a constraint on the promotion. A promotion feature may have multiple promotions associated with it, but just one must be selected when configuring the feature for an offering's plan. The `usage` feature is designed to measure some sort of usage of a resource. This currently relieson [commerce extensions](/docs/api/commerce-extensions/commerce-extensions-introduction) to manage usage. Once defined a feature may be attached to an offering, making it available for use with any of thatoffering's plans. Once attached it must be configured for each of the offering's plans it is applicable to. For the `promotion` feature this involves specifying which of that feature's tags, and hence which promotion, should be applied when subscribed to that offering. Similarly, for the `promotion` feature the default value for the usage metric must be supplied.

Elastic Path Features API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Features. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 25 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

5 operations 2 paths 25 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Features API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Features 5

A feature indicates some benefit that is received as a result of having an active subscription. This translates to tags being applied to the subscriber's account allowing access t…

POST
/v2/subscriptions/features
Create a feature
CreateFeature 1 param body → 201400500
GET
/v2/subscriptions/features
List features
ListFeatures 3 params → 200400500
GET
/v2/subscriptions/features/{feature_uuid}
Get feature
GetFeature 1 param → 200400404500
DELETE
/v2/subscriptions/features/{feature_uuid}
Delete feature
DeleteFeature 1 param → 204500
PUT
/v2/subscriptions/features/{feature_uuid}
Update a feature
UpdateFeature 1 param body → 200400403404409500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Error (4 properties), FeatureUsageAttributes (4 properties), Feature (4 properties), FeatureUpdateAttributes (4 properties). Each schema is shown below with its type and property counts.

FeatureResponseAttributes
Timestamps
object
2 properties 2 required
Link
Error
object
4 properties 2 required
FeatureAccessAttributes
object
2 properties 2 required
FeatureUpdate
object
3 properties 3 required
SubscriptionFeatureType
string
ErrorResponse
object
1 property 1 required
Links
object
FeaturePromotion
object
3 properties 2 required
FeatureAttributes
object
4 properties 2 required
LinkObject
object
3 properties
FeatureConfiguration
object
1 property 1 required
FeatureCreate
object
2 properties 2 required
UUID
string
The unique identifier.
LinkURI
string
OwnerMeta
string
The owner of a resource, either store or organization.
ExternalRefUpdate
string
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
FeatureTag
string
A tag to add to the customer's account when entitled to the feature.
Feature
object
4 properties 3 required
FeatureUpdateAttributes
object
4 properties
FeaturePromotionAttributes
object
2 properties 2 required
FeatureMeta
object
2 properties 2 required
FeatureUsageAttributes
object
4 properties 4 required
ExternalRef
string
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-features-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API