Sign in
Commerce

Create a product with plans and charges

Create a product in the Product Catalog with one or more plans and charges. Charges can be usage (per-unit), recurring (flat fee), or other supported models.

post/commerce/products

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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-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.

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 (').

Request body

namestring required

Product name.

skustring

The stock keeping unit (SKU) associated with the product or invoice item.

product_numberstring

The product number that uniquely identifies the product in the product catalog.

start_datestring date required

Product effective start date (UTC, YYYY-MM-DD).

end_datestring date required

Product effective end date (UTC, YYYY-MM-DD).

category'base' | 'add_on' | 'other' required

Product category.

Example request

{
  "name": "New prod",
  "sku": "SKU-12345",
  "product_number": "PROD-001",
  "start_date": "2024-01-01",
  "end_date": "2050-12-31",
  "category": "base",
  "plans": [
    {
      "name": "Consumer Bronze Monthly 2",
      "start_date": "2024-01-01",
      "end_date": "2050-12-31",
      "active_currencies": [
        "USD"
      ],
      "charges": [
        {
          "name": "Data Usage Charge",
          "charge_type": "usage",
          "charge_model": "per_unit",
          "unit_of_measure": "Each",
          "list_price_base": "Per_Billing_Period",
          "default_quantity": 1,
          "min_quantity": 1,
          "max_quantity": 999999,
          "pricing": {
            "flat_amounts": {
              "USD": 100
            }
          },
          "bill_cycle": {
            "type": "default_from_customer",
            "period": "bill_cycle_period_month",
            "period_alignment": "align_to_charge",
            "timing": "in_arrears",
            "day_of_month": 5
          },
          "trigger_event": "contract_effective",
          "end_date_condition": "subscription_end",
          "up_to_periods_type": "billing_periods",
          "price_increase_percentage": 5,
          "price_change_option": "no_change",
          "use_tenant_default_for_price_change": true,
          "accounting": {
            "accounting_code": "PRPC-REV-001",
            "accounts_receivable_account": "Accounts Receivable",
            "adjustment_liability_account": "adjustL-1",
            "adjustment_revenue_account": "adjustRev-1",
            "contract_asset_account": "CA-2",
            "contract_liability_account": "CL-2",
            "contract_recognized_revenue_account": "Contract Recognized Revenue",
            "deferred_revenue_account": "Deferred Revenue",
            "recognized_revenue_account": "ContractRevRec-1",
            "unbilled_receivables_account": "unbilledR-1"
          }
        }
      ]
    }
  ]
}

Response

OK

idstring required

Unique identifier of the product.

namestring required

Product name.

categorystring required

Product category, for example, base or add-on.

descriptionstring

Free-form product description.

productNumberstring

The product number.

skustring

Stock keeping unit for the product.

startDatestring date required

Product effective start date, for example, UTC, YYYY-MM-DD.

endDatestring date required

Product effective end date, for example, UTC, YYYY-MM-DD.

statestring required

Current lifecycle state of the product.

allowFeatureChangesboolean

Whether feature changes are allowed for this product.

featuresobject[]

List of features associated with the product.

legacyFeaturesobject[]

Legacy feature list retained for backward compatibility.

contextFiltersobject[]

Context filter rules that may restrict product availability.

organizationLabelsobject[]

Key/value style organizational labels applied to the product.

customFieldsobject

Custom field values on the product.

customObjectsobject nullable

Custom object payloads linked to the product, if any.

dacTagsobject

Data access control or categorization tags for the product.

netsuiteobject nullable

NetSuite integration metadata (if present).

createdBystring

ID of the user who created the product.

createdTimestring date-time

Timestamp when the product was created.

updatedBystring

ID of the user who last updated the product.

updatedTimestring date-time

Timestamp when the product was last updated.

Example response

{
  "id": "7ec58fadb6f84bc18e59c7529058d941",
  "name": "New prod",
  "category": "base",
  "productNumber": "PC-00000105",
  "sku": "SKU-00000135",
  "startDate": "2024-01-01",
  "endDate": "2050-12-31",
  "state": "product_active",
  "createdBy": "53c162482f054f3ca08e1ec82dccfec9",
  "createdTime": "2025-10-17T04:02:54.621-07:00",
  "updatedBy": "53c162482f054f3ca08e1ec82dccfec9",
  "updatedTime": "2025-10-17T04:02:54.621-07:00",
  "plans": [
    {
      "id": "572a2efe711b449e80cbef94419bc050",
      "name": "Consumer Bronze Monthly",
      "startDate": "2024-01-01",
      "endDate": "2050-12-31",
      "state": "active",
      "status": "ACTIVE",
      "createTime": "2025-10-17T04:02:54.655-07:00",
      "updateTime": "2025-10-17T04:02:54.655-07:00",
      "createdBy": "53c162482f054f3ca08e1ec82dccfec9",
      "updatedBy": "53c162482f054f3ca08e1ec82dccfec9",
      "productId": "7ec58fadb6f84bc18e59c7529058d941",
      "productRatePlanNumber": "PRP-00000198",
      "productRatePlanCharges": [
        {
          "id": "42db6ead399a4521bae91b3af469c074",
          "name": "Flat PRPC",
          "chargeModel": "flat_fee",
          "chargeType": "recurring",
          "chargeFunction": "charge_function_standard",
          "productRatePlanChargeNumber": "PRPC-00000283",
          "productRatePlanId": "572a2efe711b449e80cbef94419bc050",
          "triggerEvent": "contract_effective",
          "endDateCondition": "subscription_end",
          "upToPeriodsType": "billing_periods",
          "listPriceBase": "Per_Billing_Period",
          "billCycle": {
            "type": "specific_day_of_month",
            "dayOfMonth": 5,
            "period": "bill_cycle_period_month",
            "periodAlignment": "align_to_charge",
            "timing": "in_advance"
          },
          "accounting": {
            "accountingCode": "PRPC-REV-001",
            "adjustmentLiabilityAccount": "adjustL-1",
            "adjustmentRevenueAccount": "adjustRev-1",
            "contractAssetAccount": "CA-2",
            "contractAssetAccountType": "ContractAsset",
            "contractLiabilityAccount": "CL-2",
            "contractRecognizedRevenueAccountType": "RecognizedRevenue",
            "deferredRevenueAccountType": "DeferredRevenue",
            "recognizedRevenueAccount": "ContractRevRec-1",
            "recognizedRevenueAccountType": "RecognizedRevenue",
            "unbilledReceivablesAccount": "unbilledR-1",
            "unbilledReceivablesAccountType": "UnbilledReceivables",
            "productRatePlanChargeId": "2c92c0f962470b8101624b869fcd45fc"
          },
          "prepayment": {
            "rolloverApply": "apply_last"
          },
          "prorationOption": "default_from_tenant_setting",
          "priceChangeOption": "no_change",
          "taxMode": "non_taxable",
          "useTenantDefaultForPriceChange": true,
          "createdById": "53c162482f054f3ca08e1ec82dccfec9",
          "createdTime": "2025-10-17T04:02:54.719-07:00",
          "updatedById": "53c162482f054f3ca08e1ec82dccfec9",
          "updatedTime": "2025-10-17T04:02:54.719-07:00",
          "pricing": {
            "flatAmounts": {
              "USD": 100
            }
          },
          "revenue": {
            "revenueRecognitionRuleName": "Recognize upon invoicing"
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.