Invoice Errors
The following error codes and messages appear in REST responses when an error prevents completion of the request.
Error Code | Description |
|---|---|
ERROR_DELETE_INVOICE | The request tried to delete an invoice, but the operation failed. Corrective action: Check all input fields, and verify that the invoice exists and was not already deleted. |
ERROR_DELETE_NOT_DRAFT_INVOICE | The request tried to delete an invoice, but the invoice is not in 'draft' status. Only a draft invoice can be deleted. The request was rejected. Corrective action: None. Determine why an attempt was made to delete an invoice that is not in ‘draft’ status. |
ERROR_GET_INVOICE | The request tried to retrieve an invoice, but the invoice was not found. The request was rejected. Corrective action: Use a valid invoice ID. |
ERROR_MARK_UNCOLLECTIBLE_NOT_OPEN_INVOICE | The request tried to mark an invoice as uncollectible, but the invoice status was not 'open'. The request was rejected. Corrective action: None. Determine why the invoice was not in 'open' status. |
ERROR_PAY_INVOICE | The request tried to pay an invoice, but the invoice was not found. The request was rejected. Corrective action: Use the ID of a valid invoice. |
ERROR_PAY_INVOICE_PAYMENT | The request attempted to pay invoice, but the invoice type is not payment. The request was rejected. |
ERROR_PAY_INVOICE_PAYMENT_PENDING | The request tried to pay an invoice, but there is already an active payment associated with it. The request was rejected. Corrective action: Cancel the active payment. |
ERROR_UPDATE_NOT_DRAFT_INVOICE | The request tried to a update an invoice but the invoice is not draft. Can only update draft invoice. The request was rejected. |
ERROR_UPDATE_PAYOUT_INVOICE | The request tried to update an invoice, but the invoice was not a payment invoice. The request was rejected. Corrective action: Set 'type' to 'payment'. |
ERROR_VOID_NOT_UNCOLLECTIBLE_OR_OPEN_INVOICE | The request tried to a void an invoice but the invoice is draft or paid. Can only void open or uncollectible invoice. The request was rejected. |
ERROR_VOID_PAYOUT_INVOICE | The request tried to set status 'void' to an invoice but the invoice type is 'payout'. Can only set status 'void' 'payment' invoice. The request was rejected. |
INVALID_DAYS_UNTIL_DUE_AND_BILLING | "The request tried to update an invoice, but the 'billing' body parameter was set to 'pay_automatically', and 'days_until_due' field was set. 'days_until_due' is relevant only when 'billing' is set to 'send_invoice'. The request was rejected. Corrective action: Set 'billing' to 'send_invoice', or set 'days_until_due' to null. |
INVALID_DUE_DATE | The request tried to set or update the due date of an invoice, but the value was not valid. The request was rejected. Corrective action: Set the 'due_date' body parameter to a valid Unix timestamp in the future. |
INVALID_INVOICE_CURRENCY | The request tried to add an invoice item to an invoice, but the currency specified in the request was not the same as the currency defined for other existing items in the invoice. The request was rejected. Corrective action: Use the same currency for all invoice items in the invoice. |
INVALID_INVOICE_CUSTOMER | The request attempted an operation that requires a customer, but the customer specified in the request was not the same as the customer defined for the subscription. The request was rejected. Corrective action: For the invoice and all of its invoice items, use the customer identified in the subscription. |
INVALID_INVOICE_ID | The request attempted an operation that requires an invoice, but the invoice was not found. The request was rejected. Corrective action: Use the ID of a valid invoice. |
INVALID_INVOICE_ID_AND_SUBSCRIPTION_ID | The request tried to create an invoice item, but the request attempted to link it to both a subscription and an invoice. The request was rejected. Corrective action: Link the invoice item to an invoice or to a subscription, but not both. |
INVALID_SUBSCRIPTION_TRIAL_END | The request tried to retrieve the upcoming invoice for a customer, but the 'trial_end' body parameter was set in the subscription and there were no invoice items in the 'lines' array. The request was rejected. Corrective action: Add valid items to the 'lines' array in the subscription or the invoice. |