Update a product

OAuth

Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API.

You must first create an OAuth client in the Zuora UI before using the Create an OAuth token operation to create an OAuth token. See Authentication for more information.

Operations

Commerce

The Commerce APIs provide access to product catalog, plans, charges, and order management functionality in Zuora. These endpoints are used to create, update, and query product rate plans, charges, and dynamic pricing details that drive subscription and billing behavior.

In a typical use case, the Commerce APIs are called to provision new products or plans in the catalog, configure dimensional pricing, or submit orders that create and modify subscriptions.

Changes made with these APIs affect the product catalog and active subscriptions, depending on the endpoint. Catalog changes update future subscription behavior, while order operations directly impact customer subscriptions in real time.'

Operations

Create a product with plans and charges

Request

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.

Security

bearerAuth

Headers

Idempotency-Keystring<= 255 characters

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 Zuora Multi-Org 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<= 64 characters

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

Bodyapplication/jsonrequired

namestringrequired

Product name.

Example: "New prod"

skustring

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

Example: "SKU-12345"

product_numberstring

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

Example: "PROD-001"

start_datestring(date)required

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

Example: "2024-01-01"

end_datestring(date)required

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

Example: "2050-12-31"

categorystringrequired

Product category.

Enum"base""add_on""other"

Example: "base"

plansArray of objectsnon-emptyrequired

Product rate plans to create under the product.

plans[].namestringrequired

Rate plan name.

Example: "Consumer Bronze Monthly 2"

plans[].start_datestring(date)required

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

Example: "2024-01-01"

plans[].end_datestring(date)required

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

Example: "2050-12-31"

plans[].active_currenciesArray of stringsrequired

ISO currency codes enabled for this plan.

Example: ["USD"]

plans[].chargesArray of objectsnon-emptyrequired

Charges to create under this rate plan.

plans[].charges[].namestringrequired

Charge name.

Example: "Data Usage Charge"

plans[].charges[].charge_typestringrequired

Charge type.

Enum"one_time""recurring""usage"

Example: "usage"

plans[].charges[].charge_modelstringrequired

Charge model.

Enum"flat_fee""per_unit""overage""volume""tiered""tiered_overage""discount_fixed_amount""discount_percentage""custom_charge_model""delivery"

Example: "per_unit"

plans[].charges[].unit_of_measurestring

Unit of measure for per-unit or usage charges.

Example: "Each"

plans[].charges[].list_price_basestring

List price base for the charge.

Enum"Per_Billing_Period""Per_Month""Per_Week""Per_Year""Per_Specific_Months""Per_Validity_Period"

Example: "Per_Billing_Period"

plans[].charges[].default_quantitynumber

Default quantity for this charge on subscriptions created from the plan.

Example: 1

plans[].charges[].min_quantitynumber

Minimum quantity allowed for this charge. Equivalent to the MinQuantity field in the legacy v1 Product Rate Plan Charge.

Example: 1

plans[].charges[].max_quantitynumber

Maximum quantity allowed for this charge. Equivalent to the MaxQuantity field in the legacy v1 Product Rate Plan Charge.

Example: 999999

plans[].charges[].pricingFlat Fee Pricing (object) or Per Unit Pricing (object) or (Tiered or Volume Pricing (object)) or Fixed Amount Discount (object) or Percentage Discount (object)

Default (standard) pricing defined at the charge level. Provide exactly one structure per the charge model.

One of:

Default (standard) pricing defined at the charge level. Provide exactly one structure per the charge model.

plans[].charges[].bill_cycleobjectrequired

Billing configuration of the charge.

plans[].charges[].bill_cycle.typestringrequired

Determines how the billing day is selected for this charge.

Enum"default_from_customer""specific_day_of_month""subscription_start_day""charge_trigger_day""specific_day_of_week""term_start_day""term_end_day"

Example: "default_from_customer"

plans[].charges[].bill_cycle.periodstringrequired

Length of each billing period.

Enum"bill_cycle_period_month""bill_cycle_period_quarter""bill_cycle_period_semi_annual""bill_cycle_period_annual""bill_cycle_period_eighteen_months""bill_cycle_period_two_years""bill_cycle_period_three_years""bill_cycle_period_five_years""bill_cycle_period_specific_months""bill_cycle_period_subscription_term"

Example: "bill_cycle_period_month"

plans[].charges[].bill_cycle.period_alignmentstringrequired

How the billing period start aligns.

Enum"align_to_charge""align_to_subscription_start""align_to_term_start""align_to_term_end"

Example: "align_to_charge"

plans[].charges[].bill_cycle.timingstring

When the charge is billed relative to the service period.

Enum"in_advance""in_arrears"

Example: "in_arrears"

plans[].charges[].bill_cycle.day_of_monthinteger[ 1 .. 31 ]

Required if "type" is specific_day_of_month.

Example: 5

plans[].charges[].bill_cycle.day_of_weekstring

Used when "type" is specific_day_of_week.

Enum"sunday""monday""tuesday""wednesday""thursday""friday""saturday"

plans[].charges[].bill_cycle.specific_periodstring

Optional specific period value when period is bill_cycle_period_specific_months, bill_cycle_period_specific_weeks, or bill_cycle_period_specific_days. Equivalent to SpecificBillingPeriod in the legacy v1 API.

plans[].charges[].trigger_eventstringrequired

Event that triggers the charge.

Enum"contract_effective""service_activation""customer_acceptance""specific_date"

Example: "contract_effective"

plans[].charges[].end_date_conditionstringrequired

Defines when the charge ends.

Enum"subscription_end""end_date_one_time""fixed_period""specific_end_date"

Example: "subscription_end"

plans[].charges[].up_to_periods_typestring

Unit of time used when end_date_condition = fixed_period. Maps to the duration unit (billing periods, days, weeks, months, years).

Enum"billing_periods""days""weeks""months""years"

Example: "billing_periods"

plans[].charges[].up_to_periodsinteger

Number of periods used when end_date_condition = fixed_period.

Example: 0

plans[].charges[].overage_optionsobject

Configuration for overage smoothing and period-based overage calculation. Equivalent to NumberOfPeriod and related fields in the legacy v1 API.

