Revision as of 17:49, 15 February 2013

GET /productSpecifications/{productSpecificationId}/offerings

Retrieves a list of product specification offerings.

Request

GET /productSpecifications/{productSpecificationId}/offerings

Response

Returns a list of product specification offerings for a particular product specification Id.

Status Code

200 OK

Success.

404 Not Found

Returned if the product specification Id could not be found.

Response Body

{
  [ 
    {
      "prices": "https://api.hostway.com/productspecifications/{productSpecificationId}/offerings/USD-3/prices",
      "currency": "USD",
      "default": 1,
      "billingPeriod": 3,
      "rules": "https://api.hostway.com/productspecifications/{productSpecificationId}/rules",
      "uri": "https://api.hostway.com/productspecifications/{productSpecificationId}/offerings/USD-3/"
    },
    {
      "prices": "https://api.hostway.com/productspecifications/{productSpecificationId}/offerings/USD-1/prices",
      "currency": "USD",
      "default": 0,
      "billingPeriod": 1,
      "rules": "https://api.hostway.com/productspecifications/{productSpecificationId}/rules",
      "uri": "https://api.hostway.com/productspecifications/{productSpecificationId}/offerings/USD-1/"
    },
    {
      "prices": "https://api.hostway.com/productspecifications/{productSpecificationId}/offerings/USD-12/prices",
      "currency": "USD",
      "default": 0,
      "billingPeriod": 12,
      "rules": "https://api.hostway.com/productspecifications/{productSpecificationId}/rules",
      "uri": "https://api.hostway.com/productspecifications/{productSpecificationId}/offerings/USD-12/"
    }
  ]
}
 

Parameters

prices - link

Hyperlink to the product's offerings prices.

currency - string

Offering currency.

default - integer

Specifies whether the billing cycle is the default for the given product and currency. Each currency will have its own default cycle. Allowed values are 0 and 1

billingPeriod - integer

Offering billing period in months.

rules - link

Hyperlink to the product's rules.

uri - link

Hyperlink to the specific product's offering

See also

• Product Catalog API
• Common Features