What this credential may call

What this credential is allowed to do with this newsletter, and what it would be told if it tried something it is not. Needs settings: read.

Two things in this API can be put behind a plan, and both answer 402 when they are: writing, every operation that changes something, and insights, the engagement and metrics operations, whose numbers are computed rather than looked up. Every other read is free on every plan.

Read this at the start of a run rather than discovering a 402 in the middle of one. Each entry in api_access carries the plan list the refusal would put in allowed_values and the sentence it would put in message.

granted is the field to branch on: true when the call would be allowed at this moment. included is the longer view, whether the newsletter's plan carries the feature at all, and the two differ only while Commune is not charging for it. Read included to warn a creator before a bill starts; read granted to decide whether to make the next call.

Never itself refused for payment, so it declares no 402.