Below is a typical checkout page for a customer in the purchase process.
The previewed billing amounts are displayed on the left and a Credit Card or ACH Payment Form is embedded on the right.
The code below is a sample "Preview an order" call that obtains these billing amounts for you.
The order summary part displays the total amount of the order, along with the selected product and product rate plan details.
Assuming the subscription is set as an evergreen subscription, the following sample code calls the Preview an order operation and submits the following information for preview:
existingAccountNumber: A00024362 (obtained from the previous call)subscribeToRatePlans:productRatePlanNumber: PRP-00000180 (obtained from the Show specific product details section)
previewTypes: BillingDocs, representing only the total amounts that will appear on the invoice.orderDate: Today's date (assuming that today is 2025-01-01).terms>initialTerm>termType: EVERGREEN
cURL
curl -L -X POST 'https://rest.test.zuora.com/v1/orders/preview' \
-H 'zuora-version: 341' \
-H 'Authorization: Bearer 68ec505613a94daeaa28aa4b44435696' \
-H 'Content-Type: application/json' \
-d '{
"orderDate": "2025-01-01",
"previewOptions":{
"previewThruType": "NumberOfPeriods",
"previewNumberOfPeriods": 1,
"previewTypes": ["BillingDocs"]
},
"existingAccountNumber": "A00024362",
"subscriptions": [
{
"orderActions":[{
"type": "CreateSubscription",
"createSubscription": {
"terms": {
"initialTerm": {
"termType": "EVERGREEN"
}
},
"subscribeToRatePlans": [{
"productRatePlanNumber": "PRP-00000180"
}]
}
}]
}
]
}'If the request succeeds, you will get a response similar to the following snippet:
{
"success": true,
"previewResult": {
"invoices": [
{
"amount": 49.99,
"amountWithoutTax": 49.99,
"taxAmount": 0.00,
"targetDate": "2025-01-01",
"invoiceItems": [
{
"serviceStartDate": "2025-01-01",
"serviceEndDate": "2025-01-31",
"amountWithoutTax": 49.99,
"taxAmount": 0.000000000,
"chargeDescription": "No refund if you cancel after 7 days.",
"chargeName": "Recurring per unit fee",
"chargeNumber": null,
"processingType": "Charge",
"productName": "SmartLearn Tablet",
"productRatePlanChargeId": "8a8aa19590e7dea30190ecf807da39ab",
"unitPrice": 49.990000000,
"subscriptionNumber": null,
"orderLineItemNumber": null,
"taxationItems": [],
"additionalInfo": {
"quantity": 1,
"unitOfMeasure": "License",
"numberOfDeliveries": 0.000000000
}
}
]
}
]
}
}