API METHODS
SECTIONS
| Description | Endpoint | Notes |
|---|---|---|
| Find All Subscriptions | GET /api/admin/subscriptions |
|
| Filter By User or Status | GET /api/admin/(users/{user_id})/subscriptions/(filter/{filter}) |
Filter can be one of active or inactive. |
GET /api/admin/subscription/{id}
PATCH /api/admin/subscriptions/:id
Use this to upgrade or downgrade an existing service.
Will return a HTTP 200 if was successful, otherwise you will have a HTTP 40x code and a {"errors": []} response.
SCHEMA
container_service: Object
product_id: The new product idqty: The total amount of containers you want. For example, if you have 1 container and you want 2, you would set this value to 2.Example: Upgrade a product
Example: Scale a service up or down
For integrations that rely on the subscription as their internal reference, we offer a helper api endpoint to suspend a user via their subscription.