All URIs are relative to https://rest.zuora.com
| Method | HTTP request | Description |
|---|---|---|
| object_delete_product_rate_plan_charge | DELETE /v1/object/product-rate-plan-charge/{id} | CRUD: Delete product rate plan charge |
| object_get_product_rate_plan_charge | GET /v1/object/product-rate-plan-charge/{id} | CRUD: Get product rate plan charge |
| object_post_product_rate_plan_charge | POST /v1/object/product-rate-plan-charge | CRUD: Create product rate plan charge |
| object_put_product_rate_plan_charge | PUT /v1/object/product-rate-plan-charge/{id} | CRUD: Update product rate plan charge |
ProxyDeleteResponse object_delete_product_rate_plan_charge(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
CRUD: Delete product rate plan charge
Deletes a product rate plan charge.
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.ProductRatePlanChargesApi()
id = 'id_example' # str | The unique ID of the product rate plan charge to be deleted. For example, 2c93808457d787030157e031fcd34e19.
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)
zuora_track_id = 'zuora_track_id_example' # str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
try:
# CRUD: Delete product rate plan charge
api_response = api_instance.object_delete_product_rate_plan_charge(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProductRatePlanChargesApi->object_delete_product_rate_plan_charge: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The unique ID of the product rate plan charge to be deleted. For example, 2c93808457d787030157e031fcd34e19. | |
| 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] |
| zuora_track_id | str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). | [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]
ProxyGetProductRatePlanCharge object_get_product_rate_plan_charge(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id, fields=fields)
CRUD: Get product rate plan charge
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.ProductRatePlanChargesApi()
id = 'id_example' # str | The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19.
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)
zuora_track_id = 'zuora_track_id_example' # str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
fields = 'fields_example' # str | Object fields to return (optional)
try:
# CRUD: Get product rate plan charge
api_response = api_instance.object_get_product_rate_plan_charge(id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id, fields=fields)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProductRatePlanChargesApi->object_get_product_rate_plan_charge: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19. | |
| 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] |
| zuora_track_id | str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). | [optional] |
| fields | str | Object fields to return | [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]
ProxyCreateOrModifyResponse object_post_product_rate_plan_charge(create_request, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
CRUD: Create product rate plan charge
Creates a product rate plan charge for a specified rate plan charge. Product rate plan charges can be of three types, one-time fees, recurring fees, and usage fees.
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.ProductRatePlanChargesApi()
create_request = zuora_client.ProxyCreateProductRatePlanCharge() # ProxyCreateProductRatePlanCharge |
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)
zuora_track_id = 'zuora_track_id_example' # str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
try:
# CRUD: Create product rate plan charge
api_response = api_instance.object_post_product_rate_plan_charge(create_request, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProductRatePlanChargesApi->object_post_product_rate_plan_charge: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| create_request | ProxyCreateProductRatePlanCharge | ||
| 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] |
| zuora_track_id | str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). | [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]
ProxyCreateOrModifyResponse object_put_product_rate_plan_charge(modify_request, id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
CRUD: Update product rate plan charge
Updates the information about a product rate plan charge.
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.ProductRatePlanChargesApi()
modify_request = zuora_client.ProxyModifyProductRatePlanCharge() # ProxyModifyProductRatePlanCharge |
id = 'id_example' # str | The unique ID of the product rate plan charge to be updated. For example, 2c93808457d787030157e031fcd34e19.
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)
zuora_track_id = 'zuora_track_id_example' # str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`\"`), and quote (`'`). (optional)
try:
# CRUD: Update product rate plan charge
api_response = api_instance.object_put_product_rate_plan_charge(modify_request, id, zuora_entity_ids=zuora_entity_ids, zuora_track_id=zuora_track_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ProductRatePlanChargesApi->object_put_product_rate_plan_charge: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| modify_request | ProxyModifyProductRatePlanCharge | ||
| id | str | The unique ID of the product rate plan charge to be updated. For example, 2c93808457d787030157e031fcd34e19. | |
| 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] |
| zuora_track_id | str | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). | [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]