plans[].charges[].price_increase_percentagenumber(double)

Percentage used when price_change_option is set to apply a specific percentage price increase. Equivalent to PriceIncreasePercentage (v1).

Example: 5

plans[].charges[].price_change_optionstring

Specifies how price changes are handled for future terms when this product or rate plan is amended. Equivalent to PriceChangeOption in the legacy v1 API. Examples include no_change, specific_percentage_value, or use_latest_product_catalog_pricing.

Enum"no_change""specific_percentage_value""use_latest_product_catalog_pricing"

Example: "no_change"

plans[].charges[].use_tenant_default_for_price_changeboolean

When true, uses the tenant-level default setting for price change behavior instead of the charge-level price_change_option. Equivalent to UseTenantDefaultForPriceChange in the legacy v1 API.

Example: true

plans[].charges[].discount_optionsobject

Discount configuration for discount charge models, including "Apply Discount To" and related settings.

plans[].charges[].accountingobject(AccountingRequest)

Accounting fields accepted on create/update requests. Field names use snake_case.

Conditional requirement rules

If Allow blank Accounting Codes = Yes → Accounting fields are optional.
If Allow blank Accounting Codes = No and the tenant has Zuora Revenue → all Accounting fields except accounting_code are required.
If Allow blank Accounting Codes = No and the tenant does NOT have Zuora Revenue → only recognized_revenue_account and deferred_revenue_account are required.

These rules apply to all operations that accept accounting in the payload.

Example: {"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"}

curl -i -X POST \
  https://developer.zuora.com/_mock/v1-api-reference/api/commerce/products \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Encoding: string' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Org-Ids: string' \
  -H 'Zuora-Track-Id: string' \
  -d '{
    "name": "New prod",
    "start_date": "2024-01-01",
    "end_date": "2050-12-31",
    "category": "base",
    "plans": [
      {
        "name": "Consumer Bronze Monthly",
        "start_date": "2024-01-01",
        "end_date": "2050-12-31",
        "active_currencies": [
          "USD"
        ],
        "charges": [
          {
            "name": "Flat PRPC",
            "charge_type": "recurring",
            "charge_model": "flat_fee",
            "default_quantity": 10,
            "min_quantity": 1,
            "max_quantity": 999999,
            "price_increase_percentage": 0,
            "price_change_option": "no_change",
            "use_tenant_default_for_price_change": true,
            "discount_options": {
              "discount_class": "",
              "discount_level": "rate_plan",
              "stacked_discount": false,
              "apply_to": [
                "one_time",
                "recurring",
                "usage"
              ],
              "apply_to_billing_period_partially": false,
              "reflect_discount_in_net_amount": false,
              "rollover": false,
              "specific_accounting_codes": false,
              "apply_details": []
            },
            "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"
            },
            "trigger_event": "contract_effective",
            "end_date_condition": "subscription_end",
            "up_to_periods_type": "billing_periods",
            "up_to_periods": 0,
            "list_price_base": "Per_Billing_Period",
            "specific_list_price_base": 0,
            "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"
            }
          }
        ]
      }
    ]
  }'

Responses

OK

Headers

Content-Encodingstring

Returned if Accept-Encoding: gzip is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain.

RateLimit-Limitstring

RateLimit-Remainingnumber

RateLimit-Resetnumber

Zuora-Request-Idstring= 36 characters

Zuora-Track-Idstring<= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-Typestring

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Bodyapplication/json

idstringrequired

Unique identifier of the product.

Example: "7ec58fadb6f84bc18e59c7529058d941"

namestringrequired

Product name.

Example: "New prod"

categorystringrequired

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

Example: "base"

descriptionstring

Free-form product description.

Example: ""

productNumberstring

The product number.

Example: "PC-00000105"

skustring

Stock keeping unit for the product.

Example: "SKU-00000135"

startDatestring(date)required

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

Example: "2024-01-01"

endDatestring(date)required

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

Example: "2050-12-31"

statestringrequired

Current lifecycle state of the product.

Example: "product_active"

allowFeatureChangesboolean

Whether feature changes are allowed for this product.

Example: false

featuresArray of objects

List of features associated with the product.

legacyFeaturesArray of objects

Legacy feature list retained for backward compatibility.

contextFiltersArray of objects

Context filter rules that may restrict product availability.

organizationLabelsArray of objects

Key/value style organizational labels applied to the product.

customFieldsobject

Custom field values on the product.

customObjectsobject or null

Custom object payloads linked to the product, if any.

Example: null

dacTagsobject

Data access control or categorization tags for the product.

netsuiteobject or null

NetSuite integration metadata (if present).

Example: null

createdBystring

ID of the user who created the product.

Example: "53c162482f054f3ca08e1ec82dccfec9"

createdTimestring(date-time)

Timestamp when the product was created.

Example: "2025-10-17T04:02:54.621-07:00"

updatedBystring

ID of the user who last updated the product.

Example: "53c162482f054f3ca08e1ec82dccfec9"

updatedTimestring(date-time)

Timestamp when the product was last updated.

Example: "2025-10-17T04:02:54.621-07:00"

plansArray of objects

Rate plans (PRPs) defined under this product.

property name*anyadditional property

Response

application/json

{
  "allowFeatureChanges": false,
  "category": "base",
  "contextFilters": [],
  "createdBy": "53c162482f054f3ca08e1ec82dccfec9",
  "createdTime": "2025-10-17T04:02:54.621-07:00",
  "customFields": {},
  "customObjects": null,
  "description": "",
  "endDate": "2050-12-31",
  "features": [],
  "id": "7ec58fadb6f84bc18e59c7529058d941",
  "legacyFeatures": [],
  "name": "New prod",
  "netsuite": null,
  "organizationLabels": [],
  "plans": [
    { … }
  ],
  "productNumber": "PC-00000105",
  "sku": "SKU-00000135",
  "startDate": "2024-01-01",
  "state": "product_active",
  "updatedBy": "53c162482f054f3ca08e1ec82dccfec9",
  "updatedTime": "2025-10-17T04:02:54.621-07:00"
}

Update a product

Request

