Skip to content

Latest commit

 

History

History
118 lines (76 loc) · 5.48 KB

ProductRatePlanChargesApi.md

File metadata and controls

118 lines (76 loc) · 5.48 KB
Raw

Zuora::ProductRatePlanChargesApi

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 ProductRatePlanCharge
object_get_product_rate_plan_charge GET /v1/object/product-rate-plan-charge/{id} CRUD: Retrieve ProductRatePlanCharge

object_delete_product_rate_plan_charge

ProxyDeleteResponse object_delete_product_rate_plan_charge(id, opts)

CRUD: Delete ProductRatePlanCharge

Example

# load the gem
require 'zuora'

api_instance = Zuora::ProductRatePlanChargesApi.new

id = "id_example" # String | Object id

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #CRUD: Delete ProductRatePlanCharge
  result = api_instance.object_delete_product_rate_plan_charge(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ProductRatePlanChargesApi->object_delete_product_rate_plan_charge: #{e}"
end

Parameters

Name Type Description Notes
id String Object id
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

ProxyDeleteResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8

object_get_product_rate_plan_charge

ProxyGetProductRatePlanCharge object_get_product_rate_plan_charge(id, opts)

CRUD: Retrieve ProductRatePlanCharge

Example

# load the gem
require 'zuora'

api_instance = Zuora::ProductRatePlanChargesApi.new

id = "id_example" # String | Object id

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  fields: "fields_example" # String | Object fields to return
}

begin
  #CRUD: Retrieve ProductRatePlanCharge
  result = api_instance.object_get_product_rate_plan_charge(id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling ProductRatePlanChargesApi->object_get_product_rate_plan_charge: #{e}"
end

Parameters

Name Type Description Notes
id String Object id
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
fields String Object fields to return [optional]

Return type

ProxyGetProductRatePlanCharge

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8