Installments API

Endpoint Index

Action	Endpoint
Fetch Installments for a Quote	GET /billing/{tenantLocator}/installments/quotes/{quoteLocator}/list
Fetch Installments for a Policy	GET /billing/{tenantLocator}/installments/policies/{policyLocator}/list
Fetch Installments for a Policy Transaction	GET /billing/{tenantLocator}/installments/transactions/{transactionLocator}/list
Preview Installments for a Stateless Quote	GET /billing/{tenantLocator}/installments/quotes/statelessPreview

Fetch Installments for a Quote

fetchInstallmentsForQuote

GET /billing/{tenantLocator}/installments/quotes/{quoteLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
quoteLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InstallmentListResponse
Security Group:installments   Permissions:read,list

Fetch Installments for a Policy

fetchInstallmentsForPolicy

GET /billing/{tenantLocator}/installments/policies/{policyLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
policyLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InstallmentListResponse
Security Group:installments   Permissions:read,list

Fetch Installments for a Policy Transaction

fetchInstallmentsForPolicyTransaction

GET /billing/{tenantLocator}/installments/transactions/{transactionLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
transactionLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:InstallmentListResponse
Security Group:installments   Permissions:read,list

InstallmentListResponse

required
listCompleted boolean
items Installment[]

Installment

required
locator string
accountLocator string
installmentLatticeLocator string
dueTime datetime
generateTime datetime
currency string
timezone string
coverageDuration number
coverageEndTime datetime
coverageStartTime datetime
installmentDuration number
installmentEndTime datetime
installmentFrameIndex int
installmentStartTime datetime
updatedAt datetime
updatedBy uuid
createdAt datetime
createdBy uuid
installmentItems InstallmentItem[]

optional
policyLocator string?
termLocator string?
transactionLocator string?
invoiceLocator string?
migratedFromInstallmentLocator string?
quoteLocator string?
reversalOfInstallmentLocator string?
autopayTime datetime?

InstallmentItem

required
locator string
chargeLocator string
elementLocator string
elementStaticLocator string
installmentLocator string
amount number
chargeCategory string
chargeType string
createdAt datetime
createdBy uuid

optional
invoiceItemLocator string?
reversalOfInstallmentItemLocator string?

Preview Installments for a Stateless Quote

previewInstallmentsForStatelessQuote

GET /billing/{tenantLocator}/installments/quotes/statelessPreview

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
quotePreviewRequest	query	QuoteBillingPreviewRequest	required

Response:InstallmentsPreview
Security Group:installments   Permission:read

QuoteBillingPreviewRequest

required
accountLocator string
productName string
termEndTime datetime
termStartTime datetime
charges PreviewChargeRequest[]

optional
currency string?
durationBasis Enum? years | months | weeks | days | hours
timezone string?
installmentPreferences InstallmentPreferences?
invoiceFeeAmount number?

PreviewChargeRequest

required
amount number
chargeType string

optional
elementLocator string?
elementStaticLocator string?

InstallmentsPreview

required
accountLocator string
durationBasis Enum years | months | weeks | days | hours
settings Settings
installments Installment[]
queuedPolicyCharges ChargeQueueItem[]

optional
policyLocator string?
transactionLocator string?
quoteLocator string?

ChargeQueueItem

required
accountLocator string
chargeLocator string
currency string
amount number
chargeMetadata ChargeMetadata
chargeSource Enum billing | policy
chargeType string

optional
invoiceItemLocator string?

ChargeMetadata

optional
policyLocator string?
transactionLocator string?
elementStaticLocator string?
timezone string?

Settings

required
locator string
billingSettings BillingSettings
installmentSettings InstallmentSettings
createdAt datetime
createdBy uuid