GET /hosted_pages
This API retrieves the list of hosted page resources.
Servers
- {protocol}://{site}.{environment}:{port}/api/v2
- {protocol}://{site}-test.{environment}:{port}/api/v2
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 chargebee-request-origin-user is ignored. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Object | No |
optional, string filterUnique identifier generated for each hosted page requested.Supported operators : is, is_not, starts_with, in, not_inExample → id[is] = "Edi69nxpu6BeGBd9Fjcd0tqCSwb0sRcuKa" |
limit |
Integer | No |
The number of resources to be returned. Default value: 10 |
type |
Object | No |
optional, enumerated string filterType of the requested hosted page. Possible values are : checkout_new, checkout_existing, update_payment_method, manage_payment_sources, collect_now, extend_subscription, checkout_one_time, pre_cancel.Supported operators : is, is_not, in, not_inExample → type[is_not] = "checkout_new" |
state |
Object | No |
optional, enumerated string filterIndicating the current state of the hosted page resource. Possible values are : created, requested, succeeded, cancelled, acknowledged.Supported operators : is, is_not, in, not_inExample → state[is] = "succeeded" |
offset |
String | No |
Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set |
updated_at |
Object | No |
optional, timestamp(UTC) in seconds filterTimestamp indicating when this hosted page was last updated.Supported operators : after, before, on, betweenExample → updated_at[on] = "1490784813" |
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.