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 Subskribe API

The subscription management, usage-based billing and revenue recognition API DealHub acquired with Subskribe — accounts, orders, subscriptions, plans and rate plans, charge types, usage records and aggregation, invoices and credit memos, payments and payment methods, taxation, accounting periods, ERP and revenue-recognition integration, ledger and journal entries, entitlements, approvals, documents and tenant administration.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 561 operations across 421 paths, organized into 50 resource areas, and defines 311 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

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

561 operations 421 paths 311 schemas 47 DELETE252 GET155 POST107 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.app.subskribe.com
Authentication
API Key
Resource Areas
50

Authentication & Security 1

DealHub Subskribe 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 561

Across 421 paths, the API surfaces 561 operations — 47 DELETE, 252 GET, 155 POST, 107 PUT. They span 50 resource areas, including Billing, Accounts, Intelligent Sales Room, Accounting, AI Agent, AI Summary, Integrations, Authentication, and 42 more. Each is listed below with its method, path, parameters, and response codes.

Billing 49
GET
/accountReceivableContact
Get the contact for accounts receivable
getAccountReceivableContact → 200
PUT
/accountReceivableContact
Set the contact for accounts receivable
putAccountReceivableContact body → default
GET
/alias/subscriptionCharge/{aliasId}
Get the details of an alias
getSubscriptionChargeAlias 1 param → 200
PUT
/alias/subscriptionCharge/{aliasId}
Create an alias for a subscription id/charge id pair
addSubscriptionChargeAlias 3 params → default
DELETE
/alias/subscriptionCharge/{aliasId}
Delete the specified alias
deleteSubscriptionChargeAlias 1 param → default
GET
/alias/subscriptionCharge
Get aliases for a subscription
listAliasesForSubscription 1 param → 200
GET
/automatedInvoiceRules/{id}
Get automated invoice rule details
getAutomatedInvoiceRule 1 param → default
PUT
/automatedInvoiceRules/{id}
Update automated invoice rule details
updateAutomatedInvoiceRule 1 param body → default
GET
/automatedInvoiceRules/internal/{id}deprecated
Get automated invoice rule details via internal id
getAutomatedInvoiceRuleByInternalId 1 param → default
PUT
/automatedInvoiceRules/internal/{id}deprecated
updateAutomatedInvoiceRuleUsingInternalId 1 param body → default
GET
/automatedInvoiceRules
Get automated invoice rules for a tenant
getAutomatedInvoiceRules → default
POST
/automatedInvoiceRules
Create an automated invoice rule
addAutomatedInvoiceRule body → 200
POST
/dunning/sendInvoiceReminder/{invoiceNumber}
Send an Invoice Reminder
sendInvoiceReminder 1 param → default
POST
/dunning/sendTestEmail/{reminderType}
Send a test email
sendTestDunningEmail 1 param → default
GET
/dunningSetting
Get dunning settings
getDunningSetting → 200
PUT
/dunningSetting
Update dunning settings
updateDunningSetting body → default
GET
/invoices/bulk/{bulkInvoiceRunId}
Get bulk invoice run details
getBulkInvoiceRun 1 param → 200
GET
/invoices/bulk/{bulkInvoiceRunId}/runItems
Get items for bulk invoice run
getBulkInvoiceRunItems 1 param → 200
GET
/invoices/{number}/balance
Get invoice balance
getInvoiceBalance 1 param → 200
GET
/invoices/{number}
Get invoice details
getInvoice 2 params → 200
PUT
/invoices/{number}
Update invoice details
updateInvoice 1 param body → 200
DELETE
/invoices/{number}
Delete invoice
deleteInvoice 1 param → 200
POST
/invoices/generate
Generate subscription invoices
generateInvoice 4 params → 200
GET
/invoices/preview
Preview invoices
previewInvoiceByOrderPeriod 2 params → 200
GET
/invoices/unbilledUsage
Get unbilled usage
previewInvoiceByOrderPeriod_1 1 param → 200
GET
/invoices
Get all invoices for a subscription
getInvoices 4 params → 200
DELETE
/invoices/{number}/voided
Delete voided invoice
deleteVoidedInvoice 1 param → 200
POST
/invoices/{number}/post
Mark invoice as posted
postInvoice 1 param → 200
PUT
/invoices/{number}/void
Mark invoice as voided
voidInvoice 1 param body → 200
GET
/invoices/{invoiceNumber}/pdf
Download invoice PDF
getInvoiceDocumentPdf 1 param → default
POST
/invoices/{invoiceNumber}/pdf
Generate invoice PDF
createInvoiceDocument 2 params → default
DELETE
/invoices/schedule/{id}
Delete an existing billing schedule
deleteBillingSchedule 1 param → default
GET
/invoices/schedule
Get billing schedules for a subscription line item
getBillingSchedules 2 params → 200
POST
/invoices/schedule
Add a new billing schedule for subscription line item
addBillingSchedule body → 200
PUT
/invoices/bulk/{bulkInvoiceRunId}/post
Posts invoices for a bulk run
postInvoicesForBulkInvoiceRun 1 param body → 200
POST
/invoices/bulk/email
Send emails for multiple invoices
sendBulkInvoiceEmail body → default
POST
/invoices/sequence/{invoiceConfigId}
Update invoice sequence
updateInvoiceSequence 2 params → 200
GET
/invoices/previewAllInvoices
Preview all invoices
previewAllInvoice 2 params → 200
GET
/invoices/usage
Get usage
getUsageForSubscriptionCharge 2 params → 200
GET
/invoices/{number}/canDelete
Check if invoice can be deleted
getCanDeleteInvoice 1 param → 200
GET
/invoices/{invoiceNumber}/documentJson
Get the invoice document JSON that is used to render invoice PDF
getRawInvoiceDocumentJson 1 param → default
POST
/invoices/{invoiceNumber}/email
Send invoice email to contacts
emailInvoice 1 param → default
POST
/invoices/bulk
Create a bulk invoice run
createBulkInvoiceRun body → 200
GET
/settlements/applicablePaymentBankAccounts
Get applicable payment bank accounts for invoice payment
getApplicablePaymentBankAccountsForInvoicePayment 1 param → 200
GET
/settlements/{id}
Get settlement application details
getSettlementApplication 1 param → 200
GET
/settlements
Get settlement applications
getSettlementApplications 2 params → 200
POST
/settlements/addAndApplyPayment
Apply a payment on a specific invoice
addAndApplyPayment body → default
POST
/settlements/applyCreditMemo
Apply a credit memo
applyCreditMemo body → default
POST
/settlements/unapplyCreditMemo
Unapply a credit memo
unapplyCreditMemo body → default
Accounts 17
GET
/accounts
Get all accounts
getAccounts 3 params → 200
POST
/accounts
Add a new account
addAccount body → 200
GET
/accounts/{id}
Get an account by id
getAccount 2 params → 200
PUT
/accounts/{id}
Update an account
updateAccount 1 param body → default
DELETE
/accounts/{id}
Delete an account
deleteAccount 1 param → default
GET
/accounts/{accountId}/contacts
Get contacts for an account
getAccountContacts 2 params → 200
POST
/accounts/{accountId}/contacts
Add a contact for an account
addAccountContact 3 params body → 200
PUT
/accounts/{accountId}/crmId
Update CRM ID
updateAccountCrmId 1 param body → default
GET
/accounts/{id}/metrics
Returns metrics for the specified account
getAccountMetrics 3 params → 200
GET
/accounts/{accountId}/paymentMethods/{id}
Get the details of a payment method
getPaymentMethod 2 params → 200
PUT
/accounts/{accountId}/erp
Update account ERP details
addErpDetails 2 params body → default
GET
/accounts/{accountId}/contacts/{contactId}
Gets contact details
getAccountContact 2 params → 200
PUT
/accounts/{accountId}/contacts/{contactId}
Update a contact
updateAccountContact 4 params body → default
DELETE
/accounts/{accountId}/contacts/{contactId}
Delete a contact
deleteAccountContact 2 params → default
POST
/accounts/crm/import
Import an account from a CRM
importCrmAccount body → 200
GET
/accounts/{accountId}/paymentConfig
Get account payment configuration
getAccountPaymentConfig 1 param → 200
POST
/accounts/{accountId}/paymentConfig
Upsert account payment configuration
upsertAccountPaymentConfig 1 param body → 200
Intelligent Sales Room 48
GET
/accounts/salesRoom/{shareLink}/contacts
Get account contacts via sales room share link
getAccountContactViaShareLink 1 param → default
POST
/accounts/salesRoom/{shareLink}/contacts
Create account contact via share link
addAccountContactViaShareLink 4 params body → default
PUT
/accounts/salesRoom/{shareLink}/contacts/{contactId}
Update account contact via share link
updateAccountContactViaShareLink 5 params body → default
POST
/compositeOrders/salesRoom/{shareLink}/pdf
Generate a composite order PDF via Sales Room Share Link
createCompositeOrderDocumentForSalesRoom 1 param → default
DELETE
/intelligent-sales-rooms/{salesRoomId}/files/{fileId}
Delete a file
deleteFile 2 params → default
GET
/intelligent-sales-rooms/{salesRoomId}/files
Get all files for a sales room
getFiles 2 params → 200
POST
/intelligent-sales-rooms/{salesRoomId}/files
Upload a file
uploadFile 1 param body → 200
POST
/intelligent-sales-rooms
Create a new intelligent sales room
createSalesRoom 1 param → 200
GET
/intelligent-sales-rooms/by-order/{orderId}
Get sales room by order ID
getSalesRoomByOrderId 1 param → 200
GET
/intelligent-sales-rooms/{salesRoomId}
Get sales room by ID
getSalesRoomById 1 param → 200
PUT
/intelligent-sales-rooms/{salesRoomId}/widgets/{widgetId}
Update a widget
updateWidget 2 params body → 200
DELETE
/intelligent-sales-rooms/{salesRoomId}/widgets/{widgetId}
Delete a widget
deleteWidget 2 params → default
PUT
/intelligent-sales-rooms/{salesRoomId}/widgets/reorder
Reorder widgets
reorderWidgets 1 param body → default
GET
/intelligent-sales-rooms/{salesRoomId}/theme
Get sales room theme
getTheme 1 param → 200
PUT
/intelligent-sales-rooms/{salesRoomId}/theme
Update theme manually
updateTheme 1 param body → 200
POST
/intelligent-sales-rooms/{salesRoomId}/widgets/{widgetId}/ai-content
Generate AI content for widget
generateAIContent 2 params → 200
PUT
/intelligent-sales-rooms/{salesRoomId}/ai-content/{contentId}
Update AI generated content
updateAIContent 2 params body → 200
POST
/intelligent-sales-rooms/{salesRoomId}/activate
Activate sales room
activateSalesRoom 1 param → default
POST
/intelligent-sales-rooms/{salesRoomId}/retract
Retract sales room
retractSalesRoom 1 param → default
POST
/intelligent-sales-rooms/share/{shareLink}/accept
Accept sales room proposal (using share link)
acceptSalesRoom 1 param → default
POST
/intelligent-sales-rooms/{salesRoomId}/accept
Accept sales room proposal
acceptSalesRoom_1 1 param → default
GET
/intelligent-sales-rooms/{salesRoomId}/engagement/summary
Get engagement summary
getEngagementSummary 3 params → 200
GET
/intelligent-sales-rooms/{salesRoomId}/engagement/activity
Get activity logs
getActivityLogs 5 params → 200
GET
/intelligent-sales-rooms/{salesRoomId}/share-access
Get share link access records
getShareLinkAccesses 1 param → 200
GET
/intelligent-sales-rooms/{salesRoomId}/visitors/count
Get unique visitor count
getUniqueVisitorCount 1 param → default
PUT
/intelligent-sales-rooms/{salesRoomId}/customer-information
Update customer information
updateCustomerInformation 1 param body → default
GET
/intelligent-sales-rooms/{salesRoomId}/custom-fields
Fetch custom fields for an Intelligent Sales Room
getCustomFields_1 1 param → default
PUT
/intelligent-sales-rooms/{salesRoomId}/custom-fields
Update custom fields for an Intelligent Sales Room
updateCustomFields_1 1 param body → default
POST
/intelligent-sales-rooms/share/{shareLink}/events
Track user event
trackEvent 1 param body → default
GET
/intelligent-sales-rooms/share/{shareLink}/custom-fields
Fetch custom fields for an Intelligent Sales Room (via share link)
getCustomFieldsViaShareLink 1 param → default
PUT
/intelligent-sales-rooms/share/{shareLink}/custom-fields
Update custom fields for an Intelligent Sales Room (via share link)
updateCustomFieldsViaShareLink 1 param body → default
GET
/intelligent-sales-rooms/{salesRoomId}/widgets
Get all widgets for a sales room
getWidgets 1 param → 200
POST
/intelligent-sales-rooms/{salesRoomId}/widgets
Create a new widget
createWidget 1 param body → 200
POST
/intelligent-sales-rooms/{salesRoomId}/theme/extract
Extract theme from website
extractTheme 1 param body → 200
GET
/intelligent-sales-rooms/{salesRoomId}/files/{fileId}/download
Get file download URL
getFileDownloadUrl 3 params → default
GET
/intelligent-sales-rooms/share/{shareLink}/order/pdf
Fetch order form PDF for an Intelligent Sales Room
getOrderDocument 1 param → default
POST
/intelligent-sales-rooms/share/{shareLink}/access
Access sales room via share link
accessViaShareLink 1 param body → 200
GET
/intelligent-sales-rooms/share/{shareLink}/widgets
Get widgets via share link
getWidgetsViaShareLink 1 param → 200
GET
/intelligent-sales-rooms/share/{shareLink}/theme
Get theme via share link
getThemeViaShareLink 1 param → 200
GET
/intelligent-sales-rooms/share/{shareLink}/files
Get files via share link
getFilesViaShareLink 2 params → 200
GET
/intelligent-sales-rooms/share/{shareLink}/files/{fileId}/download
Get file download URL via share link
getFileDownloadUrlViaShareLink 3 params → default
GET
/intelligent-sales-rooms/share/{shareLink}
Get sales room details via share link
getSalesRoomViaShareLink 1 param → 200
GET
/intelligent-sales-rooms/share/{shareLink}/ai-content
Get AI content via share link
getAIContentViaShareLink 1 param → 200
PUT
/intelligent-sales-rooms/share/{shareLink}/customer-information
Update customer information via share link
updateCustomerInformationViaShareLink 1 param body → default
GET
/intelligent-sales-rooms/share/{shareLink}/image/{fileName}
Download image file via share link
downloadImageViaShareLink 2 params → default
POST
/intelligent-sales-rooms/share/{shareLink}/esign
Send email for e-signature via share link
sendEmailForEsignViaShareLink 1 param body → 200
GET
/intelligent-sales-rooms/share/{shareLink}/order-metadata
Fetch order metadata for an Intelligent Sales Room
getOrderMetadata 1 param → default
POST
/orders/salesRoom/{shareLink}/pdf
Generate an order PDF via Sales Room Share Link
createOrderDocumentForSalesRoom 2 params → default
Accounting 7
POST
/accountingPeriods
Specify the current accounting period
specifyCurrentAccountingPeriod body → 200
GET
/accountingPeriods/current
Get the current accounting period
getCurrentAccountingPeriod → 200
GET
/accounting/journalEntry/summary
Return Journal Entry summary
getJournalEntriesSummary 1 param → default
GET
/accounting/journalEntry/runningBalances
Get running balances of revenue schedule
getRunningBalances 2 params → default
GET
/accounting/journalEntry/events
Get accounting events for the specified dates
getAccountingEvents 4 params → 200
GET
/accounting/journalEntry
Return Journal Entries
getJournalEntries 1 param → default
GET
/accounting/ledgerAccounts
Get ledger accounts
getLedgerAccounts 1 param → 200
AI Agent 7
POST
/ai/zeppa/gen
Generate zeppa artifact based on the description provided
generateZeppaArtifact body → 200
GET
/ai/agents/session/{sessionId}
Get the agent session given the id, NOTE: at the moment there is no response body
getAgentSession 1 param → default
GET
/ai/summary/subscription/{subscriptionId}
Generate a summary of the subscription in plain english in markdown format
generateSubscriptionSummary 1 param → 200
POST
/ai/agents/session
Create new conversational AI agent session
createAgentSession → default
PUT
/ai/agents/session/{sessionId}/chat
Chat with a given session id and get back a response for a given message
chatResponse 1 param body → 200
GET
/ai/agents/session/{sessionId}/chatAsync
Chat with a given session id and get back a response for a given message in a async manner in the form of server side events
chatResponseAsync 2 params → 200
GET
/ai/agents/session/{sessionId}/messages
List the messages belong to this session
chatMessages 2 params → 200
AI Summary 3
GET
/ai/explain/proration/async/{orderId}/{orderLineItemId}
Generate an explanation of the proration calculation
explainProrationAsync 2 params → 200
GET
/ai/explain/proration/{orderId}/{orderLineItemId}
Generate an explanation of the proration calculation
explainProration 2 params → 200
GET
/ai/summary/order/{orderId}
Generate a summary of the order in plain english in markdown format
generateOrderSummary 2 params → 200
Integrations 43
POST
/anrok
Add a Anrok integration
addIntegration body → default
PUT
/anrok/test
Test an integration is valid
testIntegration body → 200
POST
/anrok/validate
Validate an address with Anrok
validateAddress body → 200
GET
/anrok/{integrationId}
Get integration details
getIntegration 1 param → 200
PUT
/avalara/ping
Pings Avalara
ping body → default
GET
/avalara/{integrationId}
Gets Avalara integration details
getIntegration_1 1 param → 200
GET
/avalara
Gets Avalara integration details
getIntegrationByTenant → 200
POST
/avalara
Create an Avalara integration
integrate body → default
POST
/crm/{opportunityCrmId}/notifyNameChange
Opportunity name change notification
opportunityNameChangeNotification 1 param body → default
GET
/crm/{accountId}/contacts
Fetch all associated CRM contacts for an account
getCrmContactsByAccountId 1 param → default
POST
/crm/contacts
Upsert CRM contacts for an account
upsertCrmContacts body → 200
GET
/docusign
Complete Docusign integration
completeIntegration 2 params → 200
POST
/docusign
Create Docusign integration
initiateIntegration body → default
DELETE
/docusign
Delete Docusign integration
deleteIntegration → 200
POST
/docusign/reauthenticate
Re-authenticate Docusign integration
reauthenticateIntegration → 200
GET
/hubspot
Handle HubSpot authorization code
authorizationCodeCallback 3 params → default
POST
/hubspot
Initiate a HubSpot integration
initiateIntegration_1 body → 200
DELETE
/hubspot
Delete HubSpot Integration
deleteIntegration_1 → default
POST
/hubspot/setup
Add custom properties to HubSpot
setupHubSpot → default
POST
/hubspot/setup/verify
Verify HubSpot setup
verifySetup → default
POST
/hubspot/esign/{orderId}
Sync esign details for order id
syncEsignDetailsForOrderToHubSpot 1 param → default
POST
/hubspot/sync/order/{orderId}
Sync order to Hubspot
syncOrder 1 param → default
POST
/hubspot/sync/account/{accountCrmId}
Import account from HubSpot
importAccountFromHubspot 1 param → default
POST
/hubspot/sync/subscription/{subscriptionId}
Sync subscription to Hubspot
syncHubspotSubscription 1 param → default
POST
/hubspot/sync/subscription/{subscriptionId}/status
Sync subscription status to Hubspot
syncHubspotSubscriptionStatus 1 param → default
GET
/sfdc
Callback for the authorization code
authorizationCodeCallback_1 3 params → default
POST
/sfdc
Initiate integration with Salesforce
initiateIntegration_2 body → default
DELETE
/sfdc
Delete Salesforce integration
deleteIntegration_2 → default
GET
/sfdc/account
Get Salesforce accounts
getAccountsByName 1 param → 200
POST
/sfdc/account
Import account from Salesforce
importAccount body → default
GET
/sfdc/account/{id}
Get Salesforce account
getAccountById 1 param → 200
PUT
/sfdc/order/{id}
Make an order primary
updatePrimaryOrderIdForOpportunity 1 param → 200
GET
/sfdc/opportunity
Get Salesforce opportunities
getOpportunitiesByAccountId 1 param → 200
PUT
/sfdc/sync/{id}
Sync order to Salesforce
syncOrderToSalesforce 1 param → 200
PUT
/sfdc/syncOrders
Sync orders to Salesforce
syncOrdersToSalesforce body → 200
PUT
/sfdc/syncTenant
Sync whole tenant to Salesforce in a paginated fashion
syncTenantToSalesforce 3 params → default
PUT
/sfdc/syncDeletedOrders
Sync orders to Salesforce
syncDeletedOrdersToSalesforce body → 200
PUT
/sfdc/syncAccount/{id}
Sync an account to Salesforce
syncAccountToSalesforce 1 param → default
PUT
/sfdc/sync/subscription/{subscriptionId}
Sync subscription to Salesforce
syncSubscriptionToSalesforce 1 param → default
POST
/taxjar
Add a TaxJar integration
addIntegration_1 body → default
PUT
/taxjar/test
Test an integration is valid
testIntegration_1 body → 200
POST
/taxjar/validate
Validate an address with TaxJar
validateAddress_1 body → 200
GET
/taxjar/{integrationId}
Get integration details
getIntegration_2 1 param → 200
Authentication 8
DELETE
/apikey/revoke
revoke all keys
revokeApiKey → default
GET
/apikey/{id}
Retrieve an API key by id
getApiKeyById 1 param → default
GET
/apikey
Retrieves all API keys
getAllApiKeys → default
POST
/apikey
Create a new api key
createApiKey 4 params → 200
DELETE
/apikey/revoke/{id}
revoke an API key by id
revokeApiKeyById 1 param → default
GET
/auth/saml
Get SAML Integration Status
getSamlIntegration → default
POST
/auth/saml
Add a saml integration
addSamlIntegration body → default
DELETE
/auth/saml
Delete SAML Integration
deleteSamlIntegration → default
Approvals 23
GET
/approvalFlows
Get approval flows
getApprovalFlows → 200
POST
/approvalFlows
Add an approval flow
addApprovalFlow body → 200
GET
/approvalFlows/{approvalFlowId}
Get Details of an approval flow
getApprovalFlowById 1 param → 200
PUT
/approvalFlows/{approvalFlowId}
Update an approval flow
updateApprovalFlow 1 param body → default
DELETE
/approvalFlows/{approvalFlowId}
Delete an approval flow
deleteApprovalFlow 1 param → 200
GET
/approvalMatrix/csv
Get approval matrix details
getAllImportDetails → 200
POST
/approvalMatrix/csv
Upload an Approval Matrix
uploadApprovalMatrixCSV body → 200
GET
/approvalMatrix/csv/download
Download approval matrix
getApprovalMatrixAsCsv → default
GET
/approvalMatrix/csv/{importId}
Get import details
getImportDetailsById 1 param → 200
GET
/approvalMatrix/csv/{importId}/download
Download the csv for an import
getImportResult 1 param → default
GET
/approvalMatrix/csv/{importId}/preview
Preview import changes
getImportPreview 1 param → 200
POST
/approvalMatrix/csv/{importId}/submit
Finalize an import
submitApprovalMatrixCSV 1 param → default
GET
/approvalRoles
Get approval roles
getApprovalRoles → 200
POST
/approvalRoles
Add an approval role
addApprovalRole body → 200
GET
/approvalRoles/{approvalRoleId}
Get Details of an approval role
getApprovalRoleById 1 param → 200
PUT
/approvalRoles/{approvalRoleId}
Update an approval role
updateApprovalRole 1 param body → default
DELETE
/approvalRoles/{approvalRoleId}
Delete an approval role
deleteApprovalRole 1 param → 200
GET
/approvalSegments
Get approval segments
getApprovalSegments → 200
POST
/approvalSegments
Add an approval segment
addApprovalSegment body → 200
GET
/approvalSegments/{approvalSegmentId}
Get approval segment details
getApprovalSegmentById 1 param → 200
PUT
/approvalSegments/{approvalSegmentId}
Update an approval segment
updateApprovalSegment 1 param body → default
DELETE
/approvalSegments/{approvalSegmentId}
Delete a segment
deleteApprovalSegment 1 param → 200
GET
/orders/{orderId}/approvalHistory
Get complete approval history for an order
getOrderApprovalHistory 1 param → 200404500
Attachments 6
GET
/attachments/account/maxNumberOfFiles
Get the maximum number of attachments allowed for an account
getMaximumNumberOfAttachmentsPerAccount → 200
GET
/attachments/{attachmentId}
Get attachment contents
getAttachment 1 param → default
DELETE
/attachments/{attachmentId}
Delete an attachment
deleteAttachmentFromAccount 1 param → default
GET
/attachments/account/{accountId}
Get attachments for an account
listAccountAttachments 1 param → 200
POST
/attachments/account/{accountId}
Add an attachment
addAttachmentToAccount 4 params body → 200
PUT
/attachments
Update the details of an attachment
modifyAttachment body → 200
Usage 11
POST
/bankTransactions/match
Match bank transactions
bankTransactionsMatch body → 200
POST
/settlements/addAndApplyPaymentsInBulk/csv
Add and apply bulk payments to invoices CSV
addAndApplyBulkPaymentsCsv body → 200
PUT
/v2/usage/aggregate
Aggregate raw usage
performOnDemandUsageAggregation → default
POST
/v2/usage/csv
Upload usage record CSV
uploadSubscriptionUsageCSV body → 200
POST
/v2/usage
Add usage record
addUsage body → 200
GET
/v2/usage/{subscriptionId}
Get aggregated usage
getUsageAggregatesForSubscription 3 params → 200
GET
/v2/usage/stats/{subscriptionId}
Get prepaid drawdown usage stats for subscription
getUsageStatsForSubscription 1 param → 200
GET
/v2/usage/stats/{subscriptionId}/csv
Get prepaid drawdown usage stats CSV
getUsageStatsForSubscriptionCsv 1 param → default
GET
/v2/usage/stats/{subscriptionId}/pdf
Get prepaid drawdown usage stats PDF
getUsageStatsForSubscriptionPdf 1 param → default
GET
/v2/usage/stats/csv
Get all prepaid drawdown usage stats CSV
getUsageStatsForAllSubscriptionsCsv 2 params → default
GET
/v2/usage/aggregate/usageArrivalTimeCheckpoint
Get usage arrival checkpoint
getUsageArrivalTimeCheckpoint → default
BankTransactions 3
GET
/bankTransactions/potentialInvoices
Get paginated bank transaction records
getBankTransactionPotentialInvoices 3 params → 200
DELETE
/bankTransactions/{id}
Delete given bank transaction record
deleteBankTransaction 1 param → default
POST
/bankTransactions/csv
Import bank transactions via CSV
bankTransactionsCsv body → 200
Product Catalog 34
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
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
Credit Memo 13
PUT
/creditmemos/{creditMemoNumber}/void
Mark Credit Memo as voided
voidCreditMemo 1 param body → 200
GET
/creditmemos
Get credit memos for an account
getCreditMemoForAccount 3 params → 200
POST
/creditmemos
Create a standalone credit memo
createStandaloneCreditMemo body → 200
GET
/creditmemos/{creditMemoNumber}
Get credit memo details
getCreditMemo 1 param → 200
PUT
/creditmemos/{creditMemoNumber}
Update a credit memo
updateDraftCreditMemo 1 param body → 200
DELETE
/creditmemos/{creditMemoNumber}
Delete a credit memo
deleteCreditMemo 1 param → 200
POST
/creditmemos/{creditMemoNumber}/post
Post a credit memo
postCreditMemo 1 param → 200
GET
/creditmemos/{creditMemoNumber}/pdf
Download credit memo pdf
getCreditMemoDocumentPdf 1 param → default
POST
/creditmemos/{creditMemoNumber}/pdf
Create a credit memo document
createCreditMemoDocument 1 param → default
GET
/creditmemos/configuration
Get credit memo configuration for the tenant
getCreditMemoConfiguration → 200
POST
/creditmemos/configuration
Update credit memo configuration
updateCreditMemoConfiguration body → 200
PUT
/creditmemos/convert/{invoiceNumber}
Convert invoice to credit memo
convertNegativeDraftInvoice 1 param → 200
GET
/creditmemos/{creditMemoNumber}/balance
Get credit memo balance
getCreditBalance 1 param → 200
CRM field mapping 7
GET
/crmFieldMapping/csv
Get CRM field mapping upload list
getAllImportDetails_1 → 200
POST
/crmFieldMapping/csv
Upload of CRM field mappings
uploadCrmFieldMappingCsv body → 200
GET
/crmFieldMapping/csv/{importId}
Get import details
getImportDetailsById_1 1 param → 200
GET
/crmFieldMapping/csv/{importId}/download
Download the csv for an import
getImportResult_1 1 param → default
GET
/crmFieldMapping/csv/{importId}/preview
Preview import changes
getImportPreview_1 1 param → 200
GET
/crmFieldMapping/csv/download
Download CRM field mappings
getCrmFieldMappingAsCsv → default
POST
/crmFieldMapping/csv/{importId}/submit
Finalize an import
submitCrmFieldMappingImport 1 param → default
Custom Field 9
POST
/customFieldDefinition
Create a custom field definition
createCustomFieldDefinition body → 200
GET
/customFieldDefinition/{parentObjectType}
Get custom field definitions
getCustomFieldDefinitions 1 param → 200
PUT
/customFieldDefinition/{id}
Update an existing custom field definition
updateCustomFieldDefinition 1 param body → 200
DELETE
/customFieldDefinition/{id}
Delete a custom field definition
deleteCustomFieldDefinition 1 param → 200
PUT
/customField/{parentObjectType}/{parentObjectId}/{customFieldName}
Update an existing set of custom fields
updateCustomField 3 params body → default
GET
/customField/{parentObjectType}/{parentObjectId}
Get custom fields by type and parent object id
getCustomFields 2 params → default
PUT
/customField/{parentObjectType}/{parentObjectId}
Update an existing set of custom fields
updateCustomFields 2 params body → default
PUT
/customField/{parentObjectType}/{parentObjectId}/force
Update an existing set of custom fields
forceUpdateCustomFields 2 params body → default
PUT
/customField/{parentObjectType}/{parentObjectId}/{customFieldName}/force
Update an existing set of custom fields
forceUpdateCustomField 3 params body → default
Customization 4
GET
/customization/selectionCustomization
Get the current selection customization defined
getSelectionCustomization → default
PUT
/customization/selectionCustomization
Add or Update selection customization script
addSelectionCustomization 2 params body → default
GET
/customization/orderCreationCustomization
Get the current order creation customization defined
getOrderCreationCustomization → default
PUT
/customization/orderCreationCustomization
Add or Update order creation customization script
addOrderCreationCustomization 2 params body → default
Deal Pulse 3
GET
/deal-pulse
Get all deal pulses for tenant
getAllDealPulses → 200
GET
/deal-pulse/sales-rooms/{salesRoomId}
Get deal pulse for a specific sales room
getDealPulse 1 param → 200
POST
/deal-pulse/sales-rooms/{salesRoomId}/events
Track deal pulse event
trackDealPulseEvent 1 param body → default
Discounts 6
GET
/discounts
Get discounts
getDiscounts → 200
POST
/discounts
Create a discount
addDiscount body → 200
GET
/discounts/{id}
Get discount
getDiscount 1 param → 200
PUT
/discounts/{id}
Update discount details
updateDiscount 1 param body → default
DELETE
/discounts/{id}
Delete a discount
deleteDiscount 1 param → default
PUT
/discounts/{id}/status/{status}
Update discount status
updateDiscountStatus 2 params → default
Documents 8
GET
/predefinedTerms
Get predefined terms
getDocumentTemplates 1 param → 200
POST
/predefinedTerms
Add new predefined terms
addDocumentTemplate body → 200
GET
/predefinedTerms/{id}/versions
Get predefined terms versions
getDocumentTemplateVersions 1 param → 200
GET
/predefinedTerms/{id}
Get predefined terms detail
getDocumentTemplate 1 param → 200
PUT
/predefinedTerms/{id}
Update predefined terms
updateDocumentTemplate 1 param body → default
DELETE
/predefinedTerms/{id}
Delete predefined terms
deleteDocumentTemplate 1 param → 200
PUT
/predefinedTerms/{id}/status/{status}
Update predefined terms status
updateDocumentTemplateStatus 2 params → default
GET
/predefinedTerms/{id}/versions/{version}
Get predefined terms version detail
getDocumentTemplateVersion 2 params → 200
Email 4
GET
/emailSettings
Fetch the email settings
getEmailSettings → 200
POST
/emailSettings
Add a new email setting
addEmailSetting body → 200
PUT
/emailSettings
Update an existing email setting
updateEmailSetting body → 200
DELETE
/emailSettings
Delete an email setting
deleteEmailSetting body → 200
Entities 6
GET
/entities
Gets entities
getEntities → 200
POST
/entities
Create an entity
create body → default
GET
/entities/{id}
Gets entity details
getEntityById 1 param → 200
DELETE
/entities/{id}
Delete entity
deleteEntity 1 param → default
GET
/entities/logo/{entityId}
Get entity logo
getLogo 1 param → default
PUT
/entities/logo/{entityId}
Update entity logo
uploadLogo 1 param body → default
ERP 9
POST
/erp/processSyncTasks/{accountingPeriodId}
Trigger ERP journal entry sync task
processSyncTasks 1 param → default
POST
/erp/processDeleteTasks/{accountingPeriodId}
Trigger ERP journal entry deletion task
processDeleteTasks 1 param → default
POST
/erp/syncInvoice/{invoiceId}
Trigger ERP invoice sync task
syncInvoiceToErp 1 param → default
GET
/erp/syncInvoice/enabled
Check if invoice sync to ERP is enabled
isSyncInvoiceToErpEnabled → default
POST
/erp/syncInvoices
Trigger ERP invoice sync tasks for multiple invoices
syncInvoicesToErp body → default
POST
/erp/syncCreditMemo/{creditMemoNumber}
Trigger ERP credit memo sync task
syncCreditMemoToErp 1 param → default
POST
/erp/syncVoidInvoice/{invoiceNumber}
Trigger ERP void invoice sync task
syncVoidInvoiceToErp 1 param → default
GET
/rh/invoices/{invoiceId}/erpSync
getInvoiceErpSyncData 1 param → default
GET
/rh/payments/{paymentId}/erpSync
getPaymentErpSyncData 1 param → default
Experimental 11
GET
/guidedSelling/usecase/{id}/qscript
getUsecaseScript 1 param → default
PUT
/guidedSelling/usecase/{id}/qscript
putQScript 1 param body → default
GET
/guidedSelling/usecase
listUsecases → default
POST
/guidedSelling/usecase
addUsecase body → default
PUT
/guidedSelling/usecase/{usecase}/nextQuestion
Get Next Question for Guided Selling
fetchNextQuestion 1 param body → 200
PUT
/guidedSelling/usecase/{usecase}/nextQuestions
Get The next set of questions based on the answers provided so far
fetchNextQuestions 1 param body → 200
GET
/guidedSelling/usecase/{id}
getUsecase 1 param → default
PUT
/guidedSelling/usecase/{id}
updateUsecase 1 param body → default
DELETE
/guidedSelling/usecase/{id}
deleteUsecase 1 param → default
PUT
/guidedSelling/usecase/{usecase}/buildOrder
Build an order using the guided selling answers
buildOrderFromAnswers 3 params body → 200
PUT
/guidedSelling/ai/answers
Use AI to get answers for guided selling questions
getAnswersFromAi body → 200
Import 11
GET
/import/{importId}/result
Get import details
getImportResult_2 1 param → default
GET
/import
Gets all import items
getDataImports → 200
POST
/import
Validate import file
validateMultiPartFileImport body → 200
GET
/import/{importId}
Gets an import item
getDataImportById 1 param → 200
GET
/import/export/newOrders
Get new orders in import CSV format
getNewOrderExportInImportFormat 1 param → default
GET
/import/export/amendmentOrders
Get amendment orders in import CSV format
getAmendmentOrderExportInImportFormat 2 params → default
GET
/import/export/accountContact
Get account contacts for export
getAccountContactsInImportFormat → default
GET
/import/export/catalog
Get catalog data for export
getCatalogDataInImportFormat → default
PUT
/import/{importId}/process
Process an import by ID
processImport 1 param → 200
GET
/import/schemas
Return available schemas
getAvailableSchemas → 200
POST
/import/flatfile/{domain}
Create a Flatfile workbook
createFlatfileWorkbook 1 param → 200
MetricsReporting 4
GET
/metricsReporting/externalArrMetrics/{id}
gets external arr metrics request for the provided id
getExternalArrMetrics 1 param → default
GET
/metricsReporting/externalArrMetrics
gets external arr metrics requests submitted
getExternalArrMetrics_1 2 params → default
POST
/metricsReporting/externalArrMetrics
submit request to generate external arr metrics
addExternalArrMetrics body → default
PUT
/metricsReporting/populateArrMetrics/subscriptions/{subscriptionId}
submit request to generate/regenerate arr metrics for a subscription
populateArrMetricsForSubscription 1 param → default
Notifications 4
GET
/notifications
Get all notifications
getAllNotificationSubscriptionsForTenant → 200
POST
/notifications
Add a notification target
addTargetAndEventsSubscriptions body → 200
POST
/notifications/{notificationId}
Attach an event to a notification
subscribeExistingNotificationTargetToEvent 2 params → default
POST
/notifications/unsubscribe/{notificationId}
Unsubscribe from an event
unsubscribeTargetOrEvent 2 params → default
Opportunity 4
POST
/opportunity
Creates a standalone opportunity
createOpportunity body → 200
PUT
/opportunity/{id}
Updates a standalone opportunity
updateOpportunity 1 param body → 200
POST
/opportunity/{id}/open
Opens an opportunity
resetOpportunityClosedState 1 param → 200
GET
/opportunity/accountCrmId/{id}
Get opportunities by account CRM ID
getOpportunitiesByAccountCrmId 1 param → 200
Payments 21
GET
/payments/bank-account/{id}
Get a payment bank account by id
getBankAccount 1 param → 200
DELETE
/payments/bank-account/{id}
Get a payment bank account by id
deleteBankAccount 1 param → 200
POST
/payments/{paymentId}/retry/manual
Manually retries a payment
manualPaymentRetry 2 params → 200
GET
/payments/payment-gateways
Gets the list of payment integrations
getPaymentIntegrations → default
GET
/payments/bank-account/accounts/ledger
Gets cash and expense ledger accounts for bank account creation
getLedgerAccountsForPaymentBankAccount 1 param → 200
POST
/payments/processPaymentForInvoice/{invoiceNumber}
Processes one time payment for an invoice if there is an automatic payment set up for the account
processPaymentForInvoice 1 param → default
GET
/payments/retry/config
Gets a payment retry configuration
getPaymentRetryConfig 1 param → 200
POST
/payments/retry/config
Creates or updates a payment retry configuration
upsertPaymentRetryConfig body → 200
DELETE
/payments/retry/config/{id}
Deletes a payment retry configuration
deletePaymentRetryConfig 1 param → 200
GET
/payments/{id}
Get payment details
getPayment 1 param → 200
DELETE
/payments/{id}
Delete payment by payment id
deletePayment 1 param → 200
GET
/payments/account/{id}
Get payments
getAccountPayment 1 param → 200
GET
/payments/configuration
Get payment configuration
getPaymentConfiguration → 200
POST
/payments/configuration
Update payment configuration
updatePaymentConfiguration body → 200
GET
/payments/account-payment/{id}
Get account payment management link
getAccountPaymentManagementLink 1 param → 200
POST
/payments/bank-account
Adds a new payment bank account
upsertBankAccount body → 200
GET
/payments
Get all payments
getPayments 2 params → 200
GET
/payments/{id}/canDelete
Check if the payment object can be deleted
canDeletePayment 1 param → 200
GET
/payments/{id}/balance
Get payment balance
getPaymentBalance 1 param → 200
PUT
/payments/{id}/void
Voids a payment
voidPayment 1 param body → 200
POST
/stripe-import/payment-method/csv
Import Stripe payment method via CSV
importStripePaymentMethodCSV body → default
Health 1
GET
/ping
Simple ping with auth to check if everything is working fine
ping_1 → default
Platform Feature 1
GET
/platformFeature/isAccountingFeatureEnabled
Check if the tenant has accounting feature enabled
isAccountingFeatureEnabled → 200
Settings 44
GET
/termsections/{id}
Get predefined terms section detail
getTermSection 1 param → 200
PUT
/termsections/{id}
Update predefined terms section
updateTermSection 1 param body → 200
DELETE
/termsections/{id}
Delete predefined terms section
deleteTermSection 1 param → default
GET
/termsections
Get predefined terms sections
getTermSections → 200
POST
/termsections
Add predefined terms section
addTermSection body → 200
GET
/taxrates/strategies/{id}/{countryCode}
Get tax rate strategy by Id and Country Code
getTaxRateStrategy 2 params → 200
PUT
/taxrates/strategies/{id}/{countryCode}
Update tax rate strategy
updateTaxRateStrategy 2 params body → default
DELETE
/taxrates/strategies/{id}/{countryCode}
Delete tax rate strategy
deleteTaxRateStrategy 2 params → default
GET
/taxrates
Get tax rates
getTaxRates 2 params → 200
POST
/taxrates
Add tax rate
addTaxRate body → 200
GET
/taxrates/{id}
Get tax rate by Id
getTaxRate 1 param → 200
PUT
/taxrates/{id}
Update tax rate
updateTaxRate 1 param body → default
DELETE
/taxrates/{id}
Delete tax rate
deleteTaxRate 1 param → 200
GET
/taxrates/strategies
Get tax rate strategies
getTaxRateStrategies 3 params → 200
POST
/taxrates/strategies
Add tax rate strategy
addTaxRateStrategy body → 200
GET
/taxrates/strategies/{id}
Get all tax rate strategies by Id
getTaxRateStrategiesById 1 param → 200
DELETE
/taxrates/strategies/{id}
Delete all tax rate strategies by Id
deleteAllTaxRateStrategiesById 1 param → default
GET
/tenants
Get tenant details
getTenant → 200
PUT
/tenants
Update tenant details
updateTenant body → default
GET
/tenants/logo
Get tenant logo
getTenantLogo → default
PUT
/tenants/logo
Update tenant logo
uploadTenantLogo body → 200
GET
/settings/ui/customizations
Fetch UI customization config for the tenant
getTenantUICustomizationConfig → default
POST
/settings/ui/customizations
Update UI customization config for the tenant
updateTenantUICustomizationConfig body → default
DELETE
/settings/ui/customizations
Remove UI customization config for the tenant
deleteTenantUICustomizationConfig → default
PUT
/settings/docxSettings
Update DOCX settings
updateDocxSettings body → default
GET
/settings/autoReplacePlans
Get plan replacement settings
getAutoReplacePlans → default
PUT
/settings/autoReplacePlans
Update plan replacement settings
updateAutoReplacePlans body → default
GET
/settings/paymentTerms
Get payment term settings
getPaymentTermSettings → default
PUT
/settings/paymentTerms
Update payment term settings
updatePaymentTermSettings body → default
GET
/settings/billingCycle
Get current billing cycle definitions
getBillingCycleDefinitions → 200
POST
/settings/billingCycle
Add new billing cycle definition
addBillingCycleDefinition body → default
GET
/settings/billingCycle/{id}
Get billing cycle definition by id
getBillingCycleDefinition 1 param → 200
PUT
/settings/billingCycle/{id}
Update billing cycle definition
updateBillingCycleDefinition 1 param body → default
GET
/settings
Get tenant settings
getTenantSetting → 200
PUT
/settings
Update tenant settings
updateTenantSetting body → default
POST
/settings/billingCycle/setDefault
Set billing cycle with given id as default
setDefaultBillingCycleDefinition body → default
GET
/settings/supportedCurrencies
Get supported currencies
getSupportedCurrencies → default
PUT
/settings/supportedCurrencies
Update supported currencies
updateSupportedCurrencies body → default
GET
/unitsOfMeasure
Get units of measure
getUnitsOfMeasure 2 params → 200
POST
/unitsOfMeasure
Add unit of measure
addUnitOfMeasure body → 200
PUT
/unitsOfMeasure/{id}
Update unit of measure
updateUnitOfMeasure 1 param body → 200
DELETE
/unitsOfMeasure/{id}
Delete unit of measure
deleteUnitOfMeasure 1 param → 200
POST
/unitsOfMeasure/{id}/activate
Activate unit of measure
activateUnitOfMeasure 1 param → default
POST
/unitsOfMeasure/{id}/deprecate
Deprecate unit of measure
deprecateUnitOfMeasure 1 param → default
Prismatic 6
GET
/prismatic/schema
Get JSON Schema for a Prismatic object type
getSchema 2 params → default
GET
/prismatic/app-url
Get Prismatic app URL
getAppUrl → default
POST
/prismatic/marketplace-jwt
Generate Prismatic marketplace JWT
generateMarketplaceJwt → default
POST
/prismatic/syncInvoice/{invoiceId}
Trigger Prismatic invoice sync task
syncInvoice 1 param → default
GET
/prismatic/syncInvoice/enabled
Check if Prismatic invoice sync is enabled
isSyncInvoiceEnabled → default
POST
/prismatic/syncInvoices
Trigger Prismatic invoice sync tasks for multiple invoices
syncInvoices body → default
RateCard 6
PUT
/ratecards/{id}/csv
create a rate card using CSV price table multipart form data
updateRateCardCsv 1 param body → default
GET
/ratecards
Fetch the list of rate cards stored in the system
getRateCards → default
POST
/ratecards/csv
create a rate card using CSV price table multipart form data
addRateCardCsv body → default
GET
/ratecards/attributes/csv
Fetch the price attributes defined in the system in CSV format
getPriceAttributesCsv → default
POST
/ratecards/attributes/csv
Import price attributes into the system
importPriceAttributes body → default
GET
/ratecards/{id}/priceTable
Fetch the price table for the rate card given the id
getRateCardPriceTable 1 param → default
Refunds 3
GET
/refunds
Get refunds
getRefunds 2 params → 200
POST
/refunds
Create and apply refund
createAndApplyRefund body → default
GET
/refunds/{id}
Get refund details
getRefundById 2 params → 200
Reports 4
POST
/reports/run
Run a report
run body → default
POST
/reports/generate
Generate a report
generate body → 200
GET
/reports/{reportRunId}/result
Run a generated report
getReportOutput 1 param → default
GET
/reports
Get report definitions
getPredefinedReportDefs → 200
Revenue Enablement 9
PUT
/revenueEnablement/enable
Enable revenue recognition
enableRevenueRecognition → default
GET
/revenueEnablement/readiness/doesOpenAccountingPeriodExist
Check if an open accounting period exists
doesOpenAccountingPeriodExist → default
GET
/revenueEnablement/readiness/areAllChargesTaggedWithRevenueRules
Check if all charges are tagged with revenue rules
areAllChargesTaggedWithRevenueRules → default
GET
/revenueEnablement/readiness/areAllChargesTaggedWithGLAccounts
Check if all charges are tagged with GL accounts
areAllChargesTaggedWithGLAccounts → default
GET
/revenueEnablement/readiness/doAllOrderLinesHaveSchedules
Check if all order lines have schedules
doAllOrderLinesHaveSchedules → default
GET
/revenueEnablement/readiness/areAccountingEventsPresentForAllTransactionTypes
Check if accounting events are present for all transaction types
areAccountingEventsPresentForAllTransactionTypes → default
GET
/revenueEnablement/progress
Get revenue enablement progress
getRevenueEnablementProgress → default
PUT
/revenueEnablement/progress
Update revenue enablement progress
upsertRevenueEnablementProgress body → default
DELETE
/revenueEnablement
Delete all accounting and revenue recognition data
deleteAllAccountingAndRevenueRecognitionData → default
Revenue Recognition 11
GET
/revrec/events
Get revenue recognition events
getRecognitionEventsBySubscriptionIdChargeId 3 params → 200
POST
/revrec/events
Create a revenue recognition event
createRecognitionEvent body → default
GET
/revrec/rules
Get revenue recognition rules
getRecognitionRuleById → default
POST
/revrec/rules
Create a revenue recognition rule
addRecognitionRule body → default
GET
/revrec/rules/{id}
Get revenue recognition rule
getRecognitionRuleById_1 1 param → default
DELETE
/revrec/rules/{ruleId}
Delete a recognition rule
deleteRule 1 param → 200
POST
/revrec/bulk
Create a bulk revenue recognition
createBulkRevenueRecognition body → 200
GET
/revrec/bulk/{bulkRevenueRecognitionId}
Get bulk revenue recognition details
getBulkRevenueRecognition 1 param → 200
GET
/revrec/bulk/{bulkRevenueRecognitionId}/revrecItems
Get items for bulk revenue recognition
getBulkRevenueRecognitionItems 1 param → 200
GET
/revrec/waterfall
Download waterfall report
getRevenueWaterfall 2 params → default
POST
/revrec/events/upload
Upload revenue events
uploadCompletionEvents body → default
Subscriptions 21
GET
/subscriptions/{id}
Get subscription details
getSubscriptionById 1 param → 200
PUT
/subscriptions/{id}
Update subscription details
updateSubscription 1 param body → default
GET
/subscriptions/{id}/draftAmendment
Generate draft amendment order
getDraftAmendment 1 param → 200
GET
/subscriptions/{id}/draftRenewal
Generate draft renewal order
getDraftRenewal 1 param → 200
GET
/subscriptions/{id}/modifiable
Subscription can be modified
subscriptionModifiable 1 param → default
GET
/subscriptions/{id}/reversible
Subscription can be reverted
subscriptionReversible 1 param → default
GET
/subscriptions/{id}/billingPeriods
Get billing periods
getSubscriptionBillingPeriods 1 param → 200
POST
/subscriptions/{id}/test-notifications
Send test notifications for subscription
sendTestNotificationsForSubscription 2 params → 200
GET
/subscriptions/{id}/change-events
Get change events for subscription
getAllChangeEventsForSubscription 1 param → 200
GET
/subscriptions
Get paginated subscriptions
getSubscriptions 3 params → 200
DELETE
/subscriptions/{id}/{version}
Delete subscription
deleteSubscription 2 params → default
PUT
/subscriptions/{id}/{version}/revert
Revert subscription
revertSubscription 2 params → default
POST
/subscriptions/{id}/renewalOpportunity
Link renewal opportunity to subscription
updateRenewalOpportunity 2 params → default
GET
/subscriptions/{id}/metrics
Get subscription metrics
getSubscriptionMetrics 3 params → 200
POST
/rh/subscriptions/{subscriptionId}/renew
Renew an existing subscription
renewSubscription 1 param body → default
GET
/rh/subscriptions
Get subscriptions
getSubscriptions_1 3 params → 200
GET
/rh/subscriptions/{id}/detail
Get subscription details
getSubscriptionById_1 1 param → 200
POST
/rh/subscriptions/{id}/detail/lines
Get subscription lines
getSubscriptionLines 1 param body → default
GET
/rh/subscriptions/detail
Get subscriptions with detail
getSubscriptionsWithDetail 5 params → 200
POST
/rh/subscriptions/{subscriptionId}/amend
Amend an existing subscription
amendSubscription 1 param body → default
POST
/rh/subscriptions/{subscriptionId}/cancel
Cancel an existing subscription
cancelSubscription 1 param body → default
TemplateScript 3
GET
/templateScript
Fetch template scripts
getTemplateScripts 1 param → 200
POST
/templateScript
Add a new template script
addTemplateScript body → 200
DELETE
/templateScript
Disable a template script
disableTemplateScript body → default
Jobs 4
POST
/tenantJobs/dispatch
Dispatch tenant job
dispatch body → default
POST
/tenantJobs/retry
Retry tenant job
executeTenantJob 1 param → default
POST
/tenantJobs/{jobId}/cancel
Cancel tenant job
cancelTenantJob 1 param → default
GET
/tenantJobs/{jobId}
Get tenant job
getTenantJob 1 param → default
Foreign Exchange 4
POST
/fx/transactional/refresh
Refresh transactional exchange rates
refreshExchangeRates 1 param → default
GET
/fx/transactional/latest
Get latest transactional exchange rates
getLatestExchangeRates → 200
GET
/fx/transactional/asof
Get as of transactional exchange rate for a currency pair
getExchangeRateAsOf 3 params → 200
POST
/fx/transactional/refreshPair
Refresh transactional exchange rate by currency pair
refreshExchangeRatePair 3 params → default
Users 15
GET
/userGroups
Get user groups
getUserGroups → 200
POST
/userGroups
Add user group
addUserGroup body → 200
PUT
/userGroups
Update user group
updateUserGroup body → 200
GET
/userGroups/{userGroupId}
Get user group
getUserGroup 1 param → 200
DELETE
/userGroups/{userGroupId}
Delete user group
deleteUserGroup 1 param → 200
POST
/users/upload
Bulk user upload
uploadCSV body → default
POST
/users/resend-email/{email}
Resend welcome email
resendEmailForExistingUser 1 param → 200
GET
/users
Get users list
getUsers 2 params → 200
POST
/users
Add a new user
addUser body → 200
POST
/users/terms-and-conditions
Accept terms and conditions
acceptTermsForCurrentUser → default
PUT
/users/disable/{id}
Disable user
disableUser 1 param → 200
PUT
/users/enable/{id}
Enable user
enableUser 1 param → 200
GET
/users/{id}
Get user by Id
getUser 1 param → 200
PUT
/users/{id}
Update user
updateUser 1 param body → default
PUT
/users/{id}/sso
Update user SSO configuration
updateUserSSOConfig 1 param body → default
Account 9
GET
/rh/accounts/{accountId}
getCpqSourcedAccount 1 param → default
PUT
/rh/accounts/{accountId}
updateCpqSourcedAccount 1 param body → default
POST
/rh/accounts
addCpqSourcedAccount body → default
POST
/rh/accounts/bulk
getCpqSourcedAccounts body → default
GET
/rh/accounts/cfac-id
getCpqSourcedAccountsByUvcaCfacId 1 param → default
GET
/rh/accounts/{accountId}/contacts
getCpqSourcedAccountContacts 1 param → default
POST
/rh/accounts/{accountId}/contacts
addCpqSourcedAccountContact 1 param body → default
GET
/rh/accounts/{accountId}/contacts/{contactId}
getCpqSourcedAccountContact 2 params → default
PUT
/rh/accounts/{accountId}/contacts/{contactId}
updateCpqSourcedAccountContact 2 params body → default
Invoice 1
GET
/rh/invoices
getCpqSourcedAccountInvoices 4 params → default
Order 3
GET
/rh/orders/{orderIdentifier}
Get an order by its identifier
getOrder_1 1 param → 200
GET
/rh/orders/{orderIdentifier}/memoizedInvoiceItems
Compute memoized invoice line items for given order
getMemoizedInvoiceItems 2 params → 200
POST
/rh/orders
postBillableOrder body → default
Search 2
GET
/rh/search
Run a search query
search 1 param → default
POST
/rh/search
Run a search query (POST)
searchPost body → default
Product Provisioning 1
POST
/rh/product-provisioning
syncSkus body → default
Tenant 1
POST
/rh/tenants
createRevHubTenant body → default

