getPricePreview( )


開発者プレビュー

このAPIは変更される可能性があります。プレビュー期間中、開発者からのフィードバックに基づいてバグ修正や新機能がリリースされる予定です。

Retrieves a preview of an order's pricing as if it was purchased.

について getPricePreview() function returns a Promise that resolves to a temporary preview of the order's price.

The price preview uses the same logic for calculating prices as used when purchasing a plan, but the preview is not saved. If taxes are configured for the site, taxes are applied to the preview. If not, the tax previews as null.

Buyers do not have to be logged in to preview the price, as such, the details returned by this function are not buyer-specific. To generate a preview of a purchase for a specific-buyer, use the getOfflineOrderPreview().

Permissions
Read Pricing Plans
Manage Orders
Manage Bookings Services and Settings
Read Orders
Manage Pricing Plans
Learn more about app permissions.
メソッド宣言
コピー
メソッド・パラメータ
planIdstringRequired

ID of plan to preview.


optionsGetPricePreviewOptions

Options for getting a price preview.

リターン
Return Type:Promise<GetPricePreviewResponse>
役に立ちましたか?
はい
いいえ