Hosted pages are the easiest and most secure way to integrate chargebee with your website. By using hosted pages, you can avoid the sensitive card information passing through your server and be compliant with most of the PCI DSS requirements.
When you request for a hosted page, a secure & unique URL will be returned which you could either embed or redirect depending upon the embed parameter value that you had passed.
Specifying "embed" parameter as true allows you to embed the "hosted page" in an iframe in your own website. This helps you provide the best experience to your user as they do not have to leave your website to provide card information. Drawbacks are
- Your site should also be in https
- You have to be careful with height and width of the iframe otherwise users might get scroll.
To use the hosted pages, you must configure Redirect URL in the Chargebee web interface under HOSTED PAGES SETTINGS -> Configuration. The configured redirect URL will be called with the following parameters after user had submitted the page.
- id - unique identifier of the hosted page resource
- state - succeeded, failed or cancelled
After the Redirect URL is called by Chargebee with the above parameters, the details of the hosted page can be fetched using Retrieve a hosted page API. The content attribute will have the details about the customer, subscription, card & invoice based on the type of the hosted page.
For Checkout New Subscription:
- Customer - The details about the new customer created.
- Subscription - The details about the new subscription created.
- Card - The details about the card provided while subscribing.
- Invoice - The details about the invoice, if one is generated.
For Checkout Existing Subscription:
- Customer - The updated details of the customer.
- Subscription - The updated details of the subscription.
- Card - The details about the card provided while subscribing.
- Invoice - The details about the invoice, if one is generated.
For Update Payment Method:
- Customer - The details about the customer for whom the card was updated.
- Card - The details about the updated card. It will be present only if the type of payment method is card.
When an embedded hosted page is cancelled by your end user, the content attribute will have the unmodified details of customer, subscription & card resources.
Sample hosted page [ JSON ]
{
"created_at": 1517506797,
"embed": true,
"expires_at": 1517510397,
"id": "__test__KfW0lW3V4e8fhHtugBdLaUcuJL60OycPv",
"object": "hosted_page",
"state": "created",
"type": "checkout_new",
"url": "https://yourapp.chargebee.com/pages/v2/__test__KfW0lW3V4e8fhHtugBdLaUcuJL60OycPv/checkout"
}
Unique identifier generated for each hosted page requested.
optional, string, max chars=70
Type of the requested hosted page.
optional, enumerated stringPossible values are
checkout_newCheckout new Subscription.checkout_existingCheckout existing Subscription.update_cardUpdate Card for a Customer.checkout_onetime_chargeCheckout One time Charge.checkout_onetime_addonsCheckout One time Addons.update_payment_methodUpdate Payment Method for a Customer.checkout_one_timeCheckout one time.
Unique URL for the hosted page that will be included in your website.
optional, string, max chars=250
Indicating the current state of the hosted page resource.
optional, enumerated string, default=createdPossible values are
createdIndicates the hosted page is just created.requestedIndicates the hosted page is requested by the website.succeededIndicates the hosted page is successfully submitted by the user and response is sent to the return url.cancelledIndicates the page is cancelled by the end user after requesting it.
You can pass through any content specific to the hosted page request and get it back after user had submitted the hosted page.
optional, string, max chars=2048
If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.
Note : For
in-app checkout, default is false.
boolean, default=true
Indicates when this hosted page url is generated.
optional, timestamp(UTC) in seconds
Indicates when this hosted page url will expire. After this, the hosted page cannot be accessed.
optional, timestamp(UTC) in seconds
This attribute will be returned only during retrieve hosted page API call and also the retrieved hosted page resource state should be either in "succeeded" or "cancelled" state.
If hosted page state is "succeeded", then the subscription, customer, card & invoice(optional) resources during checkout can be obtained.
If hosted page is state is "cancelled", then it will be empty i.e no information about checkout.
jsonobject
Hosted page to accept card details from the subscriber and create a new subscription. This is similar to our server to server API Create a Subscription.
When the redirect URL is notified of the result, we would advise you to retrieve the subscription and verify the details.
Related Tutorials
Notes
As mentioned before this behavior is very similar to the create subscription API call. All the web hook events will be fired only after the submission of payment details by the customer and successful creation of subscription.
Any errors related to the payment form that is submitted is handled as a response within the form so that the user is kept informed about the reason for failure to take corrective action.
Sample Request
# checkout a new subscription with customer details.
curl https://{site}.chargebee.com/api/v1/hosted_pages/checkout_new \
-u {site_api_key}:\
-d customer[email]="john@user.com" \
-d customer[first_name]="John" \
-d customer[last_name]="Doe" \
-d customer[phone]="+1-949-999-9999" \
-d subscription[plan_id]="no_trial"
copy
# checkout a new subscription with customer details.
curl https://{site}.chargebee.com/api/v1/hosted_pages/checkout_new \
-u {site_api_key}:\
-d customer[email]="john@user.com" \
-d customer[first_name]="John" \
-d customer[last_name]="Doe" \
-d customer[phone]="+1-949-999-9999" \
-d subscription[plan_id]="no_trial"
Sample Response [ JSON ]
Show more...
{"hosted_page": {
"created_at": 1517506797,
"embed": true,
"expires_at": 1517510397,
"id": "__test__KfW0lW3V4e8fhHtugBdLaUcuJL60OycPv",
"object": "hosted_page",
"state": "created",
"type": "checkout_new",
"url": "https://yourapp.chargebee.com/pages/v2/__test__KfW0lW3V4e8fhHtugBdLaUcuJL60OycPv/checkout"
}}
URL Format POST
https://{site}.chargebee.com/api/v1/hosted_pages/checkout_new
Number of cycles(plan interval) this subscription should be charged. After the billing cycles exhausted, the subscription will be cancelled.
optional, integer, min=0
The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
Note :
- Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded - This parameter is not applicable for iframe messaging.
optional, string, max chars=250
The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.
Note :
- Cancel URL configured in Settings > Hosted Pages Settings would be overriden by this cancel URL.
Eg : http://yoursite.com?id=<hosted_page_id>&state=cancelled - This parameter is not applicable for iframe messaging and in-app checkout.
optional, string, max chars=250
You can pass through any content specific to the hosted page request and get it back after user had submitted the hosted page.
optional, string, max chars=2048
If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.
Note : For
in-app checkout, default is false.
optional, boolean, default=true
If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess & onCancel callbacks.
Note : This parameter is not applicable for
in-app checkout.
optional, boolean, default=false
Parameters for subscription
pass parameters as subscription[<param name>]
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
optional, string, max chars=50
Identifier of the plan for this subscription.
required, string, max chars=100
subscription[plan_quantity]
Plan quantity for this subscription.
optional, integer, default=1, min=1
The time at which the trial ends for this subscription. Can be specified to override the default trial period.If '0' is passed, the subscription will be activated immediately.
optional, timestamp(UTC) in seconds
The date/time at which the subscription is to start or has started. If not provided, the subscription starts immediately. If set to a value in the past then that date/time should not be more than a plan billing period into the past.
optional, timestamp(UTC) in seconds
The id of the coupon. For validating the coupon code provided by the user , use the following codes in combination with the param attribute in the error response.
- resource_not_found : Returned if the coupon is not present.
- resource_limit_exhausted : Returned if the coupon has expired or the maximum redemption for the coupon has already been reached.
- invalid_request : Returned if the coupon is not applicable for the particular plan/addon.
optional, string, max chars=50
Parameters for customer
pass parameters as customer[<param name>]
Id for the new customer. If not given, this will be same as the subscription id.
optional, string, max chars=50
Email of the customer. Configured email notifications will be sent to this email.
optional, string, max chars=70
First name of the customer. If not provided it will be got from contact information entered in the hosted page .
optional, string, max chars=150
Last name of the customer. If not provided it will be got from contact information entered in the hosted page .
optional, string, max chars=150
Company name of the customer.
optional, string, max chars=250
Specifies if the customer is liable for tax.
optional, enumerated string, default=taxablePossible values are
taxableComputes tax for the customer based on the site configuration. In some cases, depending on the region, shipping_address is needed. If not provided, then billing_address is used to compute tax. If that’s not available either, the tax is taken as zero.exempt- Customer is exempted from tax. When using Chargebee’s native Taxes feature or when using the TaxJar integration, no other action is needed.
- However, when using our Avalara integration, optionally, specify
entity_code
or exempt_number
attributes if you use Chargebee’s AvaTax for Sales or specify exemption_details
attribute if you use Chargebee’s AvaTax for Communications integration. Tax may still be applied by Avalara for certain values of entity_code
/exempt_number
/exemption_details
based on the state/region/province of the taxable address.
.
Phone number of the customer.
optional, string, max chars=50
Parameters for card
pass parameters as card[<param name>]
Name of the gateway this payment source is stored with.
optional, enumerated stringPossible values are
chargebeeChargebee test gateway.stripeStripe payment gateway.braintreeBraintree payment gateway.authorize_netAuthorize.net payment gateway.paypal_proPaypal Pro Account.pinPin payment gateway.ewayeWAY Account.eway_rapideWAY Rapid gateway.worldpayWorldPay payment gateway.balanced_paymentsBalanced payment gateway.beanstreamBambora (formerly Beanstream).bluepayBluePay payment gateway.elavonElavon Virtual Merchant.first_data_globalFirst Data Global Gateway Virtual Terminal Account.hdfcHDFC Account.migsMasterCard Internet Gateway Service.nmiNMI gateway.ogoneIngenico ePayments (formerly Ogone).paymillPAYMILL payment gateway.paypal_payflow_proPayPal Payflow Pro gateway.sage_paySage Pay gateway.tco2Checkout payment gateway.wirecardWireCard Account.
Show all values[+]
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
Resource object representing hosted_page.
always returned
You can checkout an existing subscription(typically in the trial state) by passing in the plan, quantity and addon details(like Update a Subscription)
When the redirect URL is notified of the result, we would advise you to retrieve the subscription and verify the details.
Related Tutorial
Notes
As mentioned before this behavior is very similar to the update subscription API call. All the web hook events will be fired only after the submission of payment details by the customer and successful checkout of subscription.
Any errors related to the payment form that is submitted is handled as a response within the form so that the user is kept informed about the reason for failure to take corrective action.
Sample Request
curl https://{site}.chargebee.com/api/v1/hosted_pages/checkout_existing \
-u {site_api_key}:\
-d subscription[id]="__test__5SK0bLNFRFuCRrBP6" \
-d subscription[plan_id]="sub_plan1"
copy
curl https://{site}.chargebee.com/api/v1/hosted_pages/checkout_existing \
-u {site_api_key}:\
-d subscription[id]="__test__5SK0bLNFRFuCRrBP6" \
-d subscription[plan_id]="sub_plan1"
Sample Response [ JSON ]
Show more...
{"hosted_page": {
"created_at": 1517506795,
"embed": true,
"expires_at": 1517510395,
"id": "__test__IOc7dyRIztXRW3StXU1aEv72qcdxcuoscu",
"object": "hosted_page",
"state": "created",
"type": "checkout_existing",
"url": "https://yourapp.chargebee.com/pages/v2/__test__IOc7dyRIztXRW3StXU1aEv72qcdxcuoscu/checkout"
}}
URL Format POST
https://{site}.chargebee.com/api/v1/hosted_pages/checkout_existing
Should be true if the existing addons should be replaced with the ones that are being passed.
optional, boolean
The number of billing cycles the subscription runs before canceling. If not provided, then the billing cycles set for the plan is used. For Product Catalog v2, billing cycles set for plan-item price is used by default.
optional, integer, min=0
The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
Note :
- Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded - This parameter is not applicable for iframe messaging.
optional, string, max chars=250
The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.
Note :
- Cancel URL configured in Settings > Hosted Pages Settings would be overriden by this cancel URL.
Eg : http://yoursite.com?id=<hosted_page_id>&state=cancelled - This parameter is not applicable for iframe messaging and in-app checkout.
optional, string, max chars=250
You can pass through any content specific to the hosted page request and get it back after user had submitted the hosted page.
optional, string, max chars=2048
If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.
Note : For
in-app checkout, default is false.
optional, boolean, default=true
If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess & onCancel callbacks.
Note : This parameter is not applicable for
in-app checkout.
optional, boolean, default=false
Parameters for subscription
pass parameters as subscription[<param name>]
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
required, string, max chars=50
Identifier of the plan for this subscription.
optional, string, max chars=100
subscription[plan_quantity]
Represents the plan quantity for this subscription.
optional, integer, min=1
The new start date of a future
subscription. Applicable only for future
subscriptions.
optional, timestamp(UTC) in seconds
End of the trial period for the subscription. This overrides the trial period set for the plan. In Product Catalog v2 this overrides trial period set for the plan-item. Set it to 0
to have no trial period.
optional, timestamp(UTC) in seconds
Used to uniquely identify the coupon in your website/application and to integrate with Chargebee.
optional, string, max chars=50
Parameters for card
pass parameters as card[<param name>]
Name of the gateway this payment source is stored with.
optional, enumerated stringPossible values are
chargebeeChargebee test gateway.stripeStripe payment gateway.braintreeBraintree payment gateway.authorize_netAuthorize.net payment gateway.paypal_proPaypal Pro Account.pinPin payment gateway.ewayeWAY Account.eway_rapideWAY Rapid gateway.worldpayWorldPay payment gateway.balanced_paymentsBalanced payment gateway.beanstreamBambora (formerly Beanstream).bluepayBluePay payment gateway.elavonElavon Virtual Merchant.first_data_globalFirst Data Global Gateway Virtual Terminal Account.hdfcHDFC Account.migsMasterCard Internet Gateway Service.nmiNMI gateway.ogoneIngenico ePayments (formerly Ogone).paymillPAYMILL payment gateway.paypal_payflow_proPayPal Payflow Pro gateway.sage_paySage Pay gateway.tco2Checkout payment gateway.wirecardWireCard Account.
Show all values[+]
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
Identifier of the addon. Multiple addons can be passed.
optional, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, min=1
Resource object representing hosted_page.
always returned
Using this API, you can request your customers to update their payment method details or change their payment method. This is used in scenarios like customers updating their payment methods before the end of trial or customers switching among payment methods.
When this API is invoked, it returns a hosted page URL. When the customers are directed to this URL, they will be able to change/update their payment methods.
Depending on the payment methods (Card, PayPal Express Checkout, Amazon Payments) that you offer your customers, they will find options to switch among the various methods of payment.
Note:
- If the card[gateway] parameter is passed, and the customer chooses Card as a payment method, then the card details are stored in the gateway which is passed. However, if the card[gateway] parameter is passed and the customer chooses PayPal Express Checkout/Amazon Payments as a payment method, the gateway passed will be ignored.
- The option of embedding into an iframe is not supported for PayPal Express Checkout and Amazon Payments as customers are redirected to the respective website pages. Hence if you have PayPal Express Checkout/Amazon Payments configured and pass the parameter embed=true, this will result in an unsuccessful API request. Also, if you have all the three payment methods (Card, Paypal Express Checkout and Amazon Payments) configured and pass the parameter embed=true, the returned hosted page URL will show only Card Payment as a payment method.
Sample Request
curl https://{site}.chargebee.com/api/v1/hosted_pages/update_payment_method \
-u {site_api_key}:\
-d customer[id]="__test__5SK0bLNFRFuCV8XPz" \
-d card[gateway]="stripe"
copy
curl https://{site}.chargebee.com/api/v1/hosted_pages/update_payment_method \
-u {site_api_key}:\
-d customer[id]="__test__5SK0bLNFRFuCV8XPz" \
-d card[gateway]="stripe"
Sample Response [ JSON ]
Show more...
{"hosted_page": {
"created_at": 1517506808,
"embed": true,
"expires_at": 1517593208,
"id": "__test__LCYvWQeyDm1CRJ2XtHLWbMcXBC1qIpwX",
"object": "hosted_page",
"state": "created",
"type": "update_payment_method",
"url": "https://yourapp.chargebee.com/pages/v2/__test__LCYvWQeyDm1CRJ2XtHLWbMcXBC1qIpwX/update_payment_method"
}}
URL Format POST
https://{site}.chargebee.com/api/v1/hosted_pages/update_payment_method
The customers will be redirected to this URL upon successful checkout. The hosted page id and state will be passed as parameters to this URL.
Note :
- Redirect URL configured in Settings > Hosted Pages Settings would be overriden by this redirect URL.
Eg : http://yoursite.com?id=<hosted_page_id>&state=succeeded - This parameter is not applicable for iframe messaging.
optional, string, max chars=250
The customers will be redirected to this URL upon canceling checkout. The hosted page id and state will be passed as parameters to this URL.
Note :
- Cancel URL configured in Settings > Hosted Pages Settings would be overriden by this cancel URL.
Eg : http://yoursite.com?id=<hosted_page_id>&state=cancelled - This parameter is not applicable for iframe messaging and in-app checkout.
optional, string, max chars=250
You can pass through any content specific to the hosted page request and get it back after user had submitted the hosted page.
optional, string, max chars=2048
If true then hosted page formatted to be shown in iframe. If false, it is formatted to be shown as a separate page.
Note : For
in-app checkout, default is false.
optional, boolean, default=true
If true then iframe will communicate with the parent window. Applicable only for embedded(iframe) hosted pages. If you're using iframe_messaging you need to implement onSuccess & onCancel callbacks.
Note : This parameter is not applicable for
in-app checkout.
optional, boolean, default=false
Parameters for customer
pass parameters as customer[<param name>]
Identifier of the customer.
required, string, max chars=50
Parameters for card
pass parameters as card[<param name>]
Name of the gateway this payment source is stored with.
optional, enumerated stringPossible values are
chargebeeChargebee test gateway.stripeStripe payment gateway.braintreeBraintree payment gateway.authorize_netAuthorize.net payment gateway.paypal_proPaypal Pro Account.pinPin payment gateway.ewayeWAY Account.eway_rapideWAY Rapid gateway.worldpayWorldPay payment gateway.balanced_paymentsBalanced payment gateway.beanstreamBambora (formerly Beanstream).bluepayBluePay payment gateway.elavonElavon Virtual Merchant.first_data_globalFirst Data Global Gateway Virtual Terminal Account.hdfcHDFC Account.migsMasterCard Internet Gateway Service.nmiNMI gateway.ogoneIngenico ePayments (formerly Ogone).paymillPAYMILL payment gateway.paypal_payflow_proPayPal Payflow Pro gateway.sage_paySage Pay gateway.tco2Checkout payment gateway.wirecardWireCard Account.
Show all values[+]
Resource object representing hosted_page.
always returned
This operation is only supported by the 2Checkout payment gateway.
Sample Request
curl https://{site}.chargebee.com/api/v1/hosted_pages/checkout_onetime_charge \
-u {site_api_key}:\
-d amount=1000 \
-d description="Support charge" \
-d card[gateway]="tco" \
-d subscription[id]="__test__3Nl9RLTRcPq8iN4D"
copy
curl https://{site}.chargebee.com/api/v1/hosted_pages/checkout_onetime_charge \
-u {site_api_key}:\
-d amount=1000 \
-d description="Support charge" \
-d card[gateway]="tco" \
-d subscription[id]="__test__3Nl9RLTRcPq8iN4D"
Sample Response [ JSON ]
Show more...
{"hosted_page": {
"created_at": 1517479643,
"embed": false,
"expires_at": 1517483243,
"id": "__test__5X3rIcaJacdULq1RmylwfFfmKZg66jFa5",
"object": "hosted_page",
"state": "created",
"type": "checkout_onetime_charge",
"url": "https://yourapp.chargebee.com/pages/__test__5X3rIcaJacdULq1RmylwfFfmKZg66jFa5/checkout"
}}
URL Format POST
https://{site}.chargebee.com/api/v1/hosted_pages/checkout_onetime_charge
The amount to be charged.
required, in cents, min=1
Description for this charge.
required, string, max chars=250
You can pass through any content specific to the hosted page request and get it back after user had submitted the hosted page.
optional, string, max chars=2048
Parameters for subscription
pass parameters as subscription[<param name>]
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
required, string, max chars=50
Parameters for card
pass parameters as card[<param name>]
Name of the gateway this payment source is stored with.
optional, enumerated stringPossible values are
chargebeeChargebee test gateway.stripeStripe payment gateway.braintreeBraintree payment gateway.authorize_netAuthorize.net payment gateway.paypal_proPaypal Pro Account.pinPin payment gateway.ewayeWAY Account.eway_rapideWAY Rapid gateway.worldpayWorldPay payment gateway.balanced_paymentsBalanced payment gateway.beanstreamBambora (formerly Beanstream).bluepayBluePay payment gateway.elavonElavon Virtual Merchant.first_data_globalFirst Data Global Gateway Virtual Terminal Account.hdfcHDFC Account.migsMasterCard Internet Gateway Service.nmiNMI gateway.ogoneIngenico ePayments (formerly Ogone).paymillPAYMILL payment gateway.paypal_payflow_proPayPal Payflow Pro gateway.sage_paySage Pay gateway.tco2Checkout payment gateway.wirecardWireCard Account.
Show all values[+]
Resource object representing hosted_page.
always returned
This operation is only supported by the 2Checkout payment gateway.
Sample Request
curl https://{site}.chargebee.com/api/v1/hosted_pages/checkout_onetime_addons \
-u {site_api_key}:\
-d addons[id][0]="non_recurring_addon" \
-d addons[quantity][0]=1 \
-d subscription[id]="__test__3Nl9RLTRcPq8eH3z" \
-d card[gateway]="tco"
copy
curl https://{site}.chargebee.com/api/v1/hosted_pages/checkout_onetime_addons \
-u {site_api_key}:\
-d addons[id][0]="non_recurring_addon" \
-d addons[quantity][0]=1 \
-d subscription[id]="__test__3Nl9RLTRcPq8eH3z" \
-d card[gateway]="tco"
Sample Response [ JSON ]
Show more...
{"hosted_page": {
"created_at": 1517479643,
"embed": false,
"expires_at": 1517483243,
"id": "__test__0aMPyYyzZNVFNcu1qDoh9aQ7UERW8YJ1g",
"object": "hosted_page",
"state": "created",
"type": "checkout_onetime_addons",
"url": "https://yourapp.chargebee.com/pages/__test__0aMPyYyzZNVFNcu1qDoh9aQ7UERW8YJ1g/checkout"
}}
URL Format POST
https://{site}.chargebee.com/api/v1/hosted_pages/checkout_onetime_addons
The coupon code to be applied.
optional, string, max chars=50
You can pass through any content specific to the hosted page request and get it back after user had submitted the hosted page.
optional, string, max chars=2048
Parameters for subscription
pass parameters as subscription[<param name>]
A unique and immutable identifier for the subscription. If not provided, it is autogenerated.
required, string, max chars=50
Parameters for card
pass parameters as card[<param name>]
Name of the gateway this payment source is stored with.
optional, enumerated stringPossible values are
chargebeeChargebee test gateway.stripeStripe payment gateway.braintreeBraintree payment gateway.authorize_netAuthorize.net payment gateway.paypal_proPaypal Pro Account.pinPin payment gateway.ewayeWAY Account.eway_rapideWAY Rapid gateway.worldpayWorldPay payment gateway.balanced_paymentsBalanced payment gateway.beanstreamBambora (formerly Beanstream).bluepayBluePay payment gateway.elavonElavon Virtual Merchant.first_data_globalFirst Data Global Gateway Virtual Terminal Account.hdfcHDFC Account.migsMasterCard Internet Gateway Service.nmiNMI gateway.ogoneIngenico ePayments (formerly Ogone).paymillPAYMILL payment gateway.paypal_payflow_proPayPal Payflow Pro gateway.sage_paySage Pay gateway.tco2Checkout payment gateway.wirecardWireCard Account.
Show all values[+]
Parameters for addons. Multiple addons can be passed by specifying unique indices.
pass parameters as addons[<param name>][<idx:0..n>]
Identifier of the addon. Multiple addons can be passed.
required, string, max chars=100
Addon quantity. Applicable only for the quantity based addons. Should be passed with the same index as that of associated addon id.
optional, integer, default=1, min=1
Resource object representing hosted_page.
always returned
Sample Request
curl https://{site}.chargebee.com/api/v1/hosted_pages/__test__notOvqU0psFG0HAxwoePXHQJAN2ruDhG \
-u {site_api_key}:
copy
curl https://{site}.chargebee.com/api/v1/hosted_pages/__test__notOvqU0psFG0HAxwoePXHQJAN2ruDhG \
-u {site_api_key}:
Sample Response [ JSON ]
Show more...
{"hosted_page": {
"created_at": 1517506803,
"embed": true,
"expires_at": 1517510403,
"id": "__test__notOvqU0psFG0HAxwoePXHQJAN2ruDhG",
"object": "hosted_page",
"state": "created",
"type": "checkout_existing",
"url": "https://yourapp.chargebee.com/pages/v2/__test__notOvqU0psFG0HAxwoePXHQJAN2ruDhG/checkout"
}}
URL Format GET
https://{site}.chargebee.com/api/v1/hosted_pages/{hosted_page_id}
Resource object representing hosted_page.
always returned