Livedocs/api-reference/plans
Plans
Read document plans and subscription options configured for the deployment.
Plans
The plans endpoint lets the UI show one-off and subscription options without hard-coding product configuration.
GET
/api/v1/documents/plans/List available document plans and subscription options.
Status
Live
Auth
Public
Credit cost
0
Request
No request body.
Request body
No request body.Response
Returns one-off and subscription plan data available to the current deployment.
Response body
{
"plans": [
{
"id": "pay-per-doc",
"name": "Pay per document",
"document_types": ["AD", "CD"],
"currency": "EUR"
}
]
}Code examples
cURL
curl https://openregis.com/api/v1/documents/plans/Fehler
| Code | Meaning | Client action |
|---|---|---|
| plan_configuration_missing | No public plan exists. | Treat the environment as not launch-ready. |