PreviewOptions

From API Documentation

Jump to: navigation, search

Used with the Subscribe and Amend call. Specifies if the call should return an actual subscription/amendment, or if a preview of what the subscription/amendment would be if activated. Useful for when wanting to display what charges would be for a customer contemplating an order (such as a new order, upgrade/downgrade, adding a product, adding additional units, etc). Also useful for degbugging during implementations or writing new business logic with the Z-Commerce API.

Supported Calls

susbcribe and amend

Fields

Name Required? Type Allowable Values Description
EnablePreviewMode No Boolean True/False Specifies if the call should create a subscsription/amendment, or if it should return a preview of the order.
NumberOfPeriods No Integer Positive integer greater than 0 Specifies the number of periods to show invoice previews.