Skip to main content

PaymentRequiredError

error object
messagestring
Example: The last payment failed. Update your payment method to avoid interruption.
typestring
Example: payment_required
reasonstring

Why access was blocked.

Possible values: [trial_ended, past_due, unpaid, canceled, incomplete, paused, license_expired, message_limit, capacity_exceeded, no_subscription]

billable_numbersinteger

The account’s billable numbers at the moment of the refusal.

action object

The way out of the block: what to do and the dashboard page where it is done. Every 402 carries it.

kindstring

Possible values: [subscribe, update_payment_method, pay_invoices, finish_checkout, resume_subscription, renew_license, upgrade_plan, manage_numbers]

urlstring<uri>
Example: https://app.joinotify.com/billing
PaymentRequiredError
{
"error": {
"message": "The last payment failed. Update your payment method to avoid interruption.",
"type": "payment_required",
"reason": "trial_ended",
"billable_numbers": 0,
"action": {
"kind": "subscribe",
"url": "https://app.joinotify.com/billing"
}
}
}