Sign in
Commerce

Create a product rate plan

Create a product rate plan (Plan) under an existing product. A plan includes one or more charges. Each charge must include:

  • name
  • charge_model
  • charge_type
  • bill_cycle
  • trigger_event
  • end_date_condition
  • pricing

Optional charge fields include: unit_of_measure, list_price_base, and accounting (with accounting_code, deferred_revenue_account, recognized_revenue_account).

post/commerce/plans

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

product_keystring required

The unique identifier of the product under which the plan is created.

namestring required

The name of the rate plan.

start_datestring date required

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

end_datestring date required

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

active_currenciesstring[] required

ISO currency codes enabled for this plan.

Example request

{
  "product_key": "6b14067136304e64b090daccae6680cb",
  "name": "New plan",
  "start_date": "2024-01-01",
  "end_date": "2049-12-31",
  "active_currencies": [
    "USD"
  ],
  "charges": [
    {
      "name": "Flat PRPC 1",
      "charge_model": "flat_fee",
      "charge_type": "recurring",
      "pricing": {
        "flat_amounts": {
          "USD": 100
        }
      },
      "bill_cycle": {
        "type": "specific_day_of_month",
        "day_of_month": 5,
        "period_alignment": "align_to_charge",
        "period": "bill_cycle_period_month",
        "timing": "in_advance"
      },
      "end_date_condition": "subscription_end",
      "trigger_event": "contract_effective",
      "accounting": {
        "accounting_code": "PRPC-REV-002",
        "accounts_receivable_account": "Accounts Receivable",
        "deferred_revenue_account": "Deferred Revenue",
        "recognized_revenue_account": "Recognized Revenue",
        "adjustment_liability_account": "adjustL-2",
        "adjustment_revenue_account": "adjustRev-2",
        "contract_asset_account": "CA-3",
        "contract_liability_account": "CL-3",
        "contract_recognized_revenue_account": "Contract Recognized Revenue",
        "unbilled_receivables_account": "unbilledR-2"
      }
    },
    {
      "name": "Flat PRPC 2",
      "charge_model": "flat_fee",
      "charge_type": "recurring",
      "pricing": {
        "flat_amounts": {
          "USD": 100
        }
      },
      "bill_cycle": {
        "type": "specific_day_of_month",
        "day_of_month": 5,
        "period_alignment": "align_to_charge",
        "period": "bill_cycle_period_month",
        "timing": "in_advance"
      },
      "end_date_condition": "subscription_end",
      "trigger_event": "contract_effective",
      "accounting": {
        "accounting_code": "PRPC-REV-002",
        "accounts_receivable_account": "Accounts Receivable",
        "deferred_revenue_account": "Deferred Revenue",
        "recognized_revenue_account": "Recognized Revenue",
        "adjustment_liability_account": "adjustL-2",
        "adjustment_revenue_account": "adjustRev-2",
        "contract_asset_account": "CA-3",
        "contract_liability_account": "CL-3",
        "contract_recognized_revenue_account": "Contract Recognized Revenue",
        "unbilled_receivables_account": "unbilledR-2"
      }
    }
  ]
}

Response

OK

idstring required

The unique identifier of the created plan (product rate plan).

namestring required

Plan display name.

displayNamestring

The display name of the plan.

descriptionstring

Free-form plan description.

statestring

Current lifecycle state of the plan.

startDatestring date required

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

endDatestring date required

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

activeCurrenciesstring[] required

ISO currency codes enabled for the plan.

createTimestring date-time

Timestamp when the plan was created.

updateTimestring date-time

Timestamp when the plan was last updated.

createdBystring

User ID that created the plan.

updatedBystring

User ID that last updated the plan.

productIdstring

The product ID (key) this plan belongs to.

productRatePlanNumberstring

Plan number

customFieldsobject

Custom field values on the plan.

attributesobject[]

Attribute metadata defined at the plan level (if any).

contextFiltersobject[]

Contextual filters used to limit plan applicability.

entitlementsobject[]

Entitlements included with the plan.

externalIdSourceSystemstring

Source system identifier for external integrations.

externalRateplanIdstring[]

External rate plan identifiers, if any.

organizationLabelsobject[]

Organization-level labels associated with the plan.

netsuiteobject nullable

NetSuite integration metadata (if present).

Example response

{
  "id": "ee2d1ce1036c4dd6ae9d6945565ff7a0",
  "name": "New plan",
  "state": "active",
  "startDate": "2024-01-01",
  "endDate": "2049-12-31",
  "activeCurrencies": [
    "USD"
  ],
  "createTime": "2025-10-13T07:46:02.314-07:00",
  "updateTime": "2025-10-13T07:46:02.314-07:00",
  "createdBy": "53c162482f054f3ca08e1ec82dccfec9",
  "updatedBy": "53c162482f054f3ca08e1ec82dccfec9",
  "productId": "7228c9e6fd814e3a9e59bcdf0117e34f",
  "productRatePlanNumber": "PRP-00000195",
  "productRatePlanCharges": [
    {
      "id": "ad95b694d2b8442b84dc8ad26561c7d7",
      "name": "Flat PRPC 1",
      "chargeModel": "flat_fee",
      "chargeType": "recurring",
      "chargeFunction": "charge_function_standard",
      "productRatePlanChargeNumber": "PRPC-00000279",
      "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"
      },
      "pricing": {
        "flatAmounts": {
          "USD": 100
        }
      },
      "priceChangeOption": "no_change",
      "prorationOption": "default_from_tenant_setting",
      "createdById": "53c162482f054f3ca08e1ec82dccfec9",
      "createdTime": "2025-10-13T07:46:02.375-07:00",
      "updatedById": "53c162482f054f3ca08e1ec82dccfec9",
      "updatedTime": "2025-10-13T07:46:02.375-07:00",
      "prepayment": {
        "rolloverApply": "apply_last"
      },
      "useTenantDefaultForPriceChange": true,
      "revenue": {
        "revenueRecognitionRuleName": "Recognize upon invoicing"
      }
    }
  ]
}

Changes