v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB

Products

Retrieve a product

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

get/v3/products/{id}

Path parameters

idstring required

Unique Product identifier.

Response

OK. Returns the product details.

tenantIdstring

subTenantIdstring

idstring

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

labelstring

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

descriptionstring

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

sharingLimitnumber

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

Example 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": {
      "price_points": [
        {
          "id": "ten",
          "label": "Ten Dollars",
          "price": 10
        }
      ]
    }
  },
  "sharingLimit": 5
}