All URIs are relative to https://rest.zuora.com
| Method | HTTP request | Description |
|---|---|---|
| get_hosted_pages | GET /v1/hostedpages | Return hosted pages |
GetHostedPagesType get_hosted_pages(zuora_entity_ids=zuora_entity_ids, page_size=page_size, version_number=version_number)
Return hosted pages
The hostedpages call returns the Payment Pages configuration metadata, specifically, page ID, page version, payment method type. The following are the version-specific and general REST requests for Payment Pages: * The request for Payment Pages 1.0 configuration information: GET <BaseURL>/hostedpages?version=1 * The request for Payment Pages 2.0 configuration information: GET <BaseURL>/hostedpages?version=2 * The request for all versions of Payment Pages configuration information: GET <BaseURL>/hostedpages ## Notes If you do not have the corresponding tenant setting enabled, e.g., the request version parameter set to 2 with the Payment Pages 2.0 setting disabled, you will receive an error.
from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = zuora_client.HostedPagesApi()
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. (optional)
page_size = 20 # int | Number of rows returned per page. (optional) (default to 20)
version_number = 'version_number_example' # str | Version of the Payment Pages for which you want to retrieve the configuration information. Specify 1 for Payment Pages 1.0 or 2 for Payment Pages 2.0. If omitted, information for all versions of Payment Pages are returned. The response also depends on your tenant settings for Payment Pages 1.0 and Payment Pages 2.0. For example, if only the tenant setting for Payment Pages 2.0 is enabled, the response will only contain information for Payment Pages 2.0 forms even when this parameter is omitted. (optional)
try:
# Return hosted pages
api_response = api_instance.get_hosted_pages(zuora_entity_ids=zuora_entity_ids, page_size=page_size, version_number=version_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling HostedPagesApi->get_hosted_pages: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| zuora_entity_ids | str | An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. | [optional] |
| page_size | int | Number of rows returned per page. | [optional] [default to 20] |
| version_number | str | Version of the Payment Pages for which you want to retrieve the configuration information. Specify 1 for Payment Pages 1.0 or 2 for Payment Pages 2.0. If omitted, information for all versions of Payment Pages are returned. The response also depends on your tenant settings for Payment Pages 1.0 and Payment Pages 2.0. For example, if only the tenant setting for Payment Pages 2.0 is enabled, the response will only contain information for Payment Pages 2.0 forms even when this parameter is omitted. | [optional] |
No authorization required
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]