List an offering's products

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

List an offering's products

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

200

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

application/json

Schema

Schema

data OfferingProduct[]
Array [
id UUID (string)
The unique identifier.
type SubscriptionOfferingProductType (string)required
Possible values: [subscription_offering_product]
attributes ProductAttributesrequired
external_ref ExternalRef (string)
Possible values: <= 2048 characters
A unique attribute that you could use to contain information from another company system, for example. The maximum length is 2048 characters.
name stringrequired
Possible values: >= 3 characters and <= 1024 characters
The name of the product.
description string
Possible values: <= 1024 characters
The product or service description to display to customers.
sku string
Possible values: <= 1024 characters
A stock keeping unit for the product, if appropriate.
main_image uri
Possible values: <= 1024 characters
A URL from which an image or file for the product can be fetched. You can either upload your images and files to Commerce using the Commerce Files API or you can use your own content delivery network. If you are using the Commerce Files API, use Create a File to upload your file and return an HREF link in the response. An extensive range of media and file extensions are supported.
price Price
property name* object
The base price.
amount int64required
The value as a whole number of the currency's smallest subdivision.
includes_tax boolean
Indicates whether the amount includes any taxes.
price_units object
The timeframe during which the product price is applicable. For example, for a streaming service, the price is $12.99 and the unit is months and the amount is 1. In other words, the streaming service is available for $12.99 a month. You may want to specify a unit price if you have many products that all have different prices. Rather than having to create separate plans for each product, you can specify the timeframe during which the product price is applicable and then create one plan that determines the billing frequency for those products.
unit stringrequired
Possible values: [day, month]
A unit of time.
amount integerrequired
Possible values: >= 1
The number of days or months the period covers.
updated_at stringrequired
The date and time a resource was updated.
created_at stringrequired
The date and time a resource was created.
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.
anyOf
title
meta ProductMetarequired
display_price DisplayPrice
without_tax PriceFormatting
amount int64required
The unformatted amount for the objects.
currency stringrequired
The three-letter ISO currency code in uppercase, associated with a price.
formatted stringrequired
The formatted amount for the objects.
with_tax PriceFormatting
amount int64required
The unformatted amount for the objects.
currency stringrequired
The three-letter ISO currency code in uppercase, associated with a price.
formatted stringrequired
The formatted amount for the objects.
owner stringrequired
The owner of a resource, either store or organization.
timestamps Timestampsrequired
updated_at stringrequired
The date and time a resource was updated.
created_at stringrequired
The date and time a resource was created.
]
links object
anyOf
title

Example (from schema)

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "subscription_offering_product",
      "attributes": {
        "external_ref": "abc123",
        "name": "Magazine",
        "description": "A lovely magazine that is published every month.",
        "sku": "MAGAZINE1",
        "main_image": "https://magazine.com/cover.jpg",
        "price": {
          "USD": {
            "amount": 100,
            "includes_tax": false
          },
          "GBP": {
            "amount": 90,
            "includes_tax": true
          }
        },
        "price_units": {
          "unit": "day",
          "amount": 7
        },
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      },
      "relationships": {
        "plans": {
          "links": {
            "related": "/offerings/:offering-id/plans",
            "self": "/offerings/:offering-id"
          },
          "data": {
            "type": "offering-plan",
            "id": "625fe958-7b4b-40a0-a2c0-dbb8f31eec0d"
          }
        }
      },
      "meta": {
        "display_price": {
          "without_tax": {
            "amount": 100,
            "currency": "USD",
            "formatted": "$1.00"
          },
          "with_tax": {
            "amount": 110,
            "currency": "USD",
            "formatted": "$1.10"
          }
        },
        "owner": "store",
        "timestamps": {
          "updated_at": "2017-01-10T11:41:19.244842Z",
          "created_at": "2017-01-10T11:41:19.244842Z"
        }
      }
    }
  ],
  "links": {}
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

not-found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "No plan found"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Authorization: http

name: BearerTokentype: httpscheme: bearer

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://euwest.api.elasticpath.com/v2/subscriptions/offerings/:offering_uuid/products' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://euwest.api.elasticpath.com/v2

Auth

Bearer Token

Parameters

offering_uuid — pathrequired

page[offset] — query

page[limit] — query

ResponseClear

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