Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Revenue Rules: Get the rule associated with a charge

Revenue Rules: Get the rule associated with a charge

Overview

This REST API reference describes how to get the revenue recognition rule associated with a subscription charge by specifying the charge ID. Request and response field descriptions and sample code are provided.

Request

  • Production: GET https://api.zuora.com/rest/v1/revenue-recognition-rules/subscription-charges/{charge-key}
  • API Sandbox: GET https://apisandbox-api.zuora.com/rest/v1/revenue-recognition-rules/subscription-charges/{charge-key}

Request header

The Accept request header is optional. Only JSON is returned.

Request parameters

charge-key

required

path

ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012.

Response

This response includes the revenue recognition rule associated with a subscription charge by the specified charge ID.

revenueRecognitionRuleName

The name of the revenue recognition rule governing the revenue schedule.

success

Returns true if the request is successful. Otherwise, returns false.

processId

The internal process ID used to assist Zuora support. Returned only if success is false.

reasons

Information describing the reason for the result. Returned only if success is false.

code

An eight-digit numeric error code.

message

A description of the error.

 

Examples

HTTP/JSON request:

HTTP/JSON request:

GET https://api.zuora.com/rest/v1/revenue-recognition-rules/subscription-charges/2c92c0f943977b4f0143b22488ef444a

JSON response:


{
   "revenueRecognitionRuleName": "Recognize upon invoicing",
    "success": true
}

Last modified
13:32, 1 Apr 2015

Tags

Classifications

(not set)