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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
DealHub

DealHub Orders API

The Orders API from DealHub — 22 operation(s) for orders.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

Requests are made against a single base URL, https://api.app.subskribe.com.

29 operations 22 paths 41 schemas 3 DELETE15 GET3 POST8 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
Resource Areas
1

Authentication & Security 1

DealHub Orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 29

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

Orders 29
PUT
/compositeOrders/{id}/status/{status}
Update composite order status
updateCompositeOrderStatus 4 params → default
GET
/compositeOrders/{id}
Fetch composite order
getCompositeOrder 1 param → 200
DELETE
/compositeOrders/{id}
Delete composite order
deleteCompositeOrder 1 param → default
PUT
/compositeOrders/{id}/execute
Mark composite order as executed.
executeOrder 3 params → 200
GET
/compositeOrders/{id}/pdf
Fetch composite order form PDF
getCompositeOrderDocument 1 param → default
POST
/compositeOrders/{id}/pdf
Generate a composite order PDF
createCompositeOrderDocument 1 param → default
GET
/opportunity
Return all opportunities
getOpportunities 4 params → 200
GET
/opportunity/crm/{id}
Return details of an opportunity
getOpportunityByCrmOpportunityId 1 param → 200
DELETE
/opportunity/crm/{id}
Delete an opportunity with given CRM ID
deleteOpportunityByCrmId 1 param → 200
GET
/opportunity/{id}
Return details of an opportunity
getOpportunityByOpportunityId 1 param → 200
GET
/opportunity/crm/{id}/orders
Return a list of orders associated with a CRM opportunity id
getOrdersByCrmOpportunityId 1 param → 200
GET
/orders/{id}
Get order details
getOrder 2 params → 200
DELETE
/orders/{id}
Delete an order
deleteOrder 1 param → 200
GET
/orders
Get all Orders
getOrders 2 params → 200
POST
/orders
Create an order
addOrder 2 params body → 200
PUT
/orders
Update order details
updateOrder 1 param body → default
PUT
/orders/{id}/status/{status}
Update order status
updateOrderStatus 4 params → default
GET
/orders/{id}/metrics
Get order metrics
getOrderMetrics 2 params → 200
PUT
/orders/{orderId}/rebase
Rebase amendment against latest subscription version
rebaseAmendment 1 param → 200
PUT
/orders/{orderId}/attributes
Update order attributes for non-draft orders
updateOrderAttributes 1 param body → default
GET
/orders/{id}/pdf
Fetch order form PDF
getOrderDocument_1 1 param → default
POST
/orders/{id}/pdf
Generate an order PDF
createOrderDocument 2 params → default
GET
/orders/{orderId}/pdf/{id}
Fetch specific order form PDF on order
getSpecificOrderDocument 2 params → default
GET
/orders/{id}/doc
Download word doc version of order form
getOrderDocumentDoc 1 param → default
GET
/orders/{id}/docx
Download word docx version of order form
getOrderDocumentDocx 1 param → default
PUT
/orders/{id}/execute
Mark order as executed.
executeOrder_1 3 params → 200
PUT
/orders/{id}/execute/force
Mark order as executed
forceExecuteOrder 3 params → 200
GET
/orders/{id}/lineItems/metrics
Get order line metrics
getOrderLineMetrics 1 param → 200
GET
/orders/{orderId}/billing/custom
Get custom billing schedule for the order
getCustomBillingSchedule 1 param → 200

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are OrderJson (60 properties), OrderRequestJson (47 properties), OrderLineItemJson (31 properties), OrderLineItemRequestJson (22 properties). Each schema is shown below with its type and property counts.

TenantDiscountLineItemJson
object
7 properties
OrderJson
object
60 properties 3 required
MetricsJson
object
10 properties
CreditableAmount
object
3 properties
OrderJsonPaginationResponse
object
3 properties
OrderLineRuleWarningsJson
object
2 properties
OrderAttributesUpdateRequest
object
8 properties
BillingPeriod
object
8 properties
CustomBillingScheduleInput
object
4 properties 1 required
CustomFieldEntry
object
10 properties
CustomBillingPeriodOutput
object
4 properties
CustomBillingScheduleOutput
object
8 properties
DiscountJson
object
5 properties
DiscountDetailJson
object
6 properties
RuleTraceJson
object
6 properties
CustomBillingRecurrence
object
2 properties
CustomFieldDefault
object
2 properties
PricingOverrideJson
object
3 properties
PriceTierJson
object
3 properties 2 required
OpportunityJson
object
15 properties
CustomPredefinedTemplateOnOrder
object
5 properties
DocumentCustomContent
object
4 properties
RuleActionPerformedJson
object
2 properties
OrderLineItemJson
object
31 properties 1 required
OrderTerms
object
8 properties
TimeSeriesAmountJson
object
2 properties
Duration
object
5 properties
RecurrenceJson
object
2 properties 2 required
OrderCreationCustomizationOutputJson
object
3 properties
CompositeOrderJson
object
13 properties
Period
object
3 properties
OpportunityInput
object
11 properties
CustomBillingPeriodInput
object
4 properties 1 required
AttributeReference
object
2 properties
OrderLineActionsPerformedJson
object
2 properties
TenantDiscountJson
object
6 properties
Recurrence
object
3 properties
OpportunityPaginationResponse
object
3 properties
OrderRequestJson
object
JSON object containing information required to create an order.
47 properties 2 required
OrderLineItemRequestJson
object
22 properties 1 required
TemporalUnit
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dealhub-orders-api-openapi.yml Raw ↑

Other APIs DealHub publishes across the network.

DealHub CRM Import API
AE Profile APIs.io
DealHub Account API
AE Profile APIs.io
DealHub Accounting API
AE Profile APIs.io
DealHub Accounts API
AE Profile APIs.io
DealHub AI Agent API
AE Profile APIs.io
DealHub AI Summary API
AE Profile APIs.io
DealHub Approvals API
AE Profile APIs.io
DealHub Asynchronous Operations API
AE Profile APIs.io
DealHub Attachments API
AE Profile APIs.io
DealHub Authentication API
AE Profile APIs.io
DealHub Bank Transactions API
AE Profile APIs.io
DealHub Billing API
AE Profile APIs.io
#Order
← Back to D APIs
API Details
ID
dealhub:dealhub-orders-api
Base URL
https://api.dealhub.io
Docs
https://developers.dealhub.io/docs/quote-overview
Provider
DealHub
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=dealhub-orders-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/dealhub-orders-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of DealHub Orders 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.