A valid request URL is required to generate request examples{
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"enforcement": "required",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"summary": "<string>",
"effective_at": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z"
}
],
"max_age_seconds": 123,
"generated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}The published terms
What is in force in one environment, right now — public, cacheable, addressed by the publishable key that already sits in your page.
It has to be public: a sign-up form renders the link to the terms before there is any session, and a form that cannot draw that link is a form that must not legally take a sign-up. Everything here is public by your own act anyway, since publishing is making the words readable.
No bodies. This is the list a form or a footer builds its links from; one document’s text is GET /v1/legal/{publishable_key}/{slug}.
Drafts are absent, archived documents are absent, and a version published with a future effective_at is absent until that date — the version before it is what answers meanwhile, which is the whole point of announcing terms ahead of time.
Cache-Control carries stale-if-error beside stale-while-revalidate, so a cache in front of this keeps answering while we are having a bad minute. max_age_seconds restates the window in the body, because a client has to decide what to do with a document it could not refresh.
A valid request URL is required to generate request examples{
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"enforcement": "required",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"summary": "<string>",
"effective_at": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z"
}
],
"max_age_seconds": 123,
"generated_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}