Sign in
Commerce

Retrieve a product by key

Retrieves detailed information about a specific product by its unique product number or ID. You can optionally specify related objects to expand in the request body.

post/commerce/products/{product_key}

Path parameters

product_keystring required

The unique number or ID of the product to be retrieved.

Headers

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request body

Response

OK

allowFeatureChangesboolean
categorystring

Product category, for example base or add_on.

contextFiltersobject[]
createdBystring

ID of the user who created the product.

createdTimestring date-time
customFieldsobject

Custom field values keyed by API name.

customObjectsobject nullable

Custom object references related to this product.

endDatestring date

Product effective end date.

featuresobject[]
idstring

Unique identifier of the product.

legacyFeaturesobject[]

Legacy, customer-defined feature objects retained for compatibility.

namestring

Product name.

netsuiteobject nullable

NetSuite integration metadata if applicable.

organizationLabelsobject[]
productNumberstring

System-generated product number.

skustring

Stock keeping unit for the product.

startDatestring date

Product effective start date.

statestring

Current product state.

updatedBystring

ID of the user who last updated the product.

updatedTimestring date-time

Timestamp of the last update.

Example response

{
  "allowFeatureChanges": false,
  "category": "base",
  "contextFilters": [],
  "createdBy": "53c162482f054f3ca08e1ec82dccfec9",
  "createdTime": "2025-10-13T07:44:55.000-07:00",
  "customFields": {},
  "customObjects": null,
  "dacTag": {
    "id": "1234567890abcdef",
    "name": "Example DAC Tag"
  },
  "endDate": "2050-12-31",
  "features": [],
  "id": "7228c9e6fd814e3a9e59bcdf0117e34f",
  "legacyFeatures": [],
  "name": "New prod",
  "netsuite": null,
  "organizationLabels": [],
  "productNumber": "PC-00000103",
  "productRatePlans": [
    {
      "id": "38660706ef2f48cfb5222f7dde491895",
      "createdBy": "53c162482f054f3ca08e1ec82dccfec9",
      "createTime": "2025-02-24T01:21:23.000+00:00",
      "updatedBy": "53c162482f054f3ca08e1ec82dccfec9",
      "updateTime": "2025-02-24T01:21:23.000+00:00",
      "name": "Bronze Plan",
      "displayName": "Bronze Plan",
      "description": "Basic version of our software service",
      "productId": "7228c9e6fd814e3a9e59bcdf0117e34f",
      "startDate": "2025-09-10",
      "endDate": "2027-01-01",
      "state": "active",
      "status": "ACTIVE",
      "activeCurrencies": [
        "USD"
      ],
      "productRatePlanNumber": "PRP-00000172",
      "productRatePlanCharges": [
        {
          "id": "fe9b0e764dca4178a11c0e471e5dc0d8",
          "productRatePlanChargeNumber": "PRPC-00000279",
          "name": "prepay_currency",
          "description": "Prepaid recurring software fee",
          "chargeType": "recurring",
          "chargeModel": "flat_fee",
          "listPriceBase": "Per_Billing_Period",
          "specificListPriceBase": 1,
          "triggerEvent": "contract_effective",
          "endDateCondition": "subscription_end",
          "upToPeriodsType": "billing_periods",
          "upToPeriods": 1,
          "billCycle": {
            "period": "bill_cycle_period_quarter",
            "periodAlignment": "align_to_term_start",
            "timing": "in_advance",
            "type": "term_start_day"
          },
          "pricing": {
            "flatAmounts": {
              "USD": 30
            },
            "tiers": []
          },
          "pricingSummary": [
            "USD30"
          ],
          "taxMode": "non_taxable",
          "taxable": false,
          "createdById": "53c162482f054f3ca08e1ec82dccfec9",
          "createdTime": "2025-02-24T01:21:23.000+00:00",
          "updatedById": "53c162482f054f3ca08e1ec82dccfec9",
          "updatedTime": "2025-02-24T01:21:23.000+00:00"
        }
      ]
    }
  ],
  "sku": "SKU-00000133",
  "startDate": "2024-01-01",
  "state": "product_active",
  "updatedBy": "53c162482f054f3ca08e1ec82dccfec9",
  "updatedTime": "2025-10-13T07:44:55.000-07:00"
}

Changes