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

The Billing API from DealHub — 38 operation(s) for billing.

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

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

This API exposes 49 operations across 38 paths, and defines 35 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.

49 operations 38 paths 35 schemas 4 DELETE23 GET14 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 Billing 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 49

Across 38 paths, the API surfaces 49 operations — 4 DELETE, 23 GET, 14 POST, 8 PUT. 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

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are InvoiceJson (35 properties), InvoiceItemJson (25 properties), BulkInvoiceRunItem (22 properties), AccountJson (21 properties). Each schema is shown below with its type and property counts.

AutomatedInvoiceRuleRequestJson
object
14 properties 3 required
PaymentBankAccountJson
object
12 properties 3 required
InvoiceJson
object
35 properties
DunningSettingJson
object
2 properties 1 required
InvoiceDeletableResponse
object
2 properties
BulkInvoiceRunItem
object
22 properties
TenantInvoiceConfig
object
5 properties
SettlementApplication
object
17 properties
SubscriptionChargeAlias
object
4 properties
AutomatedInvoiceRule
object
19 properties
InvoiceJsonPaginationResponse
object
3 properties
CustomFieldDefault
object
2 properties
InvoiceItemPreviewJson
object
6 properties
CreditMemoUnapplicationJson
object
6 properties 2 required
VoidInvoiceRequest
object
2 properties 2 required
AccountContactJson
object
12 properties 1 required
AccountReceivableContactJson
object
5 properties 1 required
EmailNotifiersList
object
3 properties
TaxRateJson
object
8 properties 1 required
BillingEventInput
object
4 properties 1 required
AccountJson
object
21 properties 1 required
InvoiceBalanceJson
object
4 properties
InvoicePreviewJson
object
6 properties
BillingEventEntry
object
4 properties
BulkInvoiceRunInput
object
7 properties
InvoiceItemJson
object
25 properties
ApplyPaymentRequest
object
9 properties
BulkInvoiceRunSelector
object
1 property
UpdateInvoiceRequest
object
6 properties 1 required
AccountAddressJson
object
7 properties
CreditMemoApplicationJson
object
6 properties 2 required
InvoiceNumberPrefix
object
1 property
BulkInvoiceRunExclusions
object
2 properties
BulkInvoiceRun
object
16 properties
CustomFieldValue
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dealhub-billing-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 Callouts API
Where this information came from

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