> This page is for Developers. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://zuora.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server. # Reverse fund rollover POST https://rest.test.zuora.com/v1/ppdd/reverse-rollover Content-Type: application/json This REST API reference describes how to manually reverse fund rollover from source validity period to destination validity period. There are no path or query parameters. **Note**: This API will not work if the associated prepayment charge has rollover enabled. Reference: https://zuora.ferndocs.com/developers/api-reference/zuora-api/advanced-consumption-billing/prepaid-with-drawdown/post-reverse-rollover ## Authentication - `Authorization` header (bearer token, required) — Use `Bearer {{token}}` in the `Authorization` header for authentication. ## Servers - `https://rest.test.zuora.com` (US Developer & Central Sandbox (incl. Test Drive), default) - `https://rest.sandbox.na.zuora.com` (US API Sandbox Cloud 1) - `https://rest.apisandbox.zuora.com` (US API Sandbox Cloud 2) - `https://rest.na.zuora.com` (US Production Cloud 1) - `https://rest.zuora.com` (US Production Cloud 2) - `https://rest.test.eu.zuora.com` (EU Developer & Central Sandbox) - `https://rest.sandbox.eu.zuora.com` (EU API Sandbox) - `https://rest.eu.zuora.com` (EU Production) - `https://rest.test.ap.zuora.com` (APAC Developer & Central Sandbox) - `https://rest.ap.zuora.com` (APAC Production) ## Request ### Headers - `Idempotency-Key` (string, optional) — Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. - `Accept-Encoding` (string, optional) — Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. - `Content-Encoding` (string, optional) — Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. - `Zuora-Entity-Ids` (string, optional) — 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 should not set this header. - `Zuora-Org-Ids` (string, optional) — Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs. - `Zuora-Track-Id` (string, optional) — 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 (`'`). - `Zuora-Version` (string, optional) — The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). ### Body (application/json) This endpoint expects a POSTReverseRolloverRequestType. - `destinationValidityPeriod` (DestinationValidityPeriodInfo, required) — Date range of the destination validity period to which the funds are transferred. It should be close to the source validity period. - `prepaymentUom` (string, required) — Specifies the units of measure for prepayment charge. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. **Values**: a valid unit of measure - `sourceValidityPeriod` (SourceValidityPeriodInfo, required) — Date range of the source validity period from which the funds are transferred. It should be close to the destination validity period. - `subscriptionNumber` (string, required) — The unique identifier number of the subscription. ## Response ### 200 OK - `message` (string, optional) — Indicates the result. - `reverseRolloverFundCount` (long, optional) — Indicates the number of funds which have been rolled back. - `success` (boolean, optional) — Indicates whether the call succeeded. ## Errors ### 500 Internal Server Error Internal Server Error - `reasons` (list of ErrorResponseReasonsItems, optional) ### 400 Client Request Error Request Errors - `processId` (string, optional) — The ID of the process that handles the operation. - `reasons` (list of CommonResponseReasonsItems, optional) — The container of the error code and message. This field is available only if the `success` field is `false`. - `requestId` (string, optional) — Unique identifier of the request. - `success` (boolean, optional) — Indicates whether the call succeeded. ## Types ### DestinationValidityPeriodInfo Date range of the destination validity period to which the funds are transferred. It should be close to the source validity period. - `endDate` (date, required) — End date of the destination validity period. - `startDate` (date, required) — Start date of the destination validity period. ### SourceValidityPeriodInfo Date range of the source validity period from which the funds are transferred. It should be close to the destination validity period. - `endDate` (date, required) — End date of the source validity period. - `startDate` (date, required) — Start date of the source validity period. ### ErrorResponseReasonsItems - `code` (string, optional) — The error code of response. - `message` (string, optional) — The detail information of the error response ### CommonResponseReasonsItems - `code` (string, optional) — The error code of response. - `message` (string, optional) — The detail information of the error response ## Examples **Request** ```json { "destinationValidityPeriod": { "endDate": "2024-01-01", "startDate": "2023-01-01" }, "prepaymentUom": "Each", "sourceValidityPeriod": { "endDate": "2025-01-01", "startDate": "2024-01-01" }, "subscriptionNumber": "A-S00000009" } ``` **Response** ```json { "message": "Reverse rollover is done", "reverseRolloverFundCount": 1, "success": true } ``` **SDK Code** ```python response import requests url = "https://rest.test.zuora.com/v1/ppdd/reverse-rollover" payload = { "destinationValidityPeriod": { "endDate": "2024-01-01", "startDate": "2023-01-01" }, "prepaymentUom": "Each", "sourceValidityPeriod": { "endDate": "2025-01-01", "startDate": "2024-01-01" }, "subscriptionNumber": "A-S00000009" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript response const url = 'https://rest.test.zuora.com/v1/ppdd/reverse-rollover'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"destinationValidityPeriod":{"endDate":"2024-01-01","startDate":"2023-01-01"},"prepaymentUom":"Each","sourceValidityPeriod":{"endDate":"2025-01-01","startDate":"2024-01-01"},"subscriptionNumber":"A-S00000009"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go response package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://rest.test.zuora.com/v1/ppdd/reverse-rollover" payload := strings.NewReader("{\n \"destinationValidityPeriod\": {\n \"endDate\": \"2024-01-01\",\n \"startDate\": \"2023-01-01\"\n },\n \"prepaymentUom\": \"Each\",\n \"sourceValidityPeriod\": {\n \"endDate\": \"2025-01-01\",\n \"startDate\": \"2024-01-01\"\n },\n \"subscriptionNumber\": \"A-S00000009\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby response require 'uri' require 'net/http' url = URI("https://rest.test.zuora.com/v1/ppdd/reverse-rollover") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"destinationValidityPeriod\": {\n \"endDate\": \"2024-01-01\",\n \"startDate\": \"2023-01-01\"\n },\n \"prepaymentUom\": \"Each\",\n \"sourceValidityPeriod\": {\n \"endDate\": \"2025-01-01\",\n \"startDate\": \"2024-01-01\"\n },\n \"subscriptionNumber\": \"A-S00000009\"\n}" response = http.request(request) puts response.read_body ``` ```java response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://rest.test.zuora.com/v1/ppdd/reverse-rollover") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"destinationValidityPeriod\": {\n \"endDate\": \"2024-01-01\",\n \"startDate\": \"2023-01-01\"\n },\n \"prepaymentUom\": \"Each\",\n \"sourceValidityPeriod\": {\n \"endDate\": \"2025-01-01\",\n \"startDate\": \"2024-01-01\"\n },\n \"subscriptionNumber\": \"A-S00000009\"\n}") .asString(); ``` ```php response request('POST', 'https://rest.test.zuora.com/v1/ppdd/reverse-rollover', [ 'body' => '{ "destinationValidityPeriod": { "endDate": "2024-01-01", "startDate": "2023-01-01" }, "prepaymentUom": "Each", "sourceValidityPeriod": { "endDate": "2025-01-01", "startDate": "2024-01-01" }, "subscriptionNumber": "A-S00000009" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp response using RestSharp; var client = new RestClient("https://rest.test.zuora.com/v1/ppdd/reverse-rollover"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"destinationValidityPeriod\": {\n \"endDate\": \"2024-01-01\",\n \"startDate\": \"2023-01-01\"\n },\n \"prepaymentUom\": \"Each\",\n \"sourceValidityPeriod\": {\n \"endDate\": \"2025-01-01\",\n \"startDate\": \"2024-01-01\"\n },\n \"subscriptionNumber\": \"A-S00000009\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift response import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "destinationValidityPeriod": [ "endDate": "2024-01-01", "startDate": "2023-01-01" ], "prepaymentUom": "Each", "sourceValidityPeriod": [ "endDate": "2025-01-01", "startDate": "2024-01-01" ], "subscriptionNumber": "A-S00000009" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://rest.test.zuora.com/v1/ppdd/reverse-rollover")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```