Schemas 311

The contract defines 311 schemas that model the data the API accepts and returns. The most detailed are OrderJson (60 properties), OrderRequestJson (47 properties), ChargeJson (46 properties), InvoiceJson (35 properties). Each schema is shown below with its type and property counts.

AccountAddressJson
object
7 properties
AccountReceivableContactJson
object
5 properties 1 required
AccountJson
object
21 properties 1 required
CustomFieldDefault
object
2 properties
CustomFieldValue
object
9 properties
AccountContactJson
object
12 properties 1 required
PaginatedAccountsResponse
object
3 properties
MetricsJson
object
10 properties
TimeSeriesAmountJson
object
2 properties
AccountPaymentMethodJson
object
6 properties 1 required
ErpInputJson
object
1 property
CrmAccountImportResponse
object
2 properties
AccountPaymentConfigurationJson
object
3 properties 2 required
AccountingPeriod
object
15 properties
AccountingPeriodCalculation
object
6 properties
ApprovalSegmentJson
object
5 properties
EntityRef
object
3 properties 2 required
UserGroupJson
object
6 properties
UserJson
object
17 properties
MediaType
object
5 properties
OutboundEvent
object
8 properties
Type
object
1 property
Message
object
3 properties 3 required
SubscriptionChargeAlias
object
4 properties
AnrokIntegrationInput
object
1 property 1 required
AccountAddress
object
11 properties
Integration
object
11 properties
JSONObject
object
1 property
ApprovalFlowJson
object
8 properties
ApprovalRuleConditions
object
2 properties
ApprovalStateActionJson
object
1 property
ApprovalStateJson
object
7 properties
ApprovalTransitionRuleJson
object
6 properties
ApprovalMatrixImportDataJson
object
6 properties
ApprovalMatrixImportPreview
object
5 properties
ApprovalRoleSegmentChange
object
4 properties
ApprovalRoleJson
object
5 properties
Attachment
object
10 properties 3 required
AuthSamlIntegrationJson
object
3 properties
AutomatedInvoiceRuleRequestJson
object
14 properties 3 required
AutomatedInvoiceRule
object
19 properties
AvalaraIntegrationInput
object
5 properties
AvalaraIntegration
object
7 properties
InvoiceBankTransactionMatchResponse
object
5 properties
MatchBankTransactionsRequest
object
2 properties
BankTransactionPotentialInvoice
object
16 properties
PaginatedBankTransactionPotentialInvoiceResponse
object
4 properties
PotentialInvoice
object
5 properties
BankTransactionsUploadData
object
11 properties
BankTransactionsUploadResult
object
4 properties
ChargeJson
object
JSON object representing the charge details.
46 properties 3 required
LedgerAccountMapping
object
5 properties
PriceTierJson
object
3 properties 2 required
RecurrenceJson
object
2 properties 2 required
AttributeReference
object
2 properties
CompositeOrderJson
object
13 properties
CreditableAmount
object
3 properties
CustomFieldEntry
object
10 properties
CustomPredefinedTemplateOnOrder
object
5 properties
DiscountDetailJson
object
6 properties
OpportunityJson
object
15 properties
OrderCreationCustomizationOutputJson
object
3 properties
OrderJson
object
60 properties 3 required
OrderLineActionsPerformedJson
object
2 properties
OrderLineItemJson
object
31 properties 1 required
OrderLineRuleWarningsJson
object
2 properties
OrderTerms
object
8 properties
PricingOverrideJson
object
3 properties
RuleActionPerformedJson
object
2 properties
RuleTraceJson
object
6 properties
TenantDiscountJson
object
6 properties
TenantDiscountLineItemJson
object
7 properties
CreditMemoJson
object
20 properties 8 required
CreditMemoLineItemJson
object
10 properties 1 required
VoidCreditMemoRequest
object
2 properties 1 required
CreditMemoPaginationResponseJson
object
3 properties
CreditMemoLineItemRequestJson
object
4 properties
StandaloneCreditMemoRequest
object
13 properties 5 required
TenantCreditMemoConfigurationJson
object
4 properties
CreditMemoBalanceJson
object
4 properties
CrmFieldMappingImportDataJson
object
6 properties
CrmFieldMappingImportPreview
object
3 properties
UpdateCrmFieldMappingDetail
object
13 properties
CrmOpportunityNameChangeNotificationRequest
object
3 properties 2 required
CrmContact
object
13 properties
SubskribeSalesforceContact
object
12 properties
UpsertCRMContactResponse
object
5 properties
UpsertCrmContactsRequest
object
2 properties
CustomFieldDefinitionCreateInput
object
8 properties 2 required
CustomFieldDefinitionJson
object
10 properties
CustomFieldDefinitionUpdateInput
object
5 properties
CustomFieldUpdateInput
object
2 properties
DealPulseListResponse
object
2 properties 1 required
DealPulseOverview
object
13 properties 8 required
TrackDealPulseEventRequest
object
3 properties 1 required
DiscountJson
object
5 properties
DocuSignIntegrationRequestJson
object
3 properties
DocuSignReauthenticationResponseJson
object
1 property 1 required
DocuSignIntegrationResponseJson
object
5 properties
DocumentTemplateJson
object
11 properties 1 required
DocumentTemplateRequestJson
object
9 properties 1 required
DunningSettingJson
object
2 properties 1 required
EmailSetting
object
5 properties 2 required
CompanyContactJson
object
5 properties 1 required
EntityJson
object
14 properties 4 required
NumberConfig
object
5 properties
AccountContact
object
18 properties
Entity
object
15 properties 4 required
TimeZone
object
4 properties
NextQuestion
object
2 properties 1 required
Question
object
5 properties 4 required
QuestionSchema
object
4 properties 1 required
Answer
object
3 properties 1 required
NextQuestions
object
3 properties 1 required
GuidedSellingUsecase
object
4 properties 1 required
QuestionDefinition
object
7 properties 4 required
MessagesAndAnswer
object
4 properties
GuidedSellingInput
object
3 properties 1 required
DataImport
object
13 properties
FlatfileWorkbookResponse
object
1 property 1 required
FlatfileWorkbookResponseData
object
2 properties 2 required
IntelligentSalesRoomFile
object
12 properties
IntelligentSalesRoomOverviewResponse
object
20 properties
IntelligentSalesRoomThemeResponse
object
7 properties
IntelligentSalesRoomWidget
object
10 properties
IntelligentSalesRoomUpdateWidgetRequest
object
2 properties
IntelligentSalesRoomReorderWidgetsRequest
object
1 property 1 required
IntelligentSalesRoomTheme
object
10 properties
IntelligentSalesRoomUpdateThemeRequest
object
5 properties 1 required
IntelligentSalesRoomAIGeneratedContent
object
8 properties
IntelligentSalesRoomUpdateAIContentRequest
object
1 property
IntelligentSalesRoomEngagementSummaryResponse
object
7 properties
IntelligentSalesRoomActivityLog
object
5 properties
IntelligentSalesRoomShareLinkAccess
object
8 properties
IntelligentSalesRoomUpdateCustomerInfoRequest
object
IntelligentSalesRoomTrackEventRequest
object
3 properties 1 required
IntelligentSalesRoomCreateWidgetRequest
object
3 properties 1 required
IntelligentSalesRoomExtractThemeRequest
object
1 property
IntelligentSalesRoomShareLinkAccessRequest
object
2 properties
IntelligentSalesRoomEngagementSession
object
14 properties
EmailContact
object
5 properties
BulkInvoiceRun
object
16 properties
BulkInvoiceRunExclusions
object
2 properties
BulkInvoiceRunSelector
object
1 property
BulkInvoiceRunItem
object
22 properties
InvoiceBalanceJson
object
4 properties
EmailNotifiersList
object
3 properties
InvoiceItemJson
object
25 properties
InvoiceJson
object
35 properties
TaxRateJson
object
8 properties 1 required
InvoiceItemPreviewJson
object
6 properties
InvoicePreviewJson
object
6 properties
InvoiceJsonPaginationResponse
object
3 properties
UpdateInvoiceRequest
object
6 properties 1 required
VoidInvoiceRequest
object
2 properties 2 required
BillingEventEntry
object
4 properties
InvoiceNumberPrefix
object
1 property
TenantInvoiceConfig
object
5 properties
InvoiceDeletableResponse
object
2 properties
BillingEventInput
object
4 properties 1 required
BulkInvoiceRunInput
object
7 properties
PaymentBankAccountJson
object
12 properties 3 required
SettlementApplication
object
17 properties
ApplyPaymentRequest
object
9 properties
BulkPaymentUploadData
object
13 properties
BulkPaymentUploadResult
object
3 properties
CreditMemoApplicationJson
object
6 properties 2 required
CreditMemoUnapplicationJson
object
6 properties 2 required
AccountingEvent
object
12 properties
AccountingEventPaginatedResponse
object
4 properties
ByteBuffer
object
8 properties
LedgerAccount
object
9 properties
ExternalArrScheduleJson
object
10 properties 4 required
NotificationTargetAndSubscriptions
object
6 properties
OpportunityPaginationResponse
object
3 properties
OpportunityRestJson
object
12 properties
ApprovalSubmissionJson
object
Single approval submission attempt (approval domain only)
9 properties 3 required
ApprovalSummaryJson
object
Summary statistics across all approval attempts
5 properties 1 required
ApproverJson
object
Individual approver with timeline data (approval domain only)
8 properties 2 required
OrderApprovalHistoryResponse
object
Complete approval history for an order (approval domain only)
6 properties 3 required
WorkflowJson
object
Approval workflow with approver details (approval domain only)
8 properties 4 required
OrderJsonPaginationResponse
object
3 properties
CustomBillingPeriodInput
object
4 properties 1 required
CustomBillingRecurrence
object
2 properties
CustomBillingScheduleInput
object
4 properties 1 required
DocumentCustomContent
object
4 properties
OpportunityInput
object
11 properties
OrderLineItemRequestJson
object
22 properties 1 required
OrderRequestJson
object
JSON object containing information required to create an order.
47 properties 2 required
OrderAttributesUpdateRequest
object
8 properties
BillingPeriod
object
8 properties
CustomBillingPeriodOutput
object
4 properties
CustomBillingScheduleOutput
object
8 properties
Duration
object
5 properties
Period
object
3 properties
Recurrence
object
3 properties
TemporalUnit
object
4 properties
PaymentRetryResult
object
3 properties
IntervalBasedPaymentRetryPolicy
PaymentRetryConfigOutput
object
2 properties 2 required
PaymentRetryPolicy
object
3 properties 1 required
ScheduleEntry
object
2 properties
PaymentRetryConfigInput
object
2 properties 1 required
PaymentJson
object
15 properties 2 required
PaymentConfiguration
object
1 property
PaymentJsonPaginationResponse
object
3 properties
PaymentDeletableResponse
object
2 properties
PaymentBalanceJson
object
4 properties
VoidPaymentJson
object
5 properties 3 required
PlanJson
object
A plan is a collection of charges that dictates how a product is priced.
15 properties 4 required
PlanMetadataJson
object
1 property
ChargePartialJson
object
JSON object representing the charge details.
21 properties 1 required
PlanJsonPaginationResponse
object
3 properties
DocumentSection
object
6 properties 1 required
ProductCategory
object
7 properties
ProductCategoryPaginationResponse
object
3 properties
ProductJson
object
12 properties 2 required
ProductJsonPaginationResponse
object
3 properties
ProductInputJson
object
8 properties 2 required
RefundDetail
object
14 properties 6 required
Refund
object
15 properties
RefundRequestJson
object
8 properties 5 required
PredefinedReportJson
object
4 properties
ReportDuration
object
2 properties
ReportJobResponse
object
4 properties
PredefinedReportDefChartJson
object
10 properties
PredefinedReportDefJson
object
5 properties
PredefinedReportDefsJson
object
1 property
PredefinedReportParam
object
7 properties 2 required
PredefinedReportParamObject
object
7 properties 2 required
RevenueEnablementProgress
object
16 properties
RecognitionEventCompletion
object
12 properties 1 required
RecognitionRule
object
13 properties
BulkRevenueRecognitionInput
object
4 properties
BulkRevenueRecognition
object
11 properties
BulkRevenueRecognitionItem
object
9 properties
SalesforceClientIntegrationRequestJson
object
4 properties
SalesforceAccount
object
6 properties
SalesforceAccountBillingAddress
object
5 properties
CustomField
object
2 properties
Opportunity
object
15 properties
SubscriptionUpdateJson
object
9 properties
SubscriptionChargeChangeSchedule
object
10 properties
SubscriptionSchedules
object
2 properties
SubscriptionStatusChangeSchedule
object
9 properties
PaginatedSubscriptionsResponse
object
3 properties
PurchaseOrder
object
3 properties
SubscriptionChargeJson
object
18 properties 7 required
SubscriptionJson
object
34 properties 11 required
TaxJarIntegrationInput
object
2 properties 1 required
TaxJarIntegration
object
7 properties
TaxRateStrategyJson
object
4 properties 1 required
TaxRatePaginationResponseJson
object
3 properties
TaxRateStrategyPaginatedResponse
object
4 properties
TemplateScript
object
7 properties 3 required
TenantJob
object
19 properties
TenantJson
object
16 properties
TenantSettingJson
object
11 properties
BackendConfig
object
2 properties
Condition
object
3 properties
Customization
object
8 properties 1 required
DefaultValueDefinition
object
2 properties
TenantUiCustomization
object
2 properties 1 required
DocxSettings
object
2 properties
PaymentTermSettingsJson
object
3 properties 3 required
BillingCycleDefinitionJson
object
5 properties
BillingCycleDefinitionAdd
object
3 properties
BillingCycleDefinitionUpdateJson
object
2 properties 1 required
DefaultBillingCycleDefinitionInput
object
1 property 1 required
TransactionalExchangeRate
object
8 properties 6 required
UnitOfMeasureJson
object
4 properties 1 required
UnitOfMeasurePaginationResponseJson
object
3 properties
Entry
object
3 properties
UsageBatchInsertResult
object
4 properties
RawUsage
object
A raw usage record
7 properties
RawUsagesData
object
A list of RawUsage objects
1 property 1 required
UsageAggregateOutput
object
9 properties
PrepaidStats
object
15 properties
UserGroupRequestJson
object
6 properties
InputStream
object
UserPaginationResponseJson
object
3 properties
UserInput
object
10 properties
UserSsoUpdate
object
1 property
NewAccountJson
object
18 properties 3 required
AccountQueryRequest
object
1 property 1 required
NewAccountContactJson
object
13 properties 2 required
Factor
object
3 properties 3 required
Order
object
23 properties 14 required
OrderLineItem
object
17 properties 10 required
OrderPeriodMetadata
object
3 properties 2 required
NewOrderInput
object
20 properties 12 required
NewOrderLineItemInput
object
14 properties 9 required
NewOrderRequest
object
2 properties 1 required
JsonNode
object
NewSkuSyncRequest
object
1 property 1 required
SkuProductAttributes
object
12 properties
SkuSyncInput
object
8 properties 2 required
RenewalLineItemInput
object
15 properties 9 required
RenewalOrderInput
object
18 properties 11 required
RenewalOrderRequest
object
1 property 1 required
PaginatedResult
object
3 properties 2 required
PaginatedResultSubscriptionHead
object
3 properties 2 required
Subscription
object
18 properties 14 required
SubscriptionLine
object
15 properties 12 required
PaginatedResultSubscription
object
3 properties 2 required
AmendmentOrderInput
object
9 properties 6 required
AmendmentOrderRequest
object
1 property 1 required
ModificationLineItem
object
16 properties 10 required
CancelLineItemInput
object
15 properties 10 required
CancelOrderInput
object
9 properties 6 required
CancelOrderRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dealhub-subskribe-api-openapi.yml Raw ↑
#Billing#Subscription#Usage-Based Billing#Revenue Recognition#Invoicing#Payments
← Back to D APIs
API Details
ID
dealhub:dealhub-subskribe-api
Base URL
https://api.app.subskribe.com
Docs
https://developers.dealhub.io/docs/orders-and-subscriptions
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-dealhub-subskribe-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/dealhub-dealhub-subskribe-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 Subskribe 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.