GET /hosted_pages/{hosted-page-id}
When you retrieve a hosted page whose status is successful, the content attribute has the following objects based on the type of the hosted page.
type of hosted page | content attribute constituents |
checkout_new | * customer: the object representing the details of the Customer for whom the subscription was created. * subscription: the new Subscription object created. * card: the Card object if the payment method type used was card. * invoice: the Invoice object, if an invoice was generated. |
checkout_existing | * customer: the object representing the details of the Customer whose subscription was changed. * subscription: the updated Subscription object created. * card: the Card object if the payment method type used was card. * invoice: the Invoice object, if an invoice was generated for the subscription change. |
update_payment_method | * customer: the object representing the details of the Customer whose subscription was changed. * card: the Card object if the new payment method added was of type card. |
pre_cancel | retention: Use the bypass flag in this object to route the cancellation flow to the merchants' portal or the Chargebee Retention. * If bypass flag is true, you should route the end-customers to your native cancellation flow. * If the bypass flag is false, you should route the end-customers to the hosted page URL. Note: Retention is currently in beta. To enable Retention, Contact Support. |
collect_now | * transactions: this object should contain a list of transactions triggered from the collect_now hosted page. Each transaction in the list should be represented as an array that includes relevant information about the transaction, such as transaction ID, customer ID, amount, currency, payment method, and any other relevant details. * customer: this object should contain the customer record associated with the transaction. The key, customer_id is used to link the transaction to the corresponding customer record. |
Servers
- {protocol}://{site}.{environment}:{port}/api/v2
- {protocol}://{site}-test.{environment}:{port}/api/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
hosted-page-id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
chargebee-request-origin-device |
String | No |
The device from which the customer has made the request |
chargebee-business-entity-id |
String | No |
If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation. |
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 |
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.