--- title: "Return Market providers' products metadata" method: GET path: "/get_market_providers_product_metadata" tags: ["Market", "Product Management"] --- # Return Market providers' products metadata `GET /get_market_providers_product_metadata` This function lists all available cPanel Market providers' products and the attributes of each product that can be managed by an administrator. The return list includes different `attribute` data depending the `product_group` for each product.
Product Group Attributes Returned Description
ssl_certificate SSLMarketProviderMetaData Contains additional attributes only applicable to SSL Certificates
* MarketProviderMetaData Any products not in a product_group listed above will include only these attributes.
**Note:** The function does **not** return the `product_group` name. To get the `product_group` name for a `product_id`, run WHM API 1's [`get_market_providers_products`](https://go.cpanel.net/Market-get-market-providers-products) function. ## Response `200` HTTP Request was successful. - object - `data` object - `product_metadata` object[] - `attributes` union - MarketProviderMetaData - `display_name` object — Metadata information about the product's display name. - `read_only` unknown - `enabled` object — Metadata information about whether the product is enabled in the Market. - `read_only` unknown - `icon` object — Metadata information about the product's icon file. - `read_only` unknown - `icon_mime_type` object — Metadata information about the icon's mime type. - `read_only` unknown - `minimum_server_price` object — Metadata information about the minimum server price for the certificate. - `read_only` unknown - `price` object — Metadata information about the product's price. - `read_only` unknown - `price_unit` object — Metadata information about the product's price per unit. - `read_only` unknown - `product_description` object — Metadata information about the product's description. - `read_only` unknown - `product_group` object — Metadata information about the product's group label. - `read_only` unknown - `product_id` object — Metadata information about the product's ID. - `read_only` unknown - `recommended` object — Metadata information about whether the product is recommended. - `read_only` unknown - SSLMarketProviderMetaData - `display_name` object — Metadata information about the product's display name. - `read_only` unknown - `enabled` object — Metadata information about whether the product is enabled in the Market. - `read_only` unknown - `icon` object — Metadata information about the product's icon file. - `read_only` unknown - `icon_mime_type` object — Metadata information about the icon's mime type. - `read_only` unknown - `minimum_server_price` object — Metadata information about the minimum server price for the certificate. - `read_only` unknown - `price` object — Metadata information about the product's price. - `read_only` unknown - `price_unit` object — Metadata information about the product's price per unit. - `read_only` unknown - `product_description` object — Metadata information about the product's description. - `read_only` unknown - `product_group` object — Metadata information about the product's group label. - `read_only` unknown - `product_id` object — Metadata information about the product's ID. - `read_only` unknown - `recommended` object — Metadata information about whether the product is recommended. - `read_only` unknown - `x_identity_verification` object — Defines a schema for identity verification information for OV and EV certificates. - `read_only` unknown - `x_max_http_redirects` object — Information about the maximum number of HTTP redirections that the provider allows during a Domain Control Validation (DCV) check of the domain or domains in the certificate. - `read_only` unknown - `x_price_per_domain` object — Metadata information about the product's price per domain. - `read_only` unknown - `x_price_per_domain_maximum` object — Information about the maximum allowable price per domain for the certificate. - `read_only` unknown - `x_price_per_domain_minimum` object — Information about the minimum allowable price per domain for the certificate. - `read_only` unknown - `x_price_per_wildcard_domain` object — Information about the price per wildcard certificate. - `read_only` unknown - `x_price_per_wildcard_domain_maximum` object — Information about the maximum allowable price per wildcard certificate. - `read_only` unknown - `x_price_per_wildcard_domain_minimum` object — Information about the minimum allowable price per wildcard certificate. - `read_only` unknown - `x_ssl_per_domain_pricing` object — Metadata information about the product's pricing per domain. - `read_only` unknown - `x_supports_dns_dcv` object — Information about whether the product supports DNS-based DCV. - `read_only` unknown - `x_warn_after` object — Information about a length of time after which the cPanel interface will warn the user that there may be a problem with the order. - `read_only` unknown - `x_wildcard_parent_domain_free` object — Information about whether the provider includes the price of the parent domain in the price of a wildcard certificate. - `read_only` unknown - `product_id` string — The product's ID. - `provider_display_name` string — The cPanel Market provider's display name. - `provider_name` string — The cPanel Market provider's name. - `metadata` object - `command` string — The method name called. - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. - `result` 0 | 1 — * `1` - Success * `0` - Failed: Check the reason field for more details. - `version` integer — The version of the API function. --- [API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)