Bundle Configuration

Determines how bundled products or services are structured and processed. This policy guides allocation and treatment of bundle components when received via APIs.

Get Bundles Policy

get

/apis/policy-sets/v1/policy/bundle

• To retrieve all the Bundle Policy details having Bundle Parent List, Bundle Component List and Bundle Component Product details.

Path parameters

pagestringOptional

This is optional field. Page represents page number of bundle policy list.

page_sizestringOptional

This is optional field. Page size represents how many records available on each page.

activebooleanOptional

A boolean field indicating whether the policy is Active or not. If set to True, the policy is Active; if false, it's Inactive.

config_keystringOptional

This is a unique identifier for bundle policy.This will retrieve details of all components

product_namestringOptional

This is the name of child product of parent components. This will retrieve all the product details.

Responses

200

Get bundles Policy

application/json

compliance_idstringRequired

A system-generated compliance ID to retrieve the Revenue Rules Policies

compliance_namestringRequired

Name of the policy fetched by the system

get/apis/policy-sets/v1/policy/bundle

GET /apis/policy-sets/v1/policy/bundle HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*

200

Get bundles Policy

{
  "compliance_id": "58b0a0b3-5a37-4e0d-983b-daae9def4d6b",
  "compliance_name": "Bundle Configuration",
  "compliance_spec": [
    {
      "bundle_config": {
        "carves_eligible": "",
        "carves_liability_segment": "",
        "carves_revenue_segment": "",
        "component_product_id": "Assign SSP",
        "component_product_name": "Book-DAILY-CONDENSED",
        "config_description": "BooksFirm",
        "config_key": "bundle_config_02",
        "contract_liability_segment": "",
        "contract_revenue_segment": "",
        "default_option_for_all_fields": "copy_from_parent",
        "po_number": "",
        "revenue_end_date": "",
        "revenue_start_date": "",
        "split_percentage": "35",
        "ssp_date": ""
      },
      "config_key": "bundle_config_02",
      "created_by": "[e-mail]",
      "created_on": "2025-10-09 10:51:26.424",
      "default_option_for_all_fields": "copy_from_parent",
      "file_name": "test-rrapi-qa - bundle config.csv",
      "request_response_id": "6316f197-ae85-4dfa-ab9e-9c6b8457fed8",
      "split_percentage": 35,
      "unique_id": "47df4640-06ae-4869-b357-f13df154462e",
      "updated_by": "[e-mail]",
      "updated_on": "2025-10-09 10:51:26.424"
    }
  ]
}

Post Bundles Policy

post

/apis/policy-sets/v1/policy/bundle

To upload new bundle policy or update the existing one.

Body

filefile · binaryRequired

CSV file to be uploaded with Bundle Configuration details. Sample CSV Bundle File is attached below for reference.

date_formattext · %m/%d/%YRequired

Start Date and End Date must be in mm-dd-yyyy format.

Responses

200

Set bundles Policy

application/json

file_idstringRequired

A system generated unique alpha-numeric number.

messagestringRequired

Displays the outcome of the action. It is commonly used to provide success confirmations, error details, or other informational responses from the API after the operation is executed.

post/apis/policy-sets/v1/policy/bundle

POST /apis/policy-sets/v1/policy/bundle HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Content-Type: multipart/form-data
Accept: */*
Content-Length: 32

{
  "file": null,
  "date_format": null
}

200

Set bundles Policy

{
  "file_id": "324db42c-316d-4aea-b349-667563140380",
  "message": "File successfully uploaded"
}

Download Bundles Policy Csv

get

/apis/policy-sets/v1/policy/bundle/download/{file_id}

This API is used to download the uploaded CSV Bundle configuration file.

Path parameters

file_idstringRequired

A system generated file ID on uploading CSV file.

Responses

200

Get bundles Policy CSV file.

application/json

string · binaryOptional

get/apis/policy-sets/v1/policy/bundle/download/{file_id}

GET /apis/policy-sets/v1/policy/bundle/download/{file_id} HTTP/1.1
Host: {realm}.{env}.rightrev.cloud/
Accept: */*

200

Get bundles Policy CSV file.

{}