Skip to main content

Offers - Data dictionary and Template

Zuora

Offers - Data dictionary and Template

This article lists the fields associated with the Offers data dictionary. Read more on Offers here.

Note: Fields with an asterisk mark indicate mandatory fields. 

Name

Description

Value

IsNewOffer Marker Column TRUE,FALSE
Description The description of the offer.

Alphanumeric

Effective EndTime*

The effective end time of the offer.

DateTime(yyyy-MM-dd HH:MM:SS)

Effective StartTime*

The effective start time of the offer.

DateTime(yyyy-MM-dd HH:MM:SS)

Charge Model Charge model of the offer

Alphanumeric

Name* The name of the offer. Alphanumeric
Pricing Level The pricing level of the offer.

Pricing Level values 

Top
Component


 (Currently Component is supported)

Type The type of the offer.

Type values 

Static
Dynamic

IsNewProductRatePlan

Marker Column TRUE/FALSE

Product Rate Plan Id*

The unique ID of the product rate plan to add to the offer.

Alphanumeric Id

IsNewProductRatePlanChargeOverride

Marker Column TRUE,FALSE

Product Rate Plan Charge Id*

The unique ID of the product rate plan charge.

Alphanumeric Id
Bill Cycle Day The bill cycle day (BCD) determines which day of the month customer is billed. The BCD value in the account can override the BCD in this object.

Number(1-31)

Bill Cycle Type Determine the billing day for the charge.

Bill Cycle Type values 

  • DefaultFromCustomer
  • SpecificDayofMonth
  • SubscriptionStartDay
  • ChargeTriggerDay
  • SpecificDayofWeek
  • TermStartDay
  • TermEndDay
Billing Period The billing period for this product rate plan charge. 

Billing Period 

  • Month,Quarter
  • Semi_Annual
  • Annual
  • Eighteen_Months
  • Two_Years
  • Three_Years
  • Five_Years
  • Specific_Months
  • Subscription_Term
  • Week
  • Specific_Weeks

Billing Period Alignment

Config to align charges within the same subscription if multiple charges begin on different dates.

Billing Period Alignment values 

  • AlignToCharge
  • AlignToSubscriptionStart
  • AlignToTermStart
  • AlignToTermEnd
Billing Timing The billing timing for this product rate plan charge.

Billing Timing values 

  • IN_ADVANCE,
  • IN_ARREARS

End Date Condition

When the product rate plan charge ends after the charge trigger date.

End Date Condition values 

  • Subscription_End
  • One_Time
  • Fixed_Period
  • Specific_End_Date

Specific Billing Period

The number of months or weeks for the billing period of this product rate plan charge.

Number

Trigger Event When to start billing the customer for the product rate plan charge.

Trigger Event values 

  • ContractEffective
  • ServiceActivation
  • CustomerAcceptance
  • SpecificDate
Upto Periods The length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.

Number

Upto Periods Type

The period type used to define when the charge ends.

Upto Periods Type values 
 

Weekly Bill Cycle Day

The day of the week when a bill run generates invoices for the account.

Weekly Bill Cycle Day values 

  • Billing_Periods
  • Days
  • Weeks
  • Months
  • Years

IsNewProductRatePlanChargeOverridePrice

Marker Column TRUE/FALSE
Currency* A currency as defined in Billing Settings in the Zuora UI. A string of 3 characters(Required field)

Currency values 

DefaultQuantity

The default quantity of the price book item.

Decimal
Included Units The number of units included in the price book item. Decimal
List Base Price

The list price base of the price book item.

List Base Price values 

  • Per_Billing_Period
  • Per_Month
  • Per_Week
  • Per_Year
  • Per_Specific_Months
Overage Price

The overage price of the price book item.

Decimal
Price The price of the price book item. Decimal

IsNewProductRatePlanChargeOverridePriceTier

Marker Column TRUE,FALSE

Tiers Ending Unit

The ending unit of the tier.

Decimal
Tiers Price*

The price of the tier.

Decimal

Tiers Price Format

The price format of the tier.

Price Format values 
 

  • FlatFee
  • PerUnit

Tiers Starting Unit*

The starting unit of the tier. Decimal
Tiers Tier* The number of the tier.

Number

IsNewProductRatePlanChargeOverridePriceIntervalPrice

Marker Column TRUE,FALSE

Interval Price Duration

The duration of the interval.

Number

Interval Price Overage Price

The overage price.

Decimal

Interval Price The price for the interval. Decimal

Interval Price Sequence*

The sequence of the interval. Number

Interval Price Type*

The type of the interval.

Price Type values 

  • Infinity
  • Day
  • Month

IsNewProductRatePlanChargeOverridePriceIntervalPriceTier

Marker Column TRUE,FALSE

Interval Price Tiers Ending Unit

The ending unit of the tier.

Decimal

Interval Price Tiers Price*

The price of the tier.

Decimal

Interval Price Tiers Price Format

The price format of the tier.

Price Format values 

  • FlatFee
  • PerUnit

Interval Price Tiers Starting Unit*

The starting unit of the tier. Decimal

Interval Price Tiers Tier*

The number of the tier.

Number

 

Data dictionary Template
Offers Offers Template.numbers