Updates an existing product in the Product Catalog. Use this API to update core product fields such as name, description, category, effective dates, and custom fields.

Security

bearerAuth

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<= 64 characters

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 Zuora Multi-Org 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.

Bodyapplication/jsonrequired

idstringrequired

Unique identifier of the product to update.

Example: "8ad088009840d1c2019855e15c993f2f"

namestring

Product name.

Example: "Software Service"

descriptionstring

Product description.

Example: "Software service - basic edition"

categorystring

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

Example: "base"

custom_fieldsobject

Custom fields to set on the product. Keys must match configured custom field API names. Values may be strings, numbers, booleans, or arrays depending on field definition.

Example: {"HelloBay__c":"Updated value","Tags__c":["AI Powered","Internet Required"]}

startDatestring(date)

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

Example: "2025-05-11"

endDatestring(date)

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

Example: "2050-12-10"

curl -i -X PUT \
  https://developer.zuora.com/_mock/v1-api-reference/api/commerce/products \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Encoding: string' \
  -H 'Content-Type: application/json' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Org-Ids: string' \
  -H 'Zuora-Track-Id: string' \
  -d '{
    "id": "8ad088009840d1c2019855e15c993f2f",
    "name": "Software Service",
    "description": "Software service - basic edition",
    "category": "base",
    "custom_fields": {
      "HelloBay__c": "Updated value",
      "Tags__c": [
        "AI Powered",
        "Internet Required"
      ]
    },
    "startDate": "2025-05-11",
    "endDate": "2050-12-10"
  }'

Responses

OK

Headers

Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring= 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring<= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Bodyapplication/json

idstring

Unique identifier of the product.

Example: "00c86e3a0595442c88ed9ef8474b10a7"

namestring

Product name.

Example: "Amadeus"

descriptionstring

Product description.

Example: "Software service - basic edition"

categorystring

Product category label.

Example: "base"

productNumberstring

Product number in the catalog.

Example: "PC-00000095"

skustring

Product SKU.

Example: "SKU-00000122"

startDatestring(date)

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

Example: "2024-01-08"

endDatestring(date)

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

Example: "2050-12-31"

statestring

Current product state.

Example: "product_active"

allowFeatureChangesboolean

Whether features on this product can be changed.

Example: false

featuresArray of objects

Product features.

legacyFeaturesArray of objects

Legacy features associated with this product.

contextFiltersArray of objects

Context filters applied to the product.

customFieldsobject

Custom fields on the product.

customObjectsobject or null

Custom objects linked to this product.

netsuiteobject or null

Netsuite integration attributes.

organizationLabelsArray of strings

Organization labels for the product.

productRatePlansArray of objects

Rate plans (PRPs) defined under the product.

createdBystring

ID of the user who created the product.

Example: "8a90a2fd8030ea2e018032b11d3a3f06"

createdTimestring(date-time)

Timestamp when the product was created.

Example: "2025-08-06T18:11:35.000-07:00"

updatedBystring

ID of the user who last updated the product.

Example: "53c162482f054f3ca08e1ec82dccfec9"

updatedTimestring(date-time)

Timestamp when the product was last updated.

Example: "2025-10-23T04:55:54.000-07:00"

Response

application/json

{
  "allowFeatureChanges": false,
  "category": "base",
  "contextFilters": [],
  "createdBy": "8a90a2fd8030ea2e018032b11d3a3f06",
  "createdTime": "2025-08-06T18:11:35.000-07:00",
  "customFields": {},
  "customObjects": null,
  "description": "Software service - basic edition",
  "endDate": "2050-12-31",
  "features": [],
  "id": "00c86e3a0595442c88ed9ef8474b10a7",
  "legacyFeatures": [],
  "name": "Amadeus",
  "netsuite": null,
  "organizationLabels": [],
  "productNumber": "PC-00000095",
  "productRatePlans": [],
  "sku": "SKU-00000122",
  "startDate": "2024-01-08",
  "state": "product_active",
  "updatedBy": "53c162482f054f3ca08e1ec82dccfec9",
  "updatedTime": "2025-10-23T04:55:54.000-07:00"
}

Create a product rate plan

Request

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

Security

bearerAuth

Headers

Idempotency-Keystring<= 255 characters

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 Zuora Multi-Org 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<= 64 characters

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

Bodyapplication/jsonrequired

product_keystringrequired

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

Example: "6b14067136304e64b090daccae6680cb"

namestringrequired

The name of the rate plan.

Example: "New plan"

start_datestring(date)required

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

Example: "2024-01-01"

end_datestring(date)required

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

Example: "2049-12-31"

active_currenciesArray of stringsnon-emptyrequired

ISO currency codes enabled for this plan.

Example: ["USD"]

chargesArray of objectsnon-emptyrequired

The list of product rate plan charges to create under the plan.

Example: [{"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"}}]

charges[].namestringrequired

The name of the charge.

Example: "Flat PRPC 1"

charges[].charge_modelstringrequired

Charge model that defines how pricing is calculated.

Enum"flat_fee""per_unit""overage""volume""tiered""tiered_overage""discount_fixed_amount""discount_percentage""custom_charge_model""delivery"

Example: "flat_fee"

charges[].charge_typestringrequired

Charge type (recurring, usage, or one-time).

Enum"one_time""recurring""usage"

Example: "recurring"

charges[].unit_of_measurestring

Unit of measure for per-unit or usage charges.

Example: "Each"

charges[].list_price_basestring

Optional list price base, if supported by the charge model.

Enum"Per_Billing_Period""Per_Month""Per_Week""Per_Year""Per_Specific_Months""Per_Validity_Period"

Example: "Per_Billing_Period"

charges[].specific_list_price_basenumber(double)

Optional specific value used when list_price_base requires an explicit quantity (for example, number of months for Per_Specific_Months).

Example: 0

charges[].pricingFlat Fee Pricing (object) or Per Unit Pricing (object) or (Tiered or Volume Pricing (object)) or Fixed Amount Discount (object) or Percentage Discount (object)required

Defines the pricing for the charge. Provide exactly one structure per charge model.

One of:

Defines the pricing for the charge. Provide exactly one structure per charge model.

charges[].pricing.flat_amountsobjectrequired

Map of currency to flat amount.

Example: {"USD":100}

charges[].pricing.flat_amounts.property name*numberadditional property

charges[].bill_cycleobjectrequired

Defines how billing occurs for this charge.

charges[].bill_cycle.typestringrequired

Determines how the billing day is selected for this charge.

Enum"default_from_customer""specific_day_of_month""subscription_start_day""charge_trigger_day""specific_day_of_week""term_start_day""term_end_day"

Example: "specific_day_of_month"

charges[].bill_cycle.day_of_monthinteger[ 1 .. 31 ]

Required "when type is specific_day_of_month".

Example: 5

charges[].bill_cycle.day_of_weekstring

Used "when type is specific_day_of_week".

Enum"sunday""monday""tuesday""wednesday""thursday""friday""saturday"

charges[].bill_cycle.periodstringrequired

Billing period length.

Enum"bill_cycle_period_month""bill_cycle_period_quarter""bill_cycle_period_semi_annual""bill_cycle_period_annual""bill_cycle_period_eighteen_months""bill_cycle_period_two_years""bill_cycle_period_three_years""bill_cycle_period_five_years""bill_cycle_period_specific_months""bill_cycle_period_subscription_term"

Example: "bill_cycle_period_month"

charges[].bill_cycle.period_alignmentstringrequired

How the billing period start aligns.

Enum"align_to_charge""align_to_subscription_start""align_to_term_start""align_to_term_end"

Example: "align_to_charge"

charges[].bill_cycle.timingstring

When the charge is billed relative to the service period.

Enum"in_advance""in_arrears"

Example: "in_advance"

charges[].end_date_conditionstringrequired

Defines when the charge ends.

Enum"subscription_end""end_date_one_time""fixed_period""specific_end_date"

Example: "subscription_end"

charges[].up_to_periods_typestring

Granularity used with end_date_condition = fixed_period to express how long the charge remains active. When end_date_condition = subscription_end, this field is ignored.

Enum"billing_periods""days""weeks""months""years"

Example: "billing_periods"

charges[].up_to_periodsinteger(int32)

Number of periods used with end_date_condition = fixed_period. Combined with up_to_periods_type to determine the fixed duration of the charge. Ignored when end_date_condition = subscription_end.

Example: 0

charges[].trigger_eventstringrequired

Event that triggers the charge.

Enum"contract_effective""service_activation""customer_acceptance""specific_date"

Example: "contract_effective"

charges[].accountingobject(AccountingRequest)

Accounting fields accepted on create/update requests. Field names use snake_case.

Conditional requirement rules

If Allow blank Accounting Codes = Yes → Accounting fields are optional.
If Allow blank Accounting Codes = No and the tenant has Zuora Revenue → all Accounting fields except accounting_code are required.
If Allow blank Accounting Codes = No and the tenant does NOT have Zuora Revenue → only recognized_revenue_account and deferred_revenue_account are required.

These rules apply to all operations that accept accounting in the payload.

Example: {"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"}

curl -i -X POST \
  https://developer.zuora.com/_mock/v1-api-reference/api/commerce/plans \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Encoding: string' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Org-Ids: string' \
  -H 'Zuora-Track-Id: string' \
  -d '{
    "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"
        },
        "end_date_condition": "subscription_end",
        "up_to_periods_type": "billing_periods",
        "up_to_periods": 0,
        "list_price_base": "Per_Billing_Period",
        "specific_list_price_base": 0,
        "trigger_event": "contract_effective",
        "accounting": {
          "accounting_code": "PRPC-REV-001",
          "accounts_receivable_account": "Accounts Receivable",
          "deferred_revenue_account": "Deferred Revenue",
          "recognized_revenue_account": "Recognized Revenue",
          "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",
          "unbilled_receivables_account": "unbilledR-1"
        }
      },
      {
        "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"
        },
        "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"
        }
      }
    ]
  }'

Responses

OK

Headers

Content-Encodingstring

Returned if Accept-Encoding: gzip is specified and the response exceeds 1000 bytes. Supported MIME types: application/json, application/xml, text/html, text/csv, text/plain.

RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits docs.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits docs.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to exhaustion. See rate limits docs.

Zuora-Request-Idstring= 36 characters

The Zuora internal identifier of the API call.

Zuora-Track-Idstring<= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Concurrency-Limit-Typestring

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Bodyapplication/json

idstringrequired

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

Example: "ee2d1ce1036c4dd6ae9d6945565ff7a0"

namestringrequired

Plan display name.

Example: "New plan"

displayNamestring

The display name of the plan.

Example: ""

descriptionstring

Free-form plan description.

Example: ""

statestring

Current lifecycle state of the plan.

Example: "active"

startDatestring(date)required

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

Example: "2024-01-01"

endDatestring(date)required

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

Example: "2049-12-31"

activeCurrenciesArray of stringsrequired

ISO currency codes enabled for the plan.

Example: ["USD"]

createTimestring(date-time)

Timestamp when the plan was created.

Example: "2025-10-13T07:46:02.314-07:00"

updateTimestring(date-time)

Timestamp when the plan was last updated.

Example: "2025-10-13T07:46:02.314-07:00"

createdBystring

User ID that created the plan.

Example: "53c162482f054f3ca08e1ec82dccfec9"

updatedBystring

User ID that last updated the plan.

Example: "53c162482f054f3ca08e1ec82dccfec9"

productIdstring

The product ID (key) this plan belongs to.

Example: "7228c9e6fd814e3a9e59bcdf0117e34f"

productRatePlanNumberstring

Plan number

Example: "PRP-00000195"

customFieldsobject

Custom field values on the plan.

attributesArray of objects

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

contextFiltersArray of objects

Contextual filters used to limit plan applicability.

entitlementsArray of objects

Entitlements included with the plan.

externalIdSourceSystemstring

Source system identifier for external integrations.

Example: ""

externalRateplanIdArray of strings

External rate plan identifiers, if any.

organizationLabelsArray of objects

Organization-level labels associated with the plan.

netsuiteobject or null

