How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

DealHub Product Catalog API

The Product Catalog API from DealHub — 29 operation(s) for product catalog.

DealHub Product Catalog API is one of 63 APIs that DealHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Product Catalog. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 42 operations across 29 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.app.subskribe.com, https://api.dealhub.io.

42 operations 29 paths 42 schemas 6 DELETE15 GET1 PATCH8 POST12 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.dealhub.io
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

DealHub Product Catalog API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — A secret token generated by a CPQ administrator.

Paths & Operations 42

Across 29 paths, the API surfaces 42 operations — 6 DELETE, 15 GET, 1 PATCH, 8 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.

Product Catalog 42
GET
/charges/{chargeId}
Get charge details
getCharge 1 param → 200
GET
/charges/revrec/csv/download
Download revenue recognition fields
getRevRecFieldsAsCsv → default
POST
/charges/revrec/csv
Backfill revenue recognition fields
backfillRevRecFields 1 param body → default
GET
/plans/{planId}/charges/{chargeId}/ledgerAccounts
Get ledger accounts
getChargeLedgerAccounts 2 params → 200
PUT
/plans/{planId}/charges/{chargeId}/ledgerAccounts
Map ledger accounts
mapLedgerAccountsToCharge 2 params body → 200
GET
/plans/{planId}/replacedPlans
Get replaced plans
getReplacedPlans 1 param → 200
GET
/plans
Get plans
getPlans 4 params → 200
POST
/plans
Create a plan
addPlan body → 200
GET
/plans/{planId}
Get plan details
getPlan 1 param → 200
PUT
/plans/{planId}
Update plan
updatePlan 1 param body → 200
DELETE
/plans/{planId}
Delete a plan
deletePlan 1 param → 200
PUT
/plans/{planId}/terms
Update plan terms
updatePlanTerms 1 param body → default
PUT
/plans/{planId}/metadata
Update plan metadata
updatePlanMetadata 1 param body → 200
PUT
/plans/{planId}/revertToDraft
Revert a plan to draft
deactivatePlan 1 param → 200
POST
/plans/{planId}/charges
Add charge to plan
addCharge 1 param body → 200
PUT
/plans/{planId}/charges/{chargeId}/partial
Update non-financial charge details
patchCharge 2 params body → 200
PUT
/plans/{planId}/activate
Activate a plan
activatePlan 1 param → 200
PUT
/plans/{planId}/deprecate
Deprecate a plan
deprecatePlan 1 param → 200
PUT
/plans/{planId}/reactivate
Reactivate a plan
reactivatePlan 1 param → 200
POST
/plans/{planId}/duplicate
Duplicate a plan
duplicatePlan 1 param → 200
PUT
/plans/{planId}/charges/{chargeId}
Update charge details
updateCharge 2 params body → default
DELETE
/plans/{planId}/charges/{chargeId}
Delete a charge
deleteCharge 2 params → 200
GET
/plans/filter/customField
Get Plans that have a specific value for a custom field
getPlansFilterByCustomFields 2 params → 200
GET
/product/categories/{id}
Get product category details
getProductCategory 1 param → 200
PUT
/product/categories/{id}
Update product category details
updateProductCategory 1 param body → default
DELETE
/product/categories/{id}
Delete a product category
deleteProductCategory 1 param → 200
GET
/product/categories
Get product Categories
getProductCategories 2 params → 200
POST
/product/categories
Create a product category
addProductCategory body → 200
GET
/products/{id}
Get product details
getProduct 1 param → 200
PUT
/products/{id}
Update product details
updateProduct 1 param body → default
DELETE
/products/{id}
Delete a product
deleteProduct 1 param → 200
GET
/products/export
Export product catalog
exportProductCatalog → default
GET
/products
Get products
getProducts 2 params → 200
POST
/products
Create a product
addProduct body → 200
GET
/api/v1/version/{version_id}/products
Get Products of a Version
getVersionProducts 5 params → 200
POST
/api/v1/version/product_by_sku
Get Products by SKU
getProductsBySku body → 200
GET
/api/v1/version/products_excel/{version_id}
Extract Products to Excel
extractProductsExcel 1 param → 200
GET
/api/v1/version/{version_id}/products_catalog
Get Product Catalog
getProductCatalog 4 params → 200
PATCH
/api/v1/version/{version_id}/products_catalog
Update Product Catalog Items
updateProductCatalogItems 2 params body → 200400403
POST
/api/v1/version/{version_id}/products_catalog
Create or Update Product Catalog
uploadProductCatalog 1 param body → 200
DELETE
/api/v1/version/{version_id}/products_catalog/all
Delete All Products from Catalog
deleteAllProducts 1 param → 200400
DELETE
/api/v1/version/{version_id}/products_catalog/by_sku
Delete Specific Products by SKU
deleteProductsBySku 1 param body → 200400

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are ChargeJson (46 properties), PricingRuleProduct (24 properties), ChargePartialJson (21 properties), PlanJson (15 properties). Each schema is shown below with its type and property counts.

