API METHODS

MAPI71: Usage

SECTIONS

List Subscriptions

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.

View Subscription

GET /api/admin/subscription/{id}

Update Subscription

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

Suspension

For integrations that rely on the subscription as their internal reference, we offer a helper api endpoint to suspend a user via their subscription.