NetSuite integration metadata (if present).

Example: null

productRatePlanChargesArray of objects

Charges created under this plan.

property name*anyadditional property

Response

application/json

{
  "activeCurrencies": [
    "USD"
  ],
  "attributes": [],
  "contextFilters": [],
  "createTime": "2025-10-13T07:46:02.314-07:00",
  "createdBy": "53c162482f054f3ca08e1ec82dccfec9",
  "customFields": {},
  "description": "",
  "displayName": "",
  "endDate": "2049-12-31",
  "entitlements": [],
  "externalIdSourceSystem": "",
  "externalRateplanId": [],
  "id": "ee2d1ce1036c4dd6ae9d6945565ff7a0",
  "name": "New plan",
  "netsuite": null,
  "organizationLabels": [],
  "productId": "7228c9e6fd814e3a9e59bcdf0117e34f",
  "productRatePlanCharges": [
    { … }
  ],
  "productRatePlanNumber": "PRP-00000195",
  "startDate": "2024-01-01",
  "state": "active",
  "updateTime": "2025-10-13T07:46:02.314-07:00",
  "updatedBy": "53c162482f054f3ca08e1ec82dccfec9"
}

Accounts

Some operations in this section are similar to each other, but are provided for different use scenarios. You should choose the one that best suits your needs.

For example, the Retrieve an account operation retrieves the basic information of an account, such as bill-to and sold-to contacts, billing and payments setup information, and metrics data for the account.

The Retrieve an account summary operation returns the more detailed information of an account, such as bill-to and sold-to contacts, subscriptions, invoices, payments, and usages associated with this account.

Operations

Contacts

A contact defines the customer who holds an account or who is otherwise a person to contact about an account. An account requires a contact for the BillToId and SoldToId fields before the account can be active.

Operations

Contact Snapshots

Every time a contact is updated a snapshot is taken.

Operations

Sign Up

A light-weight API to sign up customers and subscribe.

You need to have the Orders or Orders Harmonization feature enabled to use this API.

Operations

Orders

Orders are contractual agreements between merchants and customers.

You can create multiple subscriptions and subscription amendments at once in a single order. All the operations on subscriptions in orders are done by order actions. You can also create order line items to support your non-subscription based business models.

Zuora calculates order delta metrics when orders take place. You can retrieve order delta metrics and measure billed and unbilled amounts by order.

For more information about Orders, see Overview Of Orders. To learn how orders interacts with billing accounts, subscriptions, and product catalog, see Zuora object model.

Operations

Order Actions

You need to have the Orders or Orders Harmonization feature enabled to use this API.

Operations

Order Line Items

Use order line item to launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. For more information about order line items, see Order Line Items.

Operations

Fulfillments

Fulfillments are subordinate objects attached to their related order line item. Fulfillment items are subordinate objects attached to their related fulfillment.

For more information, see Overview of Order Line Items.

Operations

Ramps

A Ramp is a time container to associate with rate plan charges in your subscription. Inside the Ramp, you can further define a set of Ramp Intervals (time-based periods) where products or pricing can change. These periods are sub time containers to enable you to report out-of-the-box metrics based on Ramp Intervals.

Notes: You must have both the Ramps feature and Orders feature enabled for your tenant to use the Ramps operations.

For more information, see Ramps and Ramp Metrics.

Operations

Subscriptions

A subscription is a product or service that has recurring charges, such as a monthly flat fee or charges based on usage. Subscriptions can also include one-time charges, such as activation fees. Every subscription must be associated with an account. At least one active account must exist before any subscriptions can be created.

For more information, see Subscriptions.

Operations

Omnichannel Subscriptions

An omnichannel subscription is a subscription originating from external and source systems, such as the Apple App Store, Google Play Store, and Roku Store.

To create, update, delete, or retrieve an omnichannel subscription, you must turn on the Omni-Channel Subscription feature. For more information, see Omni-Channel Subscription.

Operations

Subscription Change History

The change histories of single version subscriptions.

Note: To access the change histories, you must turn on the following features:

Operations

Rate Plans

A rate plan is part of a subscription or an amendment to a subscription, and it comes from a product rate plan. Like a product and its product rate plans, a subscription can have one or more rate plans. Rate plans are sometimes called subscription rate plans. Rate plans that are part of an amendment are sometimes called amendment rate plans.

Rate plans represent a price or a collection of prices for a service you sell. An individual rate plan contains all charges specific to a particular subscription.

Operations

Commitments

A commitment represents a minimum or maximum spend amount a customer is obligated to pay within a spend period, compared with customer's actual fees incurred in connection with customer's accounts and their use of applicable products. The Commitments API allows you to retrieve details of the commitments a customer has.

Operations

Prepaid with Drawdown

The Prepaid with Drawdown feature is a pricing model for consumption-based services, such as data storage. Under this model, customers pay upfront to receive a number of units, usually for a period of time like a month or a year. Then they consume against that prepayment balance in a use-it-or-lose-it fashion, with a possibility of topping up more units or being charged for any overage. This model strikes a balance between upfront commitment and the pure pay-as-you-go pricing models. For more information, see Prepaid with Drawdown.

Operations

Usage

Consumption of a billable service or resource (such as database storage space or bundles of emails sent) provides the basis for some charge models - simple usage, tiered pricing, or volume pricing. To make this work, usage must be tracked in the system and usage charges must be calculated and invoiced. Usage is always billed in arrears - for example, you might bill customers in February for their January usage. Usage can be billed on a recurring monthly, quarterly, semi-annual, or annual basis.

Operations

Meters

The Zuora Mediation APIs provide a comprehensive set of endpoints to manage, test, run, and monitor usage meters. These APIs support actions such as running or testing specific meter versions, importing and exporting meter configurations, managing input files, performing event store operations, and ingesting usage data in real time via streaming. All APIs follow a consistent response structure to simplify integration and error handling. Use these APIs to automate and streamline your usage processing pipeline—from data ingestion to transformation and billing.

Operations

Delivery Adjustments

Delivery Adjustments are used to handle end customer delivery complaints for the Delivery Pricing charge model. For more information, see Delivery Adjustments.

Operations

