Skip to content

Retrieve a product

Request

Retrieves a single product. The product is identified by the id path parameter.

Security
ZephrHmacHttp
Path
idstringrequired

Unique Product identifier.

cURL
curl -i -X GET \
  'https://demo.api.zephr.com/v3/products/{id}' \
  -H 'Authorization: ZEPHR-HMAC-* <YOUR_TOKEN_HERE>'

Responses

OK. Returns the product details.

Headers
any
Bodyapplication/json
tenantIdstring
Example:"company"
subTenantIdstring
Example:"company|demo"
idstring

The product ID/slug. This is the unique identifier for the product within the tenant.

Example:"gold"
labelstring

The product label. This is the human-readable name of the product.

Example:"Gold Subscription"
descriptionstring

The product description. This is a human-readable description of the product.

Example:"The most premium subscription."
entitlementobject(product.entitlement)
mappingobject(product.mapping)
Example:
{ "braintree_one_off": { "price_points": [ … ] } }
sharingLimitnumber

The number of other users that the purchaser of this product can share the product with.

Example:5
Response
{ "tenantId": "company", "subTenantId": "company|demo", "id": "gold", "label": "Gold Subscription", "description": "The most premium subscription.", "entitlement": { "id": "gold-bundle", "type": "bundle", "entitlementTenant": "company" }, "mapping": { "braintree_one_off": { … } }, "sharingLimit": 5 }