--- title: "List invoice schedules" method: GET path: "/object-query/invoice-schedules" tags: ["Object Queries"] --- # List invoice schedules `GET /object-query/invoice-schedules` Lists invoice schedules. You can use the query parameters to filter, expand, and sort the returned results. ## Query parameters - `pageSize` integer - `cursor` string - `sort[]` string[] - `expand[]` string[] - `filter[]` string[] - `fields[]` string[] - `includeNullFields` boolean ## Headers - `Idempotency-Key` string - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Response `200` OK - object - `nextPage` string, nullable — A string that can be used as the `cursor` value to retrieve the next page of the response if it exists; otherwise absent. - `data` ExpandedInvoiceSchedule[] - `id` string — The unique identifier of the invoice schedule. - `createdById` string — The unique identifier of the user who created the invoice schedule. - `createdDate` string, date-time — The date and time when the invoice schedule was created. - `updatedById` string — The unique identifier of the user who last updated the invoice schedule. - `updatedDate` string, date-time — The date and time when the invoice schedule was last updated. - `totalAmount` number — The total amount that needs to be billed during the processing of the invoice schedule. The value of this field keeps unchanged once invoice schedule items are created. - `actualAmount` number — The actual amount that needs to be billed during the processing of the invoice schedule. By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the `totalAmount` field keeps unchanged. The value of the `actualAmount` field reflects the actual amount to be billed. - `billedAmount` number — The amount that has been billed during the processing of the invoice schedule. - `unbilledAmount` number — The amount that is waiting to be billed during the processing of the invoice schedule. - `nextRunDate` string, date — The run date of the next execution of invoice schedule. By default, the next run date is the same as run date of next pending invoice schedule item. It can be overwritten with a different date other than the default value. When the invoice schedule has completed the execution, the next run date is null. - `number` string — The sequence number of the invoice schedule. - `notes` string — Comments on the invoice schedule. - `accountId` string — The ID of the customer account that the invoice schedule belongs to. - `status` 'Pending' | 'PartiallyProcessed' | 'Paused' | 'FullyProcessed' — The status of the invoice schedule. - `additionalSubscriptionsToBill` string — A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. One invoice schedule can have at most 600 additional subscriptions. - `currency` string — The currency of the billing documents generated during the processing of the invoice schedule. **Note**: - This field is available only if you have the Multiple Currencies feature enabled. - If you have the Multiple Currencies feature disabled, the corresponding account's default currency is always used. - `invoiceScheduleItems` NestedInvoiceScheduleItemOnExpand[] - `id` string — The unique identifier of the invoice schedule item. - `createdById` string — The unique identifier of the user who created the invoice schedule item. - `createdDate` string, date-time — The date and time when the invoice schedule item was created. - `updatedById` string — The unique identifier of the user who last updated the invoice schedule item. - `updatedDate` string, date-time — The date and time when the invoice schedule item was last updated. - `amount` string, number — The amount of the invoice generated during the processing of the invoice schedule item. You can only specify either the `amount` field or `percentage` field in one request. - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. The value of this field keeps unchanged once invoice schedule items are created. - `percentage` number — The percentage of the total amount to be billed during the processing of the invoice schedule item. You can only specify either the `amount` field or `percentage` field in one request. - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. - `actualAmount` string, number — The actual amount that needs to be billed during the processing of the invoice schedule item. By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the `amount` field keeps unchanged. The value of the `actualAmount` field reflects the actual amount to be billed. - `runDate` string, date — The date in the tenant's time zone when the invoice schedule item is processed to generate an invoice. - `invoiceScheduleId` string — The ID of the invoice schedule that the invoice schedule item belongs to. - `invoiceId` string — The ID of the invoice that is generated during the processing of the invoice schedule item. - `creditMemoId` string — The ID of the credit memo that is generated during the processing of the invoice schedule item. - `status` 'Pending' | 'Executing' | 'Processed' — The status of the invoice schedule item. - `name` string — The name of the invoice schedule item. - `sequenceNumber` string — The sequence number of the invoice schedule item. - `targetDateForAdditionalSubscriptions` string, date — The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item. The regular charges must come from the subscriptions specified in the `additionalSubscriptionsToBill` field on the associated invoice schedule. - `invoiceScheduleBookings` NestedInvoiceScheduleBookingOnExpand[] - `id` string — The unique identifier of the invoice schedule booking. - `createdById` string — The unique identifier of the user who created the invoice schedule booking. - `createdDate` string, date-time — The date and time when the invoice schedule booking was created. - `updatedById` string — The unique identifier of the user who last updated the invoice schedule booking. - `updatedDate` string, date-time — The date and time when the invoice schedule booking was last updated. - `invoiceScheduleId` string — The ID of the invoice schedule that the invoice schedule booking belongs to. - `orderId` string — The ID of the order associated with the invoice schedule. - `orderNumber` string — The number of the order associated with the invoice schedule. - `subscriptionId` string — The ID of the subscription contained in the order associated with the invoice schedule. - `subscriptionNumber` string — The number of the subscription contained in the order associated with the invoice schedule. - `chargeNumbers` string — A list of charges in the subscription that are chosen to be included in the invoice schedule. - `ratePlanCharges` NestedRatePlanChargeOnExpand[] - `id` string — The unique identifier of the rate plan charge. - `createdById` string — The unique identifier of the user who created the rate plan charge. - `createdDate` string, date-time — The date and time when the rate plan charge was created. - `updatedById` string — The unique identifier of the user who last updated the rate plan charge. - `updatedDate` string, date-time — The date and time when the rate plan charge was last updated. - `ratePlanId` string — The unique identifier of the rate plan to which this rate plan charge belongs. - `productRatePlanChargeId` string — The unique identifier of the product rate plan charge associated with this product rate plan charge. - `accountingCode` string — The accounting code for the charge. Accounting codes group transactions that contain similar accounting attributes. **Values**: inherited from `ProductRatePlanCharge.AccountingCode` **Note**: This value changes if `ProductRatePlanCharge.AccountingCode` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.AccountingCode` is updated. - `applyDiscountTo` string — Specifies the type of charges a specific discount applies to. **Values**: inherited from `ProductRatePlanCharge.ApplyDiscountTo` - `billCycleDay` integer — Indicates the charge's billing cycle day (BCD), which is when bill runs generate invoices for charges associated with the product rate plan charge or the account. **Values**: inherited from `ProductRatePlanCharge.BillCycleDay` - `billCycleType` string — Specifies how to determine the billing day for the charge.\n\ **Values**: inherited from `ProductRatePlanCharge.BillCycleType` **Note:** You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - `billingPeriod` string — Allows billing period to be overridden on rate plan charge. **Values**: **inherited from `ProductRatePlanCharge.BillingPeriod` **Note:** You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - `billingPeriodAlignment` string — Aligns charges within the same subscription if multiple charges begin on different dates. **Values**: inherited from `ProductRatePlanCharge.BillingPeriodAlignment` - `billingTiming` 'In Advance' | 'In Arrears' — The billing timing for the charge. You can choose to bill in advance or in arrears for recurring charge types. This field is not used in one-time or usage based charge types. **Note:** You can override the value inherited from the Product Rate Plan Charge when a subscription has a recurring charge type. - `chargedThroughDate` string, date — The date through which a customer has been billed for the charge. - `chargeModel` string — Determines how to evaluate charges. Charge models must be individually activated in the web-based UI. **Values**: inherited from `ProductRatePlanCharge.ChargeModel` - `chargeNumber` string — A unique number that identifies the charge. This number is returned as a string. **Values**: one of the following: - automatically generated if left `null` - a unique number of 50 characters or fewer - `chargeType` string — Specifies the type of charge. **Values**: inherited from `ProductRatePlanCharge.ChargeType` - `description` string — A description of the rate plan charge. - `discountLevel` 'rateplan' | 'subscription' | 'account' — Application scope of the discount charge. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge. - `dMRC` number — A delta monthly recurring charge is the change in monthly recurring revenue caused by an amendment or a new subscription. **Values**: automatically generated - `drawdownRate` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The [conversion rate](https://docs.zuora.com?resourceId=billing-create-drawdown-charge) between Usage UOM and Drawdown UOM for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). Must be a positive number (>0). - `dTCV` number — After an Amendment, the change in the total contract value (TCV) amount for this charge, compared with its previous value. **Values**: automatically generated - `effectiveEndDate` string, date — Start date when the rate plan charge becomes active, as `yyyy-mm-dd`. - `effectiveStartDate` string, date — Final date the rate plan is active, as `yyyy-mm-dd`. - `endDateCondition` 'SubscriptionEnd' | 'FixedPeriod' | 'SpecificEndDate' | 'OneTime' — Condition for the charge to become inactive. - If the value of this field is `FixedPeriod`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields. - If the value of this field is `SpecificEndDate`, use the `specificEndDate` field to specify the date when the charge becomes inactive. - `excludeItemBillingFromRevenueAccounting` boolean — The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. If both the following features are enabled in your tenant, you must ensure the `excludeItemBillingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the `excludeItemBookingFromRevenueAccounting` field in an Create Subscription or Add Product order action is set to `false`, you must also set the `excludeItemBillingFromRevenueAccounting` field in this order action to `false`. * Prepaid with Drawdown * Unbilled Usage **Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `excludeItemBookingFromRevenueAccounting` boolean — The flag to exclude rate plan charges from revenue accounting. If both the following features are enabled in your tenant, you must ensure the `excludeItemBookingFromRevenueAccounting` field is set consistently for a prepayment charge and the corresponding drawdown charge. * Prepaid with Drawdown * Unbilled Usage **Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `invoiceScheduleId` string — The unique identifier of the invoice schedule associated with the subscription. - `isLastSegment` boolean — Indicates if the segment of the rate plan charge is the most recent segment. **Values**: automatically generated. - `isPrepaid` boolean — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. - `isRollover` boolean — **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. It determines whether the rollover fields are needed. - `rolloverPeriods` integer — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the number of rollover periods, it is restricted to 3. - `rolloverPeriodLength` integer, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the `rolloverPeriods` field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year. - `rolloverApply` 'ApplyFirst' | 'ApplyLast' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the priority of rollover, which is either first or last. - `isProcessed` boolean — Indicates whether the rate plan charge has been processed. - `listPriceBase` 'Per Billing Period' | 'Per Month' | 'Per Week' | 'Per Year' | 'Per Specific Months' — The list price base for the product rate plan charge. - `specificListPriceBase` integer, nullable — The number of months for the list price base of the charge. This field is required if you set the value of the `ListPriceBase` field to `Per Specific Months`. **Notes**: - This field is available only if you have the Annual List Price feature enabled. - The value of this field is `null` if you do not set the value of the `ListPriceBase` field to `Per Specific Months`. - `priceUpsellQuantityStacked` boolean - `commitmentType` 'UNIT' | 'CURRENCY' — **Note**: This field is only available if you have the Unbilled Usage feature enabled. To use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. This field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. * If UNIT, it will create a fund with given prepaidUom. * If CURRENCY, it will create a fund with the currency amount calculated in list price. For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges. - `isCommitted` boolean — Indicates whether the rate plan charge is commited. - `mRR` number — Monthly recurring revenue (MRR) is the amount of recurring charges in a given month. The MRR calculation doesn't include one-time charges nor usage charges. **Values**: automatically generated - `name` string — The name of the rate plan charge. **Values**: automatically generated - `numberOfPeriods` integer — Specifies the number of periods to use when calculating charges in an overage smoothing charge model. **Values**: inherited from `ProductRatePlanCharge.NumberOfPeriod`. - `originalId` string — The original ID of the rate plan charge. **Values**: automatically generated. - `overageCalculationOption` string — Determines when to calculate overage charges. If the value of the SmoothingMode field is null (not specified and not inherited from ProductRatePlanCharge.SmoothingMode), the value of this field is ignored. **Values**: inherited from `ProductRatePlanCharge.OverageCalculationOption`. - `overageUnusedUnitsCreditOption` string — Determines whether to credit the customer with unused units of usage. **Values**: inherited from `ProductRatePlanCharge.OverageUnusedUnitsCreditOption`. - `prepaidOperationType` 'topup' | 'drawdown' | 'null', nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The type of this charge. It is either a prepayment (topup) charge or a drawdown charge. - `prepaidQuantity` number, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The number of units included in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). Must be a positive number (>0). - `prepaidTotalQuantity` number, nullable — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). - `priceChangeOption` string — Applies an automatic price change when a termed subscription is renewed. **Values**: one of the following: - `NoChange` (default) - `SpecificPercentageValue` - `UseLatestProductCatalogPricing` - `priceIncreasePercentage` number, double — Specifies the percentage to increase or decrease the price of renewed subscriptions. **Values**: a decimal value between -100 and 100. - `processedThroughDate` string, date — The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the `ChargedThroughDate` value. This date is the earliest date when a charge can be amended. **Values**: automatically generated. - `prorationOption` string — Determines how to prorate charges when a subscription is created or amended. - `quantity` number — The default quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing. **Values**: a valid quantity value. - `numberOfDeliveries` number — Number of deliveries in the billing period for the charge segment. The `numberOfDeliveries` is used for the Delivery Pricing charge model only. **Note**: The Delivery Pricing charge model is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://docs.zuora.com?resourceId=billing-enable-billing-features-by-yourself) in the Knowledge Center. You can check **Delivery Pricing** in **Billing Settings** > **Enable Charge Types / Models**. - `ratingGroup` 'ByBillingPeriod' | 'ByUsageStartDate' | 'ByUsageRecord' | 'ByUsageUpload' | 'ByGroupId' — A rating group based on which usage records are rated. Only applicable to Usage charges. Possible values: - `ByBillingPeriod`: The rating is based on all the usages in a billing period. - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. - `ByUsageRecord`: The rating is based on each usage record. - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`). - `ByGroupId`: The rating is based on all the usages in a custom group. For more information, see [Usage rating by group](https://docs.zuora.com?resourceId=billing-usage-rating-by-group). - `revenueRecognitionRuleName` string — Specifies the Revenue Recognition Rule that you want the Rate Plan Charge to use. This field can be updated when **Status** is `Draft`. By default, the Revenue Recognition Rule is inherited from the Product Rate Plan Charge. For Amend calls, you can use this field only for NewProduct amendments. For Update calls, you can use this field only to update subscriptions in draft status. Note that if you use this field to specify a Revenue Recognition Rule for the Rate Plan Charge, the rule will remain as specified even if you later change the rule used by the corresponding Product Rate Plan Charge. **Values**: inherited from `ProductRatePlanCharge.RevenueRecognitionRuleName` or the name of an active Revenue Recognition Rule **Note**: Unless overridden, this value changes if `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevenueRecognitionRuleName` is updated. - `revenueRecognitionTiming` 'Upon Billing Document Posting Date' | 'Upon Order Activation Date' — Specifies the type of revenue recognition timing. Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the revenue recognition policy configuration in the Zuora Billing UI. **Note**: This field is only available if you have the Order to Revenue feature enabled. - `revenueAmortizationMethod` 'Immediate' | 'Ratable Using Start And End Dates' — Specifies the type of revenue amortization method. Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the revenue recognition policy configuration in the Zuora Billing UI. **Note**: This field is only available if you have the Order to Revenue feature enabled. - `revRecCode` string — Associates this product rate plan charge with a specific revenue recognition code. **Values**: inherited from `ProductRatePlanCharge.RevRecCode` or a valid revenue recognition code **Note**: Unless overridden, this value changes if `ProductRatePlanCharge.RevRecCode` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevRecCode` is updated. - `revRecTriggerCondition` string — Specifies when revenue recognition begins. **Values**: inherited from `ProductRatePlanCharge.RevRecTriggerCondition` or one of the following: - `ContractEffectiveDate` - `ServiceActivationDate` - `CustomerAcceptanceDate` Note: Unless overridden, this value changes if `ProductRatePlanCharge.RevRecTriggerCondition` is updated. The values of `UpdatedById` and `UpdatedDate` for the `RatePlanCharge` do not change when `ProductRatePlanCharge.RevRecTriggerCondition` is updated. - `segment` integer — The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1. **Values**: automatically generated - `specificBillingPeriod` integer — Customizes the number of months or weeks for the charges billing period. This field is required if you set the value of the BillingPeriod field to `Specific Months` or `Specific Weeks`. **Values**: inherited from `ProductRatePlanCharge.BillingPeriod` **Note:** You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - `specificEndDate` string, date — The specific date on which the charge ends, in `yyyy-mm-dd` format. **Note**: - This field is only applicable when the `EndDateCondition` field is set to `SpecificEndDate`. - If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date. - `tCV` number, double — The total contract value (TCV) is the value of a single rate plan charge in a subscription over the lifetime of the subscription. This value does not represent all charges on the subscription. The TCV includes recurring charges and one-time charges, but it doesn't include usage charge. **Values**: automatically generated - `triggerDate` string, date — The date when the charge becomes effective and billing begins, in `yyyy-mm-dd` format. This field is required if the `TriggerEvent` field value is `SpecificDate`. - `triggerEvent` string — Specifies when to start billing the customer for the charge. **Note: **This field can be passed through the Subscribe and Amend calls and will override the default value set on the Product Rate Plan Charge. **Values**: inherited from `ProductRatePlanCharge.TriggerEvent` and can be one of the following values: - `ContractEffective` is the date when the subscription's contract goes into effect and the charge is ready to be billed. - `ServiceActivation` is when the services or products for a subscription have been activated and the customers have access. - `CustomerAcceptance` is when the customer accepts the services or products for a subscription. - `SpecificDate` is valid only on the RatePlanCharge. - `uOM` string — Specifies the units to measure usage. **Values**: inherited from `ProductRatePlanCharge.UOM` - `upToPeriods` integer — Specifies 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. **Values**: inherited from `ProductRatePlanCharge.UpToPeriods` **Note**: - You must use this field together with the `UpToPeriodsType` field to specify the time period. This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`. - You can override the value inherited from the Product Rate Plan Charge, but only when creating a new subscription or a New Product amendment. - Use this field to override the value in `ProductRatePlanCharge.UpToPeriod`. - If you override the value in this field, enter a whole number between 0 and 65535, exclusive. - If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. - `upToPeriodsType` 'Billing Periods' | 'Days' | 'Weeks' | 'Months' | 'Years' — The period type used to define when the charge ends. This field can be updated when **Status** is `Draft`. **Note**: - You must use this field together with the `UpToPeriods` field to specify the time period. - This field is only applicable only when the `EndDateCondition` field is set to `FixedPeriod`. - `version` integer — The version of the rate plan charge. Each time a charge is amended, Zuora creates a new version of the rate plan charge. **Values**: automatically generated. - `weeklyBillCycleDay` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Specifies which day of the week as the bill cycle day (BCD) for the charge. - `subscriptionId` string — The unique identifier of the subscription to which the rate plan charge belongs. - `subscriptionOwnerId` string — ID of the account that owns the subscription. - `invoiceOwnerId` string — ID of the account that will pay the billing documents for the subscription. - `originalOrderDate` string, date — The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue. - `amendedByOrderOn` string, date — The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. - `validityPeriodType` 'SUBSCRIPTION_TERM' | 'ANNUAL' | 'SEMI_ANNUAL' | 'QUARTER' | 'MONTH' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The period in which the prepayment units are valid to use as defined in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). - `creditOption` 'TimeBased' | 'ConsumptionBased' | 'FullCreditBack' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The way to calculate credit. See [Credit Option](https://docs.zuora.com?resourceId=billing-prepayment-charge) for more information. - `applyToBillingPeriodPartially` boolean — Allow the discount duration to be aligned with the billing period partially. **Note**: You must enable the [Enhanced Discounts](https://docs.zuora.com?resourceId=billing-manage-enhanced-discount) feature to access this field. - `productChargeDefinitionId` string — The unique ID of the product charge definition. - `accountReceivableAccountingCodeId` string — ID of the accountReceivableAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled. - `deferredRevenueAccountingCodeId` string — ID of the deferredRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `recognizedRevenueAccountingCodeId` string — ID of the recognizedRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `prepaidUOM` string — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Unit of measurement for a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). - `drawdownUom` string — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. Unit of measurement for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). - `ratePlan` object — The rate plan to which this charge belongs. - `productRatePlanCharge` object — The product rate plan charge associated with this rate plan charge. - `salesPrice` number — The sales price associated with the rate plan charge expressed as a decimal. **Notes**: - This field is only available to subscriptions that are created through orders and exist after 2023-01-10. - This field applies to the following charge models, and the values vary with the charge models: - Flat fee: the value equals the value of the `price` field. - Per unit: the value equals `price` multiplied by `quantity`. - Fixed amount discount: the value equals the value of the `discountAmount` field. - Volume: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit. - Tiered: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit. - `taxable` boolean — Indicates whether the rate plan charge is taxable. - `reverted` boolean — Indicates whether the rate plan charge has been reverted. - `reflectDiscountInNetAmount` boolean — Indicates whether the discount is reflected in the net amount. ## Other responses - `500` — Internal server error - `4XX` — Invalid input --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)