This is the interim reference for the Recurly Recover Recovery API. It lists the base URL, authentication, and the available endpoints. Full field-level request and response schemas will live in a dedicated API reference section in ReadMe.

1Base URL & auth 2Endpoints 3Request & response

Note This is a temporary reference page. A full, interactive API reference for Recover is coming to ReadMe and will replace it.

Base URL and authentication

All Recovery API requests go to the Recurly API v3 base URL:

https://v3.recurly.com

Recover authenticates with HTTP Basic Auth — pass your API key as the username with an empty password:

curl -u YOUR_RECOVER_API_KEY: https://v3.recurly.com/invoices/recovery

Endpoints

Method	Endpoint	Purpose
`POST`	`/invoices/recovery`	Submit a failed invoice for collection
`PUT`	`/invoices/{invoice_id}/mark_successful`	Stop retries — mark the invoice paid
`PUT`	`/invoices/{invoice_id}/mark_failed`	Stop retries — abandon collection

Request and response

Until the full schema lands here, the Submit invoices via the Recovery API guide carries the complete example bodies:

Request body — the full POST /invoices/recovery payload
Response — the 201 response with the returned charge_invoice