# Billing accounts API

> Billing accounts, invoices, subscriptions and transactions for a tenant.

Billing accounts, invoices, subscriptions and transactions for a tenant.

Base URL: `https://mpp-api-mybusinessapp-san.azure-api.net/v2`

API version: `3.55.133`

## Endpoints

### GET /billing/accounts

List billing accounts

Returns the billing accounts for the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`; supports sorting and filtering. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a billing account`, `List invoices`, `List subscriptions`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `page` (query), optional — Page number for paginated results
- `limit` (query), optional — Number of accounts per page
- `paginate` (query), optional — Whether to paginate results; false returns all matched rows
- `sort` (query), optional — Field name to sort by
- `order` (query), optional — Sort direction
- `search` (query), optional — Search text for account records
- `ids` (query), optional — Comma-separated billing account IDs to include
- `userId` (query), optional — Filter by the account user ID
- `state` (query), optional — Filter by account state
- `subscriptionStatus` (query), optional — Filter by subscription status
- `fromDate` (query), optional — UTC date string lower bound for created-at filtering
- `toDate` (query), optional — UTC date string upper bound for created-at filtering

Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllAccounts

### GET /billing/accounts/{id}

Retrieve a billing account by id

Returns the billing account with the given `id` for the tenant identified by the API key. Returns 404 if not found in this tenant. Related: `List billing accounts`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `id` (path), required — ID of the account resource

Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleAccount

### GET /billing/accounts/{id}/invoices

List invoices for a billing account

Returns the invoices for one billing account (`id` in the path), scoped to the tenant identified by the API key. Paginated: use `page`/`limit` or `paginate=false`. Related: `Retrieve a billing account`, `List invoices`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `id` (path), required — ID of the billing account
- `page` (query), optional — Page number for paginated results
- `limit` (query), optional — Number of invoices per page
- `paginate` (query), optional — Whether to paginate results; false returns all matched rows
- `sort` (query), optional — Field name to sort by
- `order` (query), optional — Sort direction
- `search` (query), optional — Search text for invoice records
- `type` (query), optional — Filter by invoice type
- `state` (query), optional — Filter by invoice state
- `collectionMethod` (query), optional — Filter by collection method
- `currency` (query), optional — Filter by invoice currency code
- `origin` (query), optional — Filter by invoice origin
- `hasSubscription` (query), optional — Filter to invoices linked to a subscription (true) or not (false)
- `ids` (query), optional — Comma-separated invoice IDs to include
- `bookingIds` (query), optional — Comma-separated booking IDs to include
- `subscriptionIds` (query), optional — Comma-separated subscription IDs to include
- `fromDate` (query), optional — UTC date string lower bound for created-at filtering
- `toDate` (query), optional — UTC date string upper bound for created-at filtering

Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllAccountInvoices

### GET /billing/invoices

List invoices

Returns the invoices across the tenant's billing accounts. Paginated: use `page`/`limit` or `paginate=false`. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve an invoice by id`, `Retrieve an invoice by number`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `page` (query), optional — Page number for paginated results
- `limit` (query), optional — Number of invoices per page
- `paginate` (query), optional — Whether to paginate results; false returns all matched rows
- `sort` (query), optional — Field name to sort by
- `order` (query), optional — Sort direction
- `search` (query), optional — Search text for invoice records
- `ids` (query), optional — Comma-separated invoice IDs to include
- `bookingIds` (query), optional — Comma-separated booking IDs to include
- `subscriptionIds` (query), optional — Comma-separated subscription IDs to include
- `type` (query), optional — Filter by invoice type
- `state` (query), optional — Filter by invoice state
- `collectionMethod` (query), optional — Filter by collection method
- `currency` (query), optional — Filter by invoice currency code
- `origin` (query), optional — Filter by invoice origin
- `hasSubscription` (query), optional — Filter to invoices linked to a subscription (true) or not (false)
- `fromDate` (query), optional — UTC date string lower bound for created-at filtering
- `toDate` (query), optional — UTC date string upper bound for created-at filtering

Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllInvoices

### GET /billing/invoices/number/{invoiceNumber}

Retrieve an invoice by number

Returns the invoice with the given `invoiceNumber`. Invoice numbers are unique per tenant. Related: `Retrieve an invoice by id`, `List invoices`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `invoiceNumber` (path), required — Number of the account invoice resource

Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleAccountInvoiceByNumber

### GET /billing/invoices/{invoiceId}

Retrieve an invoice by id

Returns the invoice with the given `invoiceId` for the tenant identified by the API key. Related: `List invoices`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `invoiceId` (path), required — ID of the invoice resource

Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleInvoice

### GET /billing/subscriptions

List subscriptions

Returns the subscriptions across the tenant's billing accounts. Paginated: use `page`/`limit` or `paginate=false`; supports sorting and state/plan filters. To count without fetching rows, request `limit=1` and read `metadata.total`. Related: `Retrieve a subscription`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `page` (query), optional — Page number for paginated results
- `limit` (query), optional — Number of subscriptions per page
- `paginate` (query), optional — Whether to paginate results; false returns all matched rows
- `sort` (query), optional — Field name to sort by
- `order` (query), optional — Sort direction
- `search` (query), optional — Free-text search across subscription records
- `ids` (query), optional — Comma-separated subscription IDs to include
- `state` (query), optional — Filter by subscription state
- `planId` (query), optional — Filter by billing plan ID
- `fromDate` (query), optional — UTC date string lower bound for created-at filtering
- `toDate` (query), optional — UTC date string upper bound for created-at filtering

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

### GET /billing/subscriptions/{subscriptionId}

Retrieve a subscription by id

Returns the subscription with the given `subscriptionId` for the tenant identified by the API key. Related: `List subscriptions`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `subscriptionId` (path), required — ID of the subscription resource

Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getSingleSubscription

### GET /billing/transactions

List transactions

Returns the billing transactions across the tenant's accounts. Paginated: use `page`/`limit` or `paginate=false`; supports status and date filters. To count without fetching rows, request `limit=1` and read `metadata.total`.

Parameters:

- `Ocp-Apim-Subscription-Key` (header), required — Azure API Management subscription key (public: 4fb0f9a3b14a44e98698e80cef2aebeb)
- `X-MBA-Application-ID` (header), optional — Optional. Target another application's stamp; only a Studio key may target a different tenant
- `X-MBA-Application-Type` (header), optional — Optional. Application type paired with X-MBA-Application-ID
- `page` (query), optional — Page number for paginated results
- `limit` (query), optional — Number of transactions per page
- `paginate` (query), optional — Whether to paginate results; false returns all matched rows
- `sort` (query), optional — Field name to sort by
- `order` (query), optional — Sort direction
- `ids` (query), optional — Comma-separated account transaction IDs to include
- `status` (query), optional — Filter by transaction status
- `fromDate` (query), optional — UTC date string lower bound for created-at filtering
- `toDate` (query), optional — UTC date string upper bound for created-at filtering

Reference: https://mybusinessapp.co.za/developers/api/billing-account#tag/BillingAccount/getAllTransactions

---

[Rendered page](https://mybusinessapp.co.za/developers/api/billing-account)

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