PackageSendImpactTypeDto
Properties
| Name |
Type |
Description |
Notes |
| type |
String |
Credit type string ("SMS", "KBA", "IDV"). |
[default to null] |
| neededForPackage |
Integer |
How many credits of this type will be consumed on send. |
[default to null] |
| freeQuotaAvailable |
Integer |
Free monthly quota remaining at preview time. |
[default to null] |
| prepaidAvailable |
Integer |
Prepaid balance at preview time. |
[default to null] |
| shortfall |
Integer |
Credits needed after free + prepaid are applied (zero if covered). |
[default to null] |
| autoRefillConfigured |
Boolean |
True if the tenant has auto-refill enabled for this type. |
[default to null] |
| autoRefillPacks |
Integer |
Packs the upcoming send will buy (0 if no shortfall or no auto-refill). |
[default to null] |
| autoRefillCost |
Double |
Dollar cost of the projected auto-refill. |
[default to null] |
| refillLargerThanUsual |
Boolean |
True when the projected refill is more than 1.5x the tenant's configured RefillPacks. UI should warn about this specifically so tenants aren't surprised by a big auto-refill charge on unusually-large packages. |
[default to null] |
[Back to Model list] [Back to API list] [Back to README]