Invoice

Generate a dryRun invoice

post/1.0/kb/invoices/dryRun

Request

The document declares no server URL.
Auth
- HTTP basic
- or API key in header X-Killbill-ApiKey
- or API key in header X-Killbill-ApiSecret
TypeScript
https://skmtc.dev/killbill/apis/kill-bill/docs/1.0/kb/invoices/dryRun/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

accountIdstring uuid required

targetDatestring date

Headers

X-Killbill-CreatedBystring required

X-Killbill-Reasonstring

X-Killbill-Commentstring

Request body

dryRunType'TARGET_DATE' | 'UPCOMING_INVOICE' | 'SUBSCRIPTION_ACTION'

phaseType'TRIAL' | 'DISCOUNT' | 'FIXEDTERM' | 'EVERGREEN'

productNamestring

productCategory'BASE' | 'ADD_ON' | 'STANDALONE'

priceListNamestring

subscriptionIdstring uuid

bundleIdstring uuid

effectiveDatestring date

billingPolicy'START_OF_TERM' | 'END_OF_TERM' | 'IMMEDIATE' | 'ILLEGAL'

Response

successful operation

amountnumber

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD' | 'BTC'

status'DRAFT' | 'COMMITTED' | 'VOID'

creditAdjnumber

refundAdjnumber

invoiceIdstring uuid

invoiceDatestring date

targetDatestring date

invoiceNumberstring

balancenumber

accountIdstring uuid

bundleKeysstring

trackingIdsstring[]

isParentInvoiceboolean

parentInvoiceIdstring uuid

parentAccountIdstring uuid

Changes

No recorded changes to this operation across all 4 revisions of this API.