--- title: "Preview a delivery adjustment" method: POST path: "/v1/adjustments/preview" tags: ["Delivery Adjustments"] --- # Preview a delivery adjustment `POST /v1/adjustments/preview` Describes how to preview delivery adjustments of a subscription. **Notes**: - The Delivery Adjustments feature 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. - This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “success = true” as well as eligible delivery adjustments and ineligible delivery adjustments are returned in the response; only when no delivery adjustment is eligible, “success=false” is returned. ## 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 ## Request body - POSTPreviewBillingAdjustmentRequestType - `accountNumber` string — The account number for which the delivery adjustment is created. **Note**: - The account number should be of the subscription owner. - Only one of accountNumber or subscriptionNumber should be provided. - `chargeNumbers` string[] — An optional container to specify charge numbers in the subscription for which the delivery adjustment needs to be created. - `deferredRevenueAccountingCode` string — The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. - `endDate` string, date, required — The end date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive. - `reason` string — The reason for the delivery adjustment. - `recognizedRevenueAccountingCode` string — The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. - `revenueRecognitionRuleName` string — The name of the revenue recognition rule governing the revenue schedule. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. - `startDate` string, date, required — The start date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive. - `subscriptionNumber` string — The subscription number for which the delivery adjustment is created. **Note**: Only one of accountNumber or subscriptionNumber should be provided. - `type` 'DeliveryCredit' — The type of delivery adjustment. ## Response `200` OK - GETAdjustmentsResponseType - `processId` string — The ID of the process that handles the operation. - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`. - `code` string — The error code of response. - `message` string — The detail information of the error response - `requestId` string, uuid — Unique identifier of the request. - `success` boolean — Indicates whether the call succeeded. - `adjustments` POSTAdjustmentResponseType[] — Container for delivery adjustments of a subscription. - `adjustmentId` string, UUID — The system generated delivery adjustment ID. - `adjustmentNumber` string, string — The system generated delivery adjustment number. - `amount` number — The amount of the delivery adjustment. - `billingDate` string, date — The billing date is same as the delivery date of the delivery adjustment, in `yyyy-mm-dd` format. - `chargeNumber` string — The charge number in the subscription for which the delivery adjustment is created. - `creditMemoNumber` string, nullable — The Credit Memo generated for the delivery adjustment. - `deferredRevenueAccountingCode` string — The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. - `deliveryDate` string, date — The delivery adjustment date, in `yyyy-mm-dd` format. - `deliveryDay` string — The delivery adjustment day of the week. - `eligible` boolean — The eligible flag is set as true for a successfully created delivery adjustment. - `reason` string — The reason for the delivery adjustment. - `recognizedRevenueAccountingCode` string — The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. - `revenueRecognitionRuleName` string — The name of the revenue recognition rule governing the revenue schedule. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. - `status` string, nullable — The status of the delivery adjustment will be `Billed` or `Cancelled`. - `subscriptionNumber` string — The subscription number for which the delivery adjustment is created. - `ineligibleAdjustments` POSTIneligibleAdjustmentResponseType[] — Container for ineligible delivery adjustments of a subscription. - `adjustmentId` string, UUID, nullable — The system generated delivery adjustment ID. - `adjustmentNumber` string, string, nullable — The system generated delivery adjustment number. - `amount` number, nullable — The amount of the delivery adjustment. - `billingDate` string, date, nullable — The billing date of the delivery adjustment. - `chargeNumber` string — The charge number in the subscription for which the delivery adjustment is created. - `deferredRevenueAccountingCode` string — The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. - `deliveryDate` string, date — The delivery adjustment date, in `yyyy-mm-dd` format. - `deliveryDay` string, string — The delivery adjustment day of the week. - `eligible` boolean — The eligible flag is set as false for an unsuccessful delivery adjustment. - `errorMessage` string — The reason due to which a delivery adjustment is not eligible on the given date. - `reason` string — The reason for the delivery adjustment. - `recognizedRevenueAccountingCode` string — The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. - `revenueRecognitionRuleName` string — The name of the revenue recognition rule governing the revenue schedule. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. - `status` string, nullable — The status of the delivery adjustment. - `subscriptionNumber` string — The subscription number for which the delivery adjustment is created. - `totalAmount` number — The total amount of all the delivery adjustments. - `totalNumberOfDeliveries` number — The total number of all delivery adjustments. ## Other responses - `500` — Internal Server Error - `4XX` — Request Errors --- [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)