Introducing the Chargebee CLI
chargebee api

Estimates for purchase

Asynchronous

Returns an estimate for creating a purchase resource. The operation works exactly like Create a purchase, except that only an estimate resource is returned without an actual purchase resource being created.

Sample Request

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/purchases/estimate

Input Parameters

client_profile_id
optional, string, max chars=50

Indicates the Client profile id for the customer. This is applicable only if you use Chargebee's AvaTax for Communications integration.

customer_id
optional, string, max chars=50

The unique identifier of the customer that made this purchase.

customer
Parameters for customer. Multiple customer can be passed by specifying unique indices.
pass parameters as customer[<param name>][<idx:0..n>]
billing_address
Parameters for billing_address
pass parameters as billing_address[<param name>]
purchase_items[0..n]
Parameters for purchase_items. Multiple purchase_items can be passed by specifying unique indices.
pass parameters as purchase_items[<param name>][<idx:0..n>]
item_tiers[0..n]
Parameters for item_tiers. Multiple item_tiers can be passed by specifying unique indices.
pass parameters as item_tiers[<param name>][<idx:0..n>]
shipping_addresses[0..n]
Parameters for shipping_addresses. Multiple shipping_addresses can be passed by specifying unique indices.
pass parameters as shipping_addresses[<param name>][<idx:0..n>]
discounts[0..n]
Parameters for discounts. Multiple discounts can be passed by specifying unique indices.
pass parameters as discounts[<param name>][<idx:0..n>]
subscription_info[0..n]
Parameters for subscription_info. Multiple subscription_info can be passed by specifying unique indices.
pass parameters as subscription_info[<param name>][<idx:0..n>]
contract_terms[0..n]
Parameters for contract_terms. Multiple contract_terms can be passed by specifying unique indices.
pass parameters as contract_terms[<param name>][<idx:0..n>]

Returns

estimate
Estimate object

Resource object representing estimate