Forum Discussion

mhofrichter's avatar
mhofrichter
New Contributor
1 month ago

Documenting Paid vs. Free Endpoints

Hi All,

We've got a wide variety of endpoints and actions that we have in our documentation. Some of the Actions are included with the base subscription and some are paid. Is there a convention or easy method to display that? I could use Tags, but we're using them elsewhere to indicate what feature set this belongs with (Users, Organizations, etc.). 

We've got it set up now that the GET actions are always free but some of the POST or PATCH actions are in the paid tier. 

Thanks,

Michael

1 Reply

  • mhofrichter's avatar
    mhofrichter
    New Contributor
    11 hours ago

    For posterity, I solved this by adding an `included` and a `premium` tag to each endpoint. Then I created a github action that makes a copy of my documentation and removes all the endpoints with a `premium` tag. I then end up with two files for the API documentation - one of all the endpoints (premium and included) and one of just the included/free endpoints.