PlanJsonPaginationResponse
object
3 properties
PlanJson
object
A plan is a collection of charges that dictates how a product is priced.
15 properties 4 required
PlanMetadataJson
object
1 property
ProductInputJson
object
8 properties 2 required
ProductJson
object
12 properties 2 required
CustomFieldDefault
object
2 properties
PriceTierJson
object
3 properties 2 required
LedgerAccountMapping
object
5 properties
ChargeJson
object
JSON object representing the charge details.
46 properties 3 required
LedgerAccount
object
9 properties
ProductCategoryPaginationResponse
object
3 properties
RecurrenceJson
object
2 properties 2 required
ProductCategory
object
7 properties
ProductJsonPaginationResponse
object
3 properties
ChargePartialJson
object
JSON object representing the charge details.
21 properties 1 required
CustomFieldValue
object
9 properties
ProductsBySkuRequest
object
3 properties 1 required
ProductFactor
object
3 properties 1 required
ProductCatalogPostRequest
object
2 properties
ProductCatalogPatchBundle
object
Represents an existing bundle whose data elements should be updated. Only sku is required. Include only the data categories (productattributes, productassignme…
5 properties 1 required
ProductCatalogPatchProduct
object
Represents an existing product whose data elements should be updated. Only sku is required. Include only the data categories (productattributes, productassignm…
4 properties 1 required
ProductBasic
object
7 properties
ProductCatalogPatchRequest
object
Request body for the PATCH product catalog endpoint. Include only the products and/or bundles whose data elements should be updated.
2 properties
ProductPricing
object
2 properties 1 required
ConditionalName
object
5 properties 1 required
BundleItem
object
6 properties 1 required
AsyncResponse
object
1 property
ProductCatalogItem
object
10 properties 3 required
BundleAssignment
object
4 properties 1 required
InheritedAttribute
object
2 properties
ProposalAttribute
object
3 properties 2 required
AssignmentRule
object
6 properties 3 required
Info
object
7 properties
PricingRuleProduct
object
List of the product pricing rules. The order of the elements in this list determines the sequence in which the pricing rules are evaluated by the CPQ system. I…
24 properties 5 required
VolumeDiscount
object
Defines the volume discount tables associated with the pricing rule. The value must be a key-value map where each entry represents a pair in the format
AssignmentRuleProduct
object
6 properties 3 required
ProductAssignment
object
4 properties 1 required
VersionProductsResponse
object
2 properties
ProductCatalogGetResponse
object
3 properties
ProductPricingProduct
object
2 properties 1 required
BundleCatalogItem
object
14 properties 4 required
ProductAttribute
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dealhub-product-catalog-api-openapi.yml Raw ↑

Other APIs DealHub publishes across the network.

DealHub CRM Import API
DealHub Account API
DealHub Accounting API
DealHub Accounts API
DealHub AI Agent API
DealHub AI Summary API
DealHub Approvals API
DealHub Asynchronous Operations API
DealHub Attachments API
DealHub Authentication API
DealHub Bank Transactions API
DealHub Billing API
Where this information came from

This is an independent, third-party profile of DealHub Product Catalog API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.