Skip to content

Commit

Permalink
Add API docs for feature support
Browse files Browse the repository at this point in the history
that-guy-iain committed Dec 2, 2023
1 parent 8d43af8 commit 9c339ab
Showing 3 changed files with 125 additions and 1 deletion.
32 changes: 31 additions & 1 deletion docs/technical/api/index.md
Original file line number Diff line number Diff line change
@@ -14,4 +14,34 @@ To manage the API keys BillaBear provides the following UI functionalities in th

## API Docs

You can find the REST api docs at https://swagger.billabear.com
You can find the REST api docs at https://swagger.billabear.com

## Feature Support


### Subscriptions

| Feature | REST API | Stripe Interopt |
| --- | ---- | --- |
| Create Subscription | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/cross.svg" alt="Cross" width="25"/> |
| List Subscriptions | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/tick.svg" alt="Cross" width="25"/> |
| List Customer Subscriptions | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/tick.svg" alt="Cross" width="25"/> |
| View Subscription | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/cross.svg" alt="Cross" width="25"/> |
| Cancel Subscription | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/tick.svg" alt="Cross" width="25"/> |
| List Customer Subscriptions | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/tick.svg" alt="Cross" width="25"/> |
| Change Subscription Plan | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/tick.svg" alt="Cross" width="25"/> |
| Add Seat to Per Seat Subscription | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/tick.svg" alt="Cross" width="25"/> |
| Remove seat to Per Seat Subscription | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/tick.svg" alt="Cross" width="25"/> |
| Update Payment Method for subscription | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/tick.svg" alt="Cross" width="25"/> |

### Customers

| Feature | REST API | Stripe Interopt |
| --- | ---- | --- |
| Create Customer | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/cross.svg" alt="Cross" width="25"/> |
| Disable Customer | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/cross.svg" alt="Cross" width="25"/> |
| Enable Customer | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/cross.svg" alt="Cross" width="25"/> |
| Customer Limit List | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/cross.svg" alt="Cross" width="25"/> |
| List Customers | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/cross.svg" alt="Cross" width="25"/> |
| Read Customer | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/cross.svg" alt="Cross" width="25"/> |
| Update Customer | <img src="/img/tick.svg" alt="Tick" width="25"/> | <img src="/img/cross.svg" alt="Cross" width="25"/> |
92 changes: 92 additions & 0 deletions static/img/cross.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions static/img/tick.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9c339ab

Please sign in to comment.