Skip to content

Latest commit

 

History

History
110 lines (70 loc) · 5.01 KB

RevenueRulesApi.md

File metadata and controls

110 lines (70 loc) · 5.01 KB
Raw

Zuora::RevenueRulesApi

All URIs are relative to https://rest.zuora.com

Method HTTP request Description
get_revenue_rec_ruleby_product_rate_plan_charge GET /v1/revenue-recognition-rules/product-charges/{charge-key} Get revenue recognition rule by product rate plan charge
get_revenue_rec_rules GET /v1/revenue-recognition-rules/subscription-charges/{charge-key} Get revenue recognition rule by subscription charge

get_revenue_rec_ruleby_product_rate_plan_charge

GETRevenueRecognitionRuleAssociationType get_revenue_rec_ruleby_product_rate_plan_charge(charge_key)

Get revenue recognition rule by product rate plan charge

Note: This feature is only available if you have the Advanced AR Settlement feature enabled. The Advanced AR Settlement feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the revenue recognition rule associated with a production rate plan charge by specifying the charge ID.

Example

# load the gem
require 'zuora'

api_instance = Zuora::RevenueRulesApi.new

charge_key = "charge_key_example" # String | The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82. 


begin
  #Get revenue recognition rule by product rate plan charge
  result = api_instance.get_revenue_rec_ruleby_product_rate_plan_charge(charge_key)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling RevenueRulesApi->get_revenue_rec_ruleby_product_rate_plan_charge: #{e}"
end

Parameters

Name Type Description Notes
charge_key String The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82.

Return type

GETRevenueRecognitionRuleAssociationType

Authorization

No authorization required

HTTP request headers

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

get_revenue_rec_rules

GETRevenueRecognitionRuleAssociationType get_revenue_rec_rules(charge_key, opts)

Get revenue recognition rule by subscription charge

Retrieves the revenue recognition rule associated with a subscription charge by specifying the charge ID. Request and response field descriptions and sample code are provided.

Example

# load the gem
require 'zuora'

api_instance = Zuora::RevenueRulesApi.new

charge_key = "charge_key_example" # String | The unique ID of the subscription rate plan charge. For example, 402892793e173340013e173b81000012. 

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
  #Get revenue recognition rule by subscription charge
  result = api_instance.get_revenue_rec_rules(charge_key, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling RevenueRulesApi->get_revenue_rec_rules: #{e}"
end

Parameters

Name Type Description Notes
charge_key String The unique ID of the subscription rate plan charge. For example, 402892793e173340013e173b81000012.
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

GETRevenueRecognitionRuleAssociationType

Authorization

No authorization required

HTTP request headers

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