Skip to content

Commit

Permalink
docs: tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Kikobeats committed May 12, 2024
1 parent a2e12e1 commit 020b6b8
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -89,6 +88,14 @@ Any other field provided will be omitted.
- `createdAt`<span class="type">number</span>: The timestamp when the object was created.
- `updatedAt`<span class="type">number</span>: 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:
Expand Down

0 comments on commit 020b6b8

Please sign in to comment.