From 020b6b84c91f513de2f411bfe3b957935c7099b0 Mon Sep 17 00:00:00 2001 From: Kiko Beats Date: Sun, 12 May 2024 20:34:27 +0200 Subject: [PATCH] docs: tweaks --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fb1a735..a309993 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,6 @@ It creates & returns a plan: ```js const plan = await openkey.plans.create({ name: 'free tier', - description: 'this is optional', metadata: { tier: 'free' }, limit: 3000, period: '1d' @@ -89,6 +88,14 @@ Any other field provided will be omitted. - `createdAt`number: The timestamp when the object was created. - `updatedAt`number: The last timestamp when the object was modified. +### .list + +It retrieves all the plans: + +```js +const plans = await openkey.plans.list() +``` + ### .retrieve It retrieves a plan by id: