Skip to main content

List an offering's features

GET 

https://euwest.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/features

List an offering's features

Request

Path Parameters

    offering_uuid UUIDrequired

    The unique identifier of the offering.

Query Parameters

    page[offset] int64

    Possible values: <= 10000

    The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

    page[limit] int64

    The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

Responses

Success. A list of subscription features attached to the offering is returned.

Schema
    data OfferingFeature[]
  • Array [
  • idUUID (string)

    The unique identifier.

    Example: 11111111-2222-3333-4444-555555555555
    typeSubscriptionOfferingFeatureType (string)required

    Possible values: [subscription_offering_feature]

    Example: subscription_offering_feature
    attributes FeatureResponseAttributes
    external_refExternalRef (string)

    A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.

    Possible values: <= 2048 characters

    Example: abc123
    namestringrequired

    The name of the feature.

    Possible values: >= 3 characters and <= 1024 characters

    Example: Digital library access
    descriptionstring

    The feature description to display to customers.

    Possible values: <= 1024 characters

    Example: Access to over 100 ebooks via the digital library.
    configuration objectrequired
    typerequired

    Possible values: [access, promotion, usage]

    tagFeatureTag (string)required

    A tag to add to the customer's account when entitled to the feature.

    Possible values: non-empty and <= 64 characters, Value must match regular expression ^[0-9A-Za-z_-]+$

    Example: digital_library_access
    relationships Relationships

    Relationships are established between different subscription entities. For example, a product and a plan are related to an offering, as both are attached to it.

    property name* Relationship
    anyOf
    meta FeatureMetarequired
    ownerstringrequired

    The owner of a resource, either store or organization.

    Example: store
    timestamps Timestampsrequired
    updated_atstringrequired

    The date and time a resource was updated.

    Example: 2017-01-10T11:41:19.244842Z
    created_atstringrequired

    The date and time a resource was created.

    Example: 2017-01-10T11:41:19.244842Z
  • ]
  • links object
    property name* Link
    anyOf
    stringnullable
    Example: http://example.com/articles/1/comments

Authorization: http

name: BearerTokentype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://euwest.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/features");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://euwest.api.elasticpath.com/v2
Auth
Parameters
— pathrequired
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!