Conga

Conga Price Rules API

The Price Rules API from Conga — 2 operation(s) for price rules.

GitHub OpenAPI
Business capability
Pricing Management BC-440

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /rule-sets/{ParentId}/rules Delete several price rules from a rule set · Delete price rules #
Ask an LLM
“How many price rules can I bulk delete from a rule set in one call?”
“Does bulk deleting price rules also remove their price rule entries?”
Tell an agent destructive · confirm first
Bulk delete several price rules from rule set {ParentId}.
Remove up to 100 price rules and their entries from price rule set {ParentId}.
GET /rule-sets/{ParentId}/rules List the price rules in a price rule set · Retrieve price rules #
Ask an LLM
“How do I see all the price rules inside one price rule set?”
“Can I filter or sort the price rules belonging to a rule set?”
Tell an agent
List all price rules in rule set {ParentId}.
Show price rules in rule set {ParentId} matching {filter}.
PATCH /rule-sets/{ParentId}/rules Update several price rules in a rule set · Update price rules #
Ask an LLM
“Can I change fields on many price rules in one bulk update?”
“Which field of a price rule can't be modified in a bulk update?”
Tell an agent
Bulk update several price rules in rule set {ParentId}.
Apply field changes to multiple price rules of price rule set {ParentId} together.
POST /rule-sets/{ParentId}/rules Add price rules to a price rule set · Create price rules #
Ask an LLM
“What's the way to add several new price rules to a rule set at once?”
“Do I get generated IDs back when I create price rules in a rule set?”
Tell an agent
Create a batch of new price rules in rule set {ParentId}.
Add new price rules to price rule set {ParentId}.
DELETE /rule-sets/{ParentId}/rules/{Id} Delete one price rule from a rule set · Delete a price rule #
Ask an LLM
“How do I delete just one price rule from a rule set?”
“Can I remove a single price rule by its ID and keep the rest of the set?”
Tell an agent destructive · confirm first
Delete price rule {Id} from rule set {ParentId}.
Remove only price rule {Id} from price rule set {ParentId}.
GET /rule-sets/{ParentId}/rules/{Id} Get one price rule in a rule set · Retrieve a price rule #
Ask an LLM
“How do I look up a single price rule by its ID?”
“What is configured on one particular price rule in a rule set?”
Tell an agent
Get price rule {Id} from rule set {ParentId}.
Show the details of price rule {Id} in price rule set {ParentId}.
PATCH /rule-sets/{ParentId}/rules/{Id} Update one price rule in a rule set · Update a price rule #
Ask an LLM
“What do I call to edit a single price rule?”
“Can I change one specific price rule in a rule set by its ID?”
Tell an agent
Update price rule {Id} in rule set {ParentId}.
Edit just price rule {Id} of price rule set {ParentId}.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-price-rules-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga:conga-price-rules-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-price-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Administration Price Rules API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
security:
- Bearer: []
tags:
- name: Price Rules
paths:
  /rule-sets/{ParentId}/rules:
    delete:
      tags:
      - Price Rules
      summary: Delete price rules
      description: 'Deletes one or more price rules from a price rule set. It can delete a maximum of 100 price rules. When you delete a price rule, CPQ deletes its related price rule entries.


        When executed, this API returns one or more records with the delete status of each associated record ID.'
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent price ruleset
        required: true
        schema:
          type: string
      requestBody:
        description: The list of records to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceRule'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceRule'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceRule'
      responses:
        '200':
          description: OK
      operationId: deleteRuleSetsByParentIdRules
      x-operation-id-source: derived
    get:
      tags:
      - Price Rules
      summary: Retrieve price rules
      description: 'Retrieves all price rules in a price rule set, with their details. Use query parameters to further narrow down the retrieved results.


        When executed, this API returns all price rules in a price rule set.'
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent price ruleset
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: An optional array of filters
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: An optional sort criteria
        schema:
          type: string
      - name: page
        in: query
        description: The page number for pagination
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: The maximum number of records per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: An optional array of included fields
        schema:
          type: array
          items:
            type: string
      - name: field
        in: query
        description: Pass Comma separated mulitple fields
        schema:
          type: array
          items:
            type: string
      - name: filterExpression
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getRuleSetsByParentIdRules
      x-operation-id-source: derived
    patch:
      tags:
      - Price Rules
      summary: Update price rules
      description: 'Updates specific fields on one or more price rules. It can update any fields except price rule ID.


        When executed, this API returns the updated price rule or price rules.'
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent price ruleset
        required: true
        schema:
          type: string
      requestBody:
        description: The list of records to be updated
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: PriceRule
              IsActive: true
              Dimension1:
                Id: Dimension1-Id
                Name: Dimension1-Name
              Dimension1ValueType: Discrete
              AdjustmentAppliesTo: Base Price
              AdjustmentChargeType: Adjustment
              AllowableAction: Unrestricted
              AllowRemovalOfAdjustment: false
              PriceListItem:
                Id: PriceListItem-Id
                Name: PriceListItem-Name
              Sequence: 1
              RuleType: Dimension
              StopProcessing: true
              Id: Id of the record
          text/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
          application/*+json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchRuleSetsByParentIdRules
      x-operation-id-source: derived
    post:
      tags:
      - Price Rules
      summary: Create price rules
      description: 'Creates one or more price rules for a specific price rule set.


        When executed, this API returns a unique price rule ID (string) that CPQ automatically generates.'
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent price ruleset
        required: true
        schema:
          type: string
      requestBody:
        description: The list of price rules to add to the collection
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceRule'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceRule'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PriceRule'
      responses:
        '200':
          description: OK
      operationId: postRuleSetsByParentIdRules
      x-operation-id-source: derived
  /rule-sets/{ParentId}/rules/{Id}:
    delete:
      tags:
      - Price Rules
      summary: Delete a price rule
      description: Deletes a single price rule document based on the identifier and parent price ruleset.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent price ruleset
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the price rule
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deleteRuleSetsByParentIdRulesById
      x-operation-id-source: derived
    get:
      tags:
      - Price Rules
      summary: Retrieve a price rule
      description: Retrieves a single price rule document based on the identifier and parent price ruleset.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent price ruleset
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the price rule
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getRuleSetsByParentIdRulesById
      x-operation-id-source: derived
    patch:
      tags:
      - Price Rules
      summary: Update a price rule
      description: Updates a single price rule document based on the identifier and parent price ruleset.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent price ruleset
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the price rule
        required: true
        schema:
          type: string
      requestBody:
        description: The updated state of the price rule
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: PriceRule
              IsActive: true
              Dimension1:
                Id: Dimension1-Id
                Name: Dimension1-Name
              Dimension1ValueType: Discrete
              AdjustmentAppliesTo: Base Price
              AdjustmentChargeType: Adjustment
              AllowableAction: Unrestricted
              AllowRemovalOfAdjustment: false
              PriceListItem:
                Id: PriceListItem-Id
                Name: PriceListItem-Name
              Sequence: 1
              RuleType: Dimension
              StopProcessing: true
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchRuleSetsByParentIdRulesById
      x-operation-id-source: derived
components:
  schemas:
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    PriceRule:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        CreatedBy:
          $ref: '#/components/schemas/LookupObject'
        CreatedDate:
          type: string
          format: date-time
        ModifiedBy:
          $ref: '#/components/schemas/LookupObject'
        ModifiedDate:
          type: string
          format: date-time
        ExternalId:
          type:
          - string
          - 'null'
        ETag:
          type:
          - string
          - 'null'
        AdjustmentAppliesTo:
          type:
          - string
          - 'null'
        AdjustmentChargeType:
          type:
          - string
          - 'null'
        AllowableAction:
          type:
          - string
          - 'null'
        AllowRemovalOfAdjustment:
          type:
          - boolean
          - 'null'
        Beneficiary:
          type:
          - string
          - 'null'
        BeneficiaryType:
          type:
          - string
          - 'null'
        BenefitType:
          type:
          - string
          - 'null'
        Bucket:
          type:
          - string
          - 'null'
        ChargeTypeCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        ChargeTypeCriteriaOper:
          type:
          - string
          - 'null'
        CountryCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        CountryCriteriaOper:
          type:
          - string
          - 'null'
        Criteria:
          type:
          - string
          - 'null'
        CustomPricePointSource:
          type:
          - string
          - 'null'
        Description:
          type:
          - string
          - 'null'
        Dimension1:
          $ref: '#/components/schemas/LookupObject'
        Dimension1ValueType:
          type:
          - string
          - 'null'
        Dimension2:
          $ref: '#/components/schemas/LookupObject'
        Dimension2ValueType:
          type:
          - string
          - 'null'
        Dimension3:
          $ref: '#/components/schemas/LookupObject'
        Dimension3ValueType:
          type:
          - string
          - 'null'
        Dimension4:
          $ref: '#/components/schemas/LookupObject'
        Dimension4ValueType:
          type:
          - string
          - 'null'
        Dimension5:
          $ref: '#/components/schemas/LookupObject'
        Dimension5ValueType:
          type:
          - string
          - 'null'
        Dimension6:
          $ref: '#/components/schemas/LookupObject'
        Dimension6ValueType:
          type:
          - string
          - 'null'
        EffectiveDate:
          type:
          - string
          - 'null'
          format: date-time
        ExpirationDate:
          type:
          - string
          - 'null'
          format: date-time
        ForEveryXCriteriaDimension:
          $ref: '#/components/schemas/LookupObject'
        ForEveryXCriteriaDimensionType:
          type:
          - string
          - 'null'
        ForEveryXCriteriaDimensionValue:
          type:
          - number
          - 'null'
          format: double
        FutureBenefitValidityOffset:
          type:
          - number
          - 'null'
          format: double
        FutureBenefitValidityType:
          type:
          - string
          - 'null'
        IsActive:
          type:
          - boolean
          - 'null'
        MetricValueSource:
          type:
          - string
          - 'null'
        MilestoneCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        MilestoneCriteriaOper:
          type:
          - string
          - 'null'
        MilestoneStatusCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        MilestoneStatusCriteriaOper:
          type:
          - string
          - 'null'
        NumberOfEntries:
          type:
          - number
          - 'null'
          format: double
        PriceListCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        PriceListCriteriaOper:
          type:
          - string
          - 'null'
        PricePoints:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductCriteriaOper:
          type:
          - string
          - 'null'
        ProductFamilyCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductFamilyCriteriaOper:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductGroupCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductGroupCriteriaOper:
          type:
          - string
          - 'null'
        RegionCriteria:
          type:
          - array
          - 'null'
          items:
            type: string
        RegionCriteriaOper:
          type:
          - string
          - 'null'
        Ruleset:
          $ref: '#/components/schemas/LookupObject'
        RuleSubType:
          type:
          - string
          - 'null'
        RuleType:
          type:
          - string
          - 'null'
        Sequence:
          type:
          - number
          - 'null'
          format: double
        StopProcessing:
          type:
          - boolean
          - 'null'
        TierMetricRollupDuration:
          type:
          - string
          - 'null'
        TierMetricType:
          type:
          - string
          - 'null'
      additionalProperties: {}
      example:
        Name: PriceRule
        IsActive: true
        Dimension1:
          Id: Dimension1-Id
          Name: Dimension1-Name
        Dimension1ValueType: Discrete
        AdjustmentAppliesTo: Base Price
        AdjustmentChargeType: Adjustment
        AllowableAction: Unrestricted
        AllowRemovalOfAdjustment: false
        PriceListItem:
          Id: PriceListItem-Id
          Name: PriceListItem-Name
        Sequence: 1
        RuleType: Dimension
        StopProcessing: true
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header