Installments API

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
Update Installments	PATCH/billing/{tenantLocator}/installments

Fetch Installments for a Quote

Fetch Installments for a QuotefetchInstallmentsForQuote

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`quoteLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:InstallmentListResponse

Security Group:installments

Permissions:

read,list

Fetch Installments for a Policy

Fetch Installments for a PolicyfetchInstallmentsForPolicy

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:InstallmentListResponse

Security Group:installments

Permissions:

read,list

Fetch Installments for a Policy Transaction

Fetch Installments for a Policy TransactionfetchInstallmentsForPolicyTransaction

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`transactionLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:InstallmentListResponse

Security Group:installments

Permissions:

read,list

InstallmentListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`Installment[]`

Installment

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`installmentLatticeLocator`	`ulid`
`dueTime`	`datetime`
`generateTime`	`datetime`
`currency`	`string`
`timezone`	`string`
`coverageDuration`	`number`
`coverageEndTime`	`datetime`
`coverageStartTime`	`datetime`
`installmentDuration`	`number`
`installmentEndTime`	`datetime`
`installmentFrameIndex`	`integer`
`installmentStartTime`	`datetime`
`updatedAt`	`datetime`
`updatedBy`	`uuid`
`createdAt`	`datetime`
`createdBy`	`uuid`
`installmentItems`	`InstallmentItem[]`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`termLocator`	`ulid?`
`transactionLocator`	`ulid?`
`invoiceLocator`	`ulid?`
`migratedFromInstallmentLocator`	`ulid?`
`quoteLocator`	`ulid?`
`reversalOfInstallmentLocator`	`ulid?`
`autopayTime`	`datetime?`
`enhancedByPlugin`	`boolean?`

InstallmentItem

Required properties

Property	Type	Description
`locator`	`ulid`
`chargeLocator`	`ulid`
`elementLocator`	`ulid`
`elementStaticLocator`	`ulid`
`installmentLocator`	`ulid`
`amount`	`number`
`chargeCategory`	`string`
`chargeType`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`invoiceItemLocator`	`ulid?`
`reversalOfInstallmentItemLocator`	`ulid?`

Preview Installments for a Stateless Quote

Preview Installments for a Stateless QuotepreviewInstallmentsForStatelessQuote

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`quotePreviewRequest`	query	`QuoteBillingPreviewRequest`	Yes

Response:InstallmentsPreview

Security Group:installments

Permission:

read

QuoteBillingPreviewRequest

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`productName`	`string`
`termEndTime`	`datetime`
`termStartTime`	`datetime`
`charges`	`PreviewChargeRequest[]`

Optional properties

Property	Type	Description
`currency`	`string?`
`durationBasis`	`Enum? years \| months \| weeks \| days \| hours`
`timezone`	`string?`
`installmentPreferences`	`InstallmentPreferences?`
`invoiceFeeAmount`	`number?`

PreviewChargeRequest

Required properties

Property	Type	Description
`amount`	`number`
`chargeType`	`string`

Optional properties

Property	Type	Description
`elementLocator`	`ulid?`
`elementStaticLocator`	`ulid?`

InstallmentsPreview

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`durationBasis`	`Enum years \| months \| weeks \| days \| hours`
`settings`	`Settings`
`installments`	`Installment[]`
`persistedInstallmentLocators`	`ulid[]`
`queuedPolicyCharges`	`ChargeQueueItem[]`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`transactionLocator`	`ulid?`
`quoteLocator`	`ulid?`

ChargeQueueItem

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`chargeLocator`	`ulid`
`currency`	`string`
`amount`	`number`
`chargeMetadata`	`ChargeMetadata`
`chargeSource`	`Enum billing \| policy`
`chargeType`	`string`

Optional properties

Property	Type	Description
`invoiceItemLocator`	`ulid?`

ChargeMetadata

Properties

Property	Type	Description
`policyLocator`	`ulid?`
`transactionLocator`	`ulid?`
`elementStaticLocator`	`ulid?`
`timezone`	`string?`
`invoicing`	`Enum? scheduled \| next \| immediate`

Settings

Required properties

Property	Type	Description
`locator`	`ulid`
`installmentSettings`	`InstallmentSettings`
`createdAt`	`datetime`
`createdBy`	`uuid`

Update Installments

Update InstallmentsupdateInstallments

PATCH/billing/{tenantLocator}/installments

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:PatchInstallmentsRequest

Response:Installment[]

Security Group:installments

Permission:

write

PatchInstallmentsRequest

Required properties

Property	Type	Description
`installmentLocators`	`ulid[]`

Optional properties

Property	Type	Description
`dueTime`	`datetime?`
`generateTime`	`datetime?`
`autopayTime`	`datetime?`

Installments API

Fetch Installments for a Quote

Fetch Installments for a Policy

Fetch Installments for a Policy Transaction

Preview Installments for a Stateless Quote

Update Installments

On this page