Billing Documents

Billing documents include invoices, credit memos, and debit memos.

Note: Credit memos and debit memos are only available if you have the Invoice Settlement feature enabled.

Operations

Invoices

Invoices provides information about customers' accounts for invoices, for examples, dates, status, and amounts.

For more information about invoices, see Invoice.

Operations

Credit Memos

Credit memos reduce invoice and account balances. By applying one or more credit memos to invoices with positive balances, you can reduce the invoice balances in the same way that applying a payment to an invoice.

For more information about credit memos, see Credit and debit memos.

Operations

Debit Memos

Debit memos increase the amount a customer owes. It is a separate document from the invoice. Debit memos can be used to correct undercharging on an invoice or to levy ad hoc charges outside the context of a subscription. Just like an invoice, debit memo balances can be settled by applying either a payment or a credit memo.

For more information about debit memos, see Credit and debit memos.

Operations

E-Invoicing

With the E-Invoicing feature, Zuora supports electronic invoices through an integration with partners that have a local presence, where required, which guarantees compliance with local invoice regulations.

All the operations in this section are available only if you have the E-Invoicing feature enabled.

Operations

Invoice Schedules

Use invoice schedules to trigger invoice generation processes.

For more information about invoice schedules, see Billing Schedule overview.

Operations

Taxation Items

The TaxationItem object is used to add a tax amount to an invoice item. In the typical use case, the tax amount that you specify in the object is calculated by Z-Tax or a third-party tax engine such as Avalara or Connect tax engine.

Changes that you make with this object affect the product charges in your product catalog, but not the charges in existing subscriptions.

Operations

Sequence Sets

You can create billing document sequence sets through the REST API or the Zuora UI, allowing distinct numbering sequences for billing documents, payments, and refunds.

To create a billing document sequence set through the Zuora UI, see Create Billing Document Sequence Sets for more information.

Operations

Use operations to generate invoices and credit memos, collect payments for posted invoices, and generate previews of future invoice items for customer accounts.

Operations

Summary Statements

The Summary Statement feature provides a comprehensive overview of billing activities for each account using HTML templates that compile data like invoices, credit memos, payments, and more. The associated APIs help automate the creation and management of these statements. See Account Summary Statements for more information.

Operations

Bill Run

Use the Bill Run call to create ad hoc bill runs and Post, Cancel, Query, and Delete bill runs.

For more information about bill runs, see Bill runs.

Operations

Billing Preview Run

A billing preview run asynchronously generates a downloadable CSV file containing a preview of future invoice item data and credit memo item data for a batch of customer accounts.

Note: Credit memo item data is only available if you have the Invoice Settlement feature enabled.

Operations

Payment Methods

Payment methods represents payment method details associated with a customer account.

Operations

Custom Payment Method Types

Open Payment Method (OPM) service is a framework developed by Zuora, which allows you to integrate your custom payment method to Zuora subscription, billing, and revenue management in a dynamic and flexible manner. With the support of the OPM service, you are able to define your custom payment method types and create custom payment methods of the defined types. The custom payment method of the defined type can only be used with the custom payment gateway that you set up through the Universal Payment Connector (UPC) service. It cannot be used with the Zuora out-of-box gateway integrations such as GoCardless, Stripe, etc.

You can define up to 20 custom payment method types for one tenant. Do not define your fields with the Zuora-reserved fields.

See Set up custom payment gateways and payment methods for more information about the OPM and UPC services.

Note: You can only use the bearer token to access the "Custom Payment Method Types" API operations. Access with apiAccessKeyId and apiSecretAccessKey is not supported.

Operations

Payment Method Updater

Zuora Payment Method Updater (PMU) enables merchants to automatically incorporate changes made to a customer's credit cards. For more information about Zuora PMU, see Payment Method Updater.

Operations

Payment Method Snapshots

A Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Snapshot continues to retain the data used in each of the past transactions. As such, the Snapshot helps with display of historical transactions, integrations to external systems, and reporting.

Operations

Payment Method Transaction Logs

The PaymentMethodTransactionLog object contains payment method transaction log data.

You can use the CRUD: Retrieve a payment method transaction log operation to export such data.

Operations

Hosted Pages

Hosted payment pages allow your customers to set up a payment method, such as providing a credit card. Since it only handles the payment method, it is suitable for a simple workflow or a complex multi-page, multi-product workflow.

For more information, see Hosted Payment Pages.

Operations

RSA Signatures

The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature.

You can use the Generate an RSA signature operation to generate the required digital signature and token for a Payment Pages 2.0 form, then use the Decrypt an RSA signature operation to decrypt the signature to validate the signature and key."

Operations

Payment Authorization

The Delayed Capture feature allows you to authorize the availability of funds for a transaction but delay the capture of funds until a later time.

You can use the Create authorization operation to authorize a payment amount before capturing the payment. Subsequently, you can use Create a payment or Create an order to capture the authorized funds, or use Cancel authorization to cancel the authorization.

Operations

Payment Gateways

Use payment gateways to pass authorization, payments, and settlement data securely to and from the merchant's website to the merchant's processor.

For more information about payment gateways, see Payment Gateways.

Operations

Payment Gateway Reconciliation

Gateway reconciliation is the process of verifying that the electronic payment and refund transactions processed in Zuora match the transactions reported by the gateway. For example, if Zuora processed 200 transactions through a gateway, you should see the same number of transactions on the gateway's reconciliation report, sometimes also called the settlement report.

You can complete the following Gateway Reconciliation tasks through API:

Operations

Payments

Use payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds. For more information about payments, see Payments.

Operations

Payment Transaction Logs

Use payment transaction logs to export logs of all transactions from Zuora to the Gateway for Payments.

Operations

Payment Runs

Use payment runs to collect payments using electronic payment methods, for example, credit cards and ACH. For more information about payment runs, see Payment Runs.

Operations

Payment Schedules

Use payment schedules to split invoice or account balances into several installments and automatically process payments for the installments. For more information about payment schedules, see Payment Schedules.

Operations

Refunds

Zuora allows you to issue and track refunds on payments. Similar to external payments, users can enter external refunds to track refunds that have been performed outside of Zuora Payments (for example, by issuing a check). In addition, you can make electronic refunds using our supported payment gateways, which will automatically refund money to the customer.

Operations

Payment Profiles

Payment profiles enable payment flexibility for subscribers by allowing payment methods to be associated with specific subscriptions.

To learn more about the configuration and usage of Payment Profiles, see Payment Profiles.

Operations

Configurable Payment Retry

Configurable Payment Retry APIs use basic authentication. The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry. Click the drop-down arrow at the end of an endpoint to display the full endpoint. To learn more about the configuration and usage of Configurable Payment Retry, see Configurable Payment Retry.

Operations

Object Queries

The Object Query API contains GET operations that allow you to query objects in your Zuora tenant in an efficient, consistent, and flexible manner.

With the expand[] and filter[] query parameters, you have the flexibility to retrieve related object information in a single call and define the returned response that best suits your needs. You can also use the fields[] query parameter to define which fields are returned in the response for a given object. The sort[] query parameter allows you to sort the results in ascending or descending order based on the specified field.

These parameters are case-insensitive matching.

For general Object Queries limitations and comprehensive introduction to these query parameters, see Expand, filter, fields, and sort.

For filterable, expandable, and sortable fields on each object, refer to the Query Parameters section for each API operation.

Operations

Accounting Codes

Accounting Codes are commonly referred to as General Ledger Accounts or General Ledger Account Codes. In Zuora, the use of accounting codes are optional but recommended.

This section contains the operations that allow you to create, update, get, delete, activate, or deactivate accounting codes in Zuora.

Operations

Accounting Periods

A key step in configuring Finance is to create accounting periods in Zuora to match your company's financial calendar. This allows Zuora to produce reports and data exports organized by accounting periods, and to perform the work of closing the accounting periods for the revenue sub-ledger.

Operations

Summary Journal Entries

A summary journal entry is a summary of Zuora transaction amounts organized by accounting code and general ledger segments. A segment adds more reporting granularity through business dimensions, such as country or product.

For more information, see Summary Journal Entries Introduction

Operations

Journal Runs

Use journal runs to automatically create summary journal entities that are suitable for importing into your general ledger system.

For more information about journal runs, see Journal Runs.

Operations

Mass Updater

Use mass updater to perform mass actions more easily.

For more information about mass updater, see Mass Updater.

Operations

Notifications

Notifications are the actions taken to inform users or call third-party endpoints when a certain event happens. Typical actions include emails and callouts. Callouts typically refer to HTTP invocations, such as HTTP calls to REST services.

Zuora notification system processes the events in the same order in which they are triggered. The timing and delivery of notifications can still vary based on factors such as retries, concurrency, and network latency. But Zuora guarantees the best performance possible with the right performance boosters and tuning.

Notifications are associated with Communication Profiles, which allow you to send specific event-driven notifications to targeted customers. Zuora provides the following Settings API to access the settings of Communication Profiles:* Get all Communication Profiles

Operations

Custom Event Triggers

The Event Trigger service manages the business events and trigger conditions that are defined on Zuora Business Object Model or custom objects. When a Zuora object changes, the trigger conditions defined on the object are evaluated, and if any condition qualifies, a business event will be triggered and turned into a notification.

Note: Event Triggers operations are only applicable to custom events.

Operations

Custom Scheduled Events

A custom scheduled event notification is evaluated at the scheduled time of the related scheduled event on a daily basis. If the date meets the combination of the base field and the notification parameters, the notification will be triggered immediately.

For more information about Custom Scheduled Events, see Custom Scheduled Events.

Operations

Custom Object Definitions

With Custom Objects service, you can define custom objects, extending the Zuora data model to accommodate your specific use cases.

If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works.

You can sign up for a free account on the Postman website and download the app in case you do not use Postman yet.

Note that the Custom Object Definitions API is versioned by Zuora-Version in the request header. The response may be different for the same request with a different API version. Specify Zuora-Version in the request header if you expect a specific response schema.

Operations

Custom Object Records

With Custom Objects service, you can create, update, delete and find custom object records.

If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works.

You can sign up for a free account on the Postman website and download the app in case you do not use Postman yet.

Note that the Custom Object Records API is versioned by Zuora-Version in the request header. The response may be different for the same request with a different API version. Specify Zuora-Version in the request header if you expect a specific response schema.

Operations

Custom Object Jobs

With Custom Objects service, you can submit a bulk job request to create, update, or delete custom object records in a batch.

If you use Postman, you can import the custom objects endpoints as a collection into your Postman app and try out different requests to learn how the API works.

You can sign up for a free account on the Postman website and download the app in case you do not use Postman yet.

Note that the Custom Object Jobs API is versioned by Zuora-Version in the request header. The response may be different for the same request with a different API version. Specify Zuora-Version in the request header if you expect a specific response schema.

Operations

API Health

Zuora System Health dashboard for API (API dashboard) collects and displays data about API usage, failure, performance, and concurrency limit in near real time. It enables you to view all the APIs in your Zuora tenant within the last 14 days. For more information, see APIs dashboard.

Operations

Bill Run Health

Zuora System Health dashboard for Bill Run (Bill Run dashboard) collects and displays data about bill run usage, failure, and performance in near real time. Through the Bill Run dashboard, you can view data about all the bill runs in your Zuora tenant within the last 30 days. For more information, see Bill Run dashboard.

Operations

Electronic Payments Health

Zuora System Health dashboard for Electronic Payments (Electronic Payment dashboard) collects and displays usage, failure, and performance data about electronic payments in near real time. It enables you to view all the electronic payments in your Zuora tenant within the last 30 days. For more information, see Electronic Payments dashboard.

Operations

Tax Health

Zuora System Health dashboard for Tax Health (Tax Health dashboard) collects and displays usage, failure, and performance data about Tax in near real time. It enables you to view all the tax details in your Zuora tenant within the last 30 days. For more information, see Tax Health Dashboard.

Operations

Workflows

A workflow is a sequence of tasks that are performed based on predefined logic. A workflow improves efficiency and reduces errors by automating a series of complex tasks that otherwise need to be performed manually and repetitively.

For more information, see Workflow.

Operations

Data Queries

The Data Query feature enables you to perform SQL queries in your Zuora tenant. To learn how to get started with Data Query, see Overview of Data Query.

Operations

Aggregate Queries

The Aggregate Query API (AQuA) is a REST API that executes multiple Export ZOQL or ZOQL queries. The queries are performed in a sequential order and in a single read-only database transaction.

AQuA enforces the following limits:

The maximum processing time per query is 3 hours. If a query in an AQuA job is executed for longer than 3 hours, this job will be killed automatically. See the best practices for bulk data extraction with AQuA.
AQuA enforces limits on both the stateful concurrent AQuA jobs and the stateless concurrent AQuA jobs per tenant:
- The maximum number of stateful concurrent AQuA jobs per tenant is 50. - The maximum number of stateless concurrent AQuA jobs per tenant is 50. AQuA jobs in the following status are counted towards your concurrent AQuA job limits:
- Submitted - Executing Zuora system will reject the subsequent stateful or stateless job requests once the corresponding concurrent job limit is reached.

For more information about the Aggregate Query API(AQuA), see Aggregate Query.

Operations

Configuration Templates

Configuration Templates in Zuora Deployment Manager enable you to configure your tenants in minutes by importing a templated metadata configuration file. This feature eliminates the need for long manual configuration processes that would have previously taken hours. You will be able to access a comprehensive repository of industry-specific templates. It will be easier for you to deploy and release. To use this API for migrating metadata from a source tenant to a destination tenant, you should authenticate using credentials of the source tenant The user will have to provide the client id and secret key from the sou.rce tenant. To understand the known behavior of configuration templates and APIs, see the following sections: Product Catalog deployment known facts and system behavior Product Catalog deployment FAQs Deployment Manager Known Facts and Limitations

Operations

Metadata

The Metadata API in Zuora promotes a programmatic way to retrieve, compare, and validate metadata within Zuora tenants for performing create and update actions between the source and the target. To use this API for migrating metadata from a source tenant to a destination tenant, you should authenticate using credentials of the source tenant. The user will have to provide the client id and secret key from the source tenant. To understand the known behavior of configuration templates and APIs, see the following sections: Product Catalog deployment known facts and system behavior Product Catalog deployment FAQs Deployment Manager Known Facts and Limitations

Operations

Bulk Data

The Bulk Data API operations allow you to manage bulk data loader services and perform programmatic CRUD (Create, Update, Read/export, Delete) operations.
To perform data ingestion with a CSV file in Zuora Billing using the Data Loader Bulk Data APIs, see Tutorial for Bulk job API with CSV. For more information, see Process Bulk Job with JSON-lines in Data Loader.

Operations

SCIM

System for Cross-domain Identity Management, or SCIM, is an API specification created to facilitate the management of people and groups of people in cloud-based applications and services. Universal Identity SCIM API is built on top of the SCIM 2.0 specification and can be integrated with major Identity Providers like Okta, Microsoft Entra ID and OneLogin.

Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API.

You must first create an OAuth client in the Zuora UI before using the Create an OAuth token operation to create an OAuth token. See Authentication for more information.

Operations

Data Labeling

The Data Labeling APIs help you to label your existing data with organization(s) in Zuora.

Once you turned on Multi Org feature, if you don't label your existing data, they are simply unlabeled, and unlabeled data can be accessed by all organizations in your tenant.

To limit the access of your existing data, you need to label them with organization(s) you defined in the organization hierarchy management setting page. Once labeled, the data can only be accessed by users who have been granted with the labeled organization(s).

Note that you have to enable the "Multi Org" feature before using the Data Labeling APIs.

Operations

Data Backfill

If you are an Order to Revenue user, you can use the data backfill operations to perform, view or stop data backfill tasks.

Operations

Regenerate

If you are an Order to Revenue user, you can use the Regenerate operations to regenerate transactions objects.

Operations

Test Environments

A Test Environment is a dedicated sandbox tenant designed for development, integration, and user acceptance testing of your system configurations and business processes.

Operations

Test Environment Jobs

A Test Environment Job represents an asynchronous operation initiated to refresh a Test Environment. These jobs track the status and progress of environment provisioning and refresh.

Operations

Test Environment Notifications

A Test Environment Notification is an automated email dispatched to inform stakeholders when a Test Environment Job is completed or cancelled.

Operations

Actions

Actions are operations that are batch in nature. For example, the "create", "update", "delete", and other operations allow changes to up-to 50 objects at a time. The "query" operation will return up-to 2000 result records back at a time, before requiring additional pages of data to be returned via a subsequent "queryMore" operation.

The default WSDL version for Actions is 79. If you want to change the WSDL version, set the X-Zuora-WSDL-Version header. To find out in which WSDL version a particular object or field was introduced, see Zuora SOAP API Version History.

Note: Actions do not support the Invoice Settlement feature. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. Actions also do not support the Orders feature.

Operations

Settings

The Setting API provides a central API for managing settings in your Zuora tenant.

If you use Postman, you can import the Settings API endpoints as a collection into your Postman app and try out different requests to learn how the API works. You can sign up for a free account on the Postman website and download the app in case you do not use Postman yet.

Operations

Files

You can use the operations contained in this section to retrieve files such as export results, invoices, accounting period reports, and so on.

Operations

Imports

An import uploads content, especially when you have a large amount of content. The Import object contains all of the information you need to upload content, such as a large number of usage records.

Operations

Custom Exchange Rates

If you use a custom exchange rate provider and upload rates with the Import Foreign Exchange Rates mass action, you can query custom foreign exchange rates from Zuora through API.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Operations

Attachments

Use attachments in Zuora to upload documents of various formats to associate additional information with accounts, subscriptions, invoices, credit memos, or debit memos. Example attachments could be purchase orders (PO's), tax exemption document, or ownership transfer forms.

For more information about attachments, see Attachments.

Operations

Describe

You can use the Describe an object operation to get a reference listing of each object that is available in your Zuora tenant.

By default, the information returned by the "Describe an object" operation corresponds to the latest version of the Zuora WSDL.

Operations