Welcome to Zuora Product Documentation

Explore our rich library of product information

CreateQuote component

This article describes the CreateQuote Component and its attributes.

The CreateQuote component is used to create quotes for new subscriptions, amendments, renewals, and cancellations. The component supports:

  • Customizable title and subtitle

  • Customizable sections and fields, including custom fields

  • Applies the user's default values, or (if none provided) the profile / organization defaults

  • Allows the customization of the URL target of the Next / Cancel buttons

  • Allows all quote types: New Subscription, Amendment, Renewal, Cancellation

  • Customizable / metadata-driven validation rules

Note:

The CreateQuote component is available in Versions 5.100 and later of Zuora Quotes.

CreateQuote Component Attributes

To use the CreateQuote component, the page parameters must contain a parameter named quoteType . The value of this parameter can only contain the following values: Subscription, Amendment, and Renewal. The values are case-sensitive.

Attribute

Type

Required

Default Value

Description

backButtonLabel

String

No

Label.QUOTE_WIZARD_DEFAULT_BACK

Label text on the Back button.

The value is automatically determined from the quote wizard configuration if left unspecified and used within valid quote wizard context.

backPageUrl

String

No

Select Billing Accout page

The page to navigate to upon clicking the Back button.

billingAccountId

String

No

Yes for amendment, renewal, cancellation

N/A

Zuora billing account Id.

cancelPageUrl

String

No

Opportunity detail page

The page to naviagate to upon clicking the Cancel button

crmAccountID

String

Yes

N/A

If there is no opportunity set, then Account Id is required.

id

String

An identifier that allows the component to be referenced by other components in the page

nextButtonLabel

String

No

Label.Next

Label text on the Next button.

nextPageUrl

String

No

Page.ZQAmendment for Amendment quote Page.ZQRenewal for Renewal Quote Page.ZuoraProductSelector for New Subscription Quote

The page to navigate to upon clicking the Next button

opportunityId

String

Yes

N/A

The ID of the opportunity that this quote belongs

renderBackButton

Boolean

No

False

Boolean value indicating whether or not to render the Back button of the component

rendered

Boolean

No

True

A Boolean value that specifies whether the component is rendered on the page.

subscriptionId

String

No for new subscription

Yes for amendment, renewal, and cancellation

N/A

Zuora subscription id that amendment or Renewal type quote is created for

subTitle

String

No

N/A

The subtitle of this component

title

String

No

N/A

The title of this component