Conga

Conga Custom Plans API

Controller for managing generic custom billing plans. Provides endpoints to create, retrieve, and delete custom plans.

GitHub OpenAPI

Operations 3

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 /custom-plans Delete custom plans · Delete custom plan records #
Ask an LLM
“Can I delete several custom billing plans along with their line items?”
“What happens to plan line items when a custom plan is deleted?”
Tell an agent destructive · confirm first
Delete these custom plans and their plan line items.
Bulk-remove the listed custom billing plans.
POST /custom-plans/search Search custom plans and their line items · Retrieve custom plans and their line items #
Ask an LLM
“How do I find custom billing plans tied to an order or proposal?”
“Can I search custom plans by part of their name?”
Tell an agent
Find custom plans for order {order_id}.
Search custom plans whose name contains {name}.
GET /custom-plans/{customPlanId} Get a custom plan · Retrieve a custom plan record #
Ask an LLM
“What are the details of one custom billing plan?”
“Can I include related data when fetching a single custom plan by ID?”
Tell an agent
Show custom plan {plan_id}.
Get custom plan {plan_id} including {includes}.

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-custom-plans-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-custom-plans-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-custom-plans-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Billing Management Custom Plans API
  version: 1.0.0
  description: 'Controller for managing generic custom billing plans.

    Provides endpoints to create, retrieve, and delete custom plans.'
servers:
- url: https://rls.congacloud.com/api/billing/v1
security:
- Bearer: []
tags:
- name: Custom Plans
  description: 'Controller for managing generic custom billing plans.

    Provides endpoints to create, retrieve, and delete custom plans.'
paths:
  /custom-plans:
    delete:
      tags:
      - Custom Plans
      summary: Delete custom plan records
      description: Deletes one or more custom plans along with their associated plan line items.
      requestBody:
        description: A list of custom plan identifiers to delete
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
          text/json:
            schema:
              type: array
              items:
                type: string
          application/*+json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResponseWrapper'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResponseWrapper'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResponseWrapper'
        '207':
          description: Multi-Status
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResponseWrapper'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResponseWrapper'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResponseWrapper'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResponseWrapper'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResponseWrapper'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ResponseWrapper'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
      operationId: deleteCustomPlans
      x-operation-id-source: derived
  /custom-plans/search:
    post:
      tags:
      - Custom Plans
      summary: Retrieve custom plans and their line items
      description: This API endpoint allows users to search and fetch custom plans and their corresponding line items. This endpoint is typically used in billing workflows where users need to retrieve customized plans and their detailed line items for invoicing, reporting, or subscription management.
      parameters:
      - name: includes
        in: query
        schema:
          type: array
          items:
            type: string
      requestBody:
        description: A list of search criteria for custom plans and their line items
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomPlanAndLineItemRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CustomPlanAndLineItemRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CustomPlanAndLineItemRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomPlan'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomPlan'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomPlan'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
      operationId: postCustomPlansSearch
      x-operation-id-source: derived
  /custom-plans/{customPlanId}:
    get:
      tags:
      - Custom Plans
      summary: Retrieve a custom plan record
      description: Retrieves the details of a custom plan based on its unique identifier. This API is typically used when users need to fetch detailed information about a specific custom plan, optionally including related data for comprehensive insights.
      parameters:
      - name: customPlanId
        in: path
        description: The identifier of the custom plan
        required: true
        schema:
          type: string
      - name: includes
        in: query
        description: Optional related entities to include
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CustomPlan'
            application/json:
              schema:
                $ref: '#/components/schemas/CustomPlan'
            text/json:
              schema:
                $ref: '#/components/schemas/CustomPlan'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
      operationId: getCustomPlansByCustomPlanId
      x-operation-id-source: derived
components:
  schemas:
    CustomPlanAndLineItemRequest:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
          description: Retrieving Custom Plan and Plan Line Item based on Custom Plan Id
        NameContaining:
          type:
          - string
          - 'null'
          description: Retrieving Custom Plan and Plan Line Item based on Custom Plan Name
        OrderId:
          type:
          - string
          - 'null'
          description: Retrieving Custom Plan and Plan Line Item having given Order Id
        OrderLineItemId:
          type:
          - string
          - 'null'
          description: Retrieving Custom Plan and Plan Line Item having given Order Line Item Ids
        ProposalId:
          type:
          - string
          - 'null'
          description: Retrieving Custom Plan and Plan Line Item having given Proposal Id
        LineItemId:
          type:
          - string
          - 'null'
          description: Retrieving Custom Plan and Plan Line Item having given Line Item Ids
      additionalProperties: false
    ResponseWrapper:
      type: object
      properties:
        IsSuccess:
          type: boolean
        ErrorMessage:
          type:
          - string
          - 'null'
        Id:
          type:
          - string
          - 'null'
          description: Created/Updated record Id on processed in a transaction
      additionalProperties: false
    CurrencyField:
      type: object
      properties:
        Value:
          type: number
          format: double
        DisplayValue:
          type: number
          format: double
          readOnly: true
        CurrencyCode:
          type:
          - string
          - 'null'
          readOnly: true
        CurrencySymbol:
          type:
          - string
          - 'null'
          readOnly: true
      additionalProperties: false
    ErrorApiResponse:
      type: object
      properties:
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ApiError'
      additionalProperties: false
    PlanLineItem:
      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'
        CustomPlan:
          $ref: '#/components/schemas/LookupObject'
        PeriodStartDate:
          type:
          - string
          - 'null'
          format: date-time
        PeriodEndDate:
          type:
          - string
          - 'null'
          format: date-time
        ReadyForInvoiceDate:
          type:
          - string
          - 'null'
          format: date-time
        Percent:
          type: number
          format: double
        PaymentTerm:
          $ref: '#/components/schemas/LookupObject'
        MilestoneExpectedDate:
          type:
          - string
          - 'null'
          format: date-time
        Comments:
          type:
          - string
          - 'null'
        Currency:
          type:
          - string
          - 'null'
        Amount:
          $ref: '#/components/schemas/CurrencyField'
      additionalProperties: {}
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    ApiError:
      type: object
      properties:
        Source:
          type:
          - string
          - 'null'
        Title:
          type:
          - string
          - 'null'
        Detail: {}
        Help:
          type:
          - string
          - 'null'
      additionalProperties: false
    CustomPlan:
      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'
        Proposal:
          $ref: '#/components/schemas/LookupObject'
        Order:
          $ref: '#/components/schemas/LookupObject'
        Description:
          type:
          - string
          - 'null'
        NumberOfInstallments:
          type: integer
          format: int32
        PlanTemplate:
          $ref: '#/components/schemas/LookupObject'
        PlanType:
          type:
          - string
          - 'null'
        PeriodsNeeded:
          type: boolean
        BasedOn:
          type:
          - string
          - 'null'
        ComputationMethod:
          type:
          - string
          - 'null'
        Status:
          type:
          - string
          - 'null'
        BillingAmountCriterion:
          type:
          - string
          - 'null'
        Currency:
          type:
          - string
          - 'null'
        TotalBillableAmount:
          $ref: '#/components/schemas/CurrencyField'
        ProductConfiguration:
          $ref: '#/components/schemas/LookupObject'
        BusinessObjectType:
          type:
          - string
          - 'null'
        BusinessObjectId:
          type:
          - string
          - 'null'
        Items:
          type: array
          items:
            $ref: '#/components/schemas/PlanLineItem'
          description: Child collection of PlanLineItem (included when 'Items' is requested via the includes parameter).
      additionalProperties: {}
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header