POST /hosted_pages/checkout_onetime_addons

This operation is only supported by the 2Checkout payment gateway.

Servers

{protocol}://{site}.{environment}:{port}/api/v1
{protocol}://{site}-test.{environment}:{port}/api/v1

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

Request body fields

Name	Type	Required	Description
`subscription`	Object	No	Parameters for subscription
`subscription.id`	String	Yes	A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
`pass_thru_content`	String	No	You can pass through any content specific to the hosted page request and get it back after user had submitted the hosted page.
`coupon`	String	No	The coupon code to be applied.
`card`	Object	No	Parameters for card
`card.gateway`	String	No	Name of the gateway this payment source is stored with. * sage_pay - Sage Pay is a payment gateway. * wirecard - WireCard Account is a payment service provider. * balanced_payments - Balanced is a payment gateway * elavon - Elavon Virtual Merchant is a payment solution. * migs - MasterCard Internet Gateway Service payment gateway. * not_applicable - Indicates that payment gateway is not applicable for this resource. * paymill - PAYMILL is a payment gateway. * first_data_global - First Data Global Gateway Virtual Terminal Account * ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. * eway_rapid - eWAY Rapid is a payment gateway. * chargebee - Chargebee test gateway. * beanstream - Bambora(formerly known as Beanstream) is a payment gateway. * braintree - Braintree is a payment gateway. * tco - 2Checkout is a payment gateway. * bluepay - BluePay is a payment gateway. * paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. * eway - eWAY Account is a payment gateway. * pin - Pin is a payment gateway * paypal_pro - PayPal Pro Account is a payment gateway. * authorize_net - Authorize.net is a payment gateway * stripe - Stripe is a payment gateway. * worldpay - WorldPay is a payment gateway * nmi - NMI is a payment gateway. * hdfc - HDFC Account is a payment gateway. Possible values: `"balanced_payments"` `"first_data_global"` `"paymill"` `"bluepay"` `"paypal_payflow_pro"` `"wirecard"` `"nmi"` `"hdfc"` `"ogone"` `"stripe"` `"migs"` `"eway_rapid"` `"worldpay"` `"sage_pay"` `"beanstream"` `"tco"` `"paypal_pro"` `"braintree"` `"elavon"` `"chargebee"` `"pin"` `"eway"` `"authorize_net"`
`addons`	Object	No	Parameters for addons
`addons.id[]`	Array	Yes	Identifier of the addon. Multiple addons can be passed.
`addons.quantity[]`	Array	No	Quantity of the addon. Applicable for addons with `pricing_model` other than `flat_fee`.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.