# mba-cli subscription

> Read subscriptions

Read subscriptions

CLI version: `0.3.2`

## Commands

### mba-cli subscription get

Get one subscription by id

Get single subscription resource

Get a single subscription resource

Get one subscription by id

Flags:

- `--id` (string): Subscription id

API endpoints:

- GET /billing/subscriptions/{subscriptionId} — https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleSubscription

### mba-cli subscription ls

List subscriptions

List subscriptions across billing accounts

Retrieves subscriptions across billing accounts with optional pagination, sorting, search, subscription ID CSV filters, state, plan ID, and created-date ranges. Studio Copilot should pass page, filters, and sort controls in mpptenant_call_api.query.

List subscriptions

Flags:

- `--all` (bool, default `false`): Return all rows (paginate=false)
- `--from-date` (string): Query parameter fromDate (from the API spec)
- `--ids` (string): Query parameter ids (from the API spec)
- `--limit` (int, default `20`): Query parameter limit (from the API spec)
- `--order` (string): Query parameter order (from the API spec)
- `--page` (int, default `1`): Query parameter page (from the API spec)
- `--paginate` (bool, default `true`): Query parameter paginate (from the API spec)
- `--plan-id` (string): Query parameter planId (from the API spec)
- `--search` (string): Query parameter search (from the API spec)
- `--sort` (string): Query parameter sort (from the API spec)
- `--state` (string): Query parameter state (from the API spec)
- `--to-date` (string): Query parameter toDate (from the API spec)

API endpoints:

- GET /billing/subscriptions — https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllSubscriptions

---

[Rendered page](https://mybusinessapp.co.za/developers/cli/reference/subscription)

© MyBusinessApp (Pty) Ltd. Proprietary documentation — do not republish.