BillingNoticeKind
What a billing notice is about.
Kind: a string enum, used in responses.
Values
Section titled “Values”| Value | Description |
|---|---|
"OutOfCredit" | The tenant is out of credit: nothing new starts, and what was running is stopped, until it tops up or upgrades. |
"CreditRestored" | The tenant has credit again after being out of it: work can start again. |
"AllowanceUsed" | On a plan without top-ups, one allowance is used up for the billing period (see meter). |
"LowBalance" | The balance fell below the tenant’s low-balance alert. |
"PaymentFailed" | A renewal payment failed: the tenant is on Free now, and its data is kept as it is until frozenUntilUtc. Paying the renewal before then puts it back on previousTier. |
"FreezeReminder" | A reminder, 7, 21 and 28 days after a failed renewal payment, that it is still unpaid (see frozenUntilUtc). |
"FreezeEnded" | The time to pay a failed renewal ran out: the subscription is cancelled, and Free’s limits apply in full. |
"PlanRestored" | A failed renewal was paid: the tenant is back on tier. |
"PlanChanged" | The plan changed: a subscription started, an upgrade, or a change booked for the renewal took effect (see tier). |
"MovedToFree" | The subscription ended (cancelled, or its payments gave up): the tenant is on Free. |
"AutoTopUpFailed" | An automatic top-up couldn’t be charged, so automatic top-ups are off until the card or the settings are saved again. |
New values can appear, so treat one you don’t know as “something else”, not as an error.
Where it’s used
Section titled “Where it’s used”- Inside
BillingNotice
