m3ter API

naftiko: 1.0.0-alpha2
info:
  label: m3ter API
  description: 'If you are using Postman, you can: - Use the **Download** button above to download the m3ter Open API spec
    JSON file and then import this file as the **m3ter API Collection** into your Workspace. See [Importing the m3ter Open
    API](https://www.m3ter.com/docs/guides/m3ter-apis/getting-started-with-api-calls#importing-the-m3ter-open-api) in our
    main user Documentation for details. - Copy this link: [m3ter-Template API Collection](https://www.datocms-assets.com/78893/1672846767-m3ter-template-api-collection-postman_collection.json)
    and use it to import the **m3ter-Template API Collection** into yo'
  tags:
  - M3ter
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: m3ter
    baseUri: https://api.m3ter.com
    description: m3ter API HTTP API.
    authentication:
      type: bearer
      token: '{{M3TER_TOKEN}}'
    resources:
    - name: organizations-orgid-bills-billid-debitlineitems-
      path: /organizations/{orgId}/bills/{billId}/debitlineitems/{id}
      operations:
      - name: getdebitlineitem
        method: GET
        description: Retrieve Debit Line Item
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter
            service.
        - name: billId
          in: path
          type: string
          required: true
          description: UUID of the bill.
        - name: id
          in: path
          type: string
          required: true
          description: The UUID of the debit line item to retrieve.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putdebitlineitem
        method: PUT
        description: Update Debit Line Item
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter
            service.
        - name: billId
          in: path
          type: string
          required: true
          description: UUID of the bill.
        - name: id
          in: path
          type: string
          required: true
          description: The UUID of the debit line item to update.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletedebitlineitem
        method: DELETE
        description: Delete Debit Line Item
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter
            service.
        - name: billId
          in: path
          type: string
          required: true
          description: UUID of the bill.
        - name: id
          in: path
          type: string
          required: true
          description: UUID of the debit line item.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-latest-accountid
      path: /organizations/{orgId}/bills/latest/{accountId}
      operations:
      - name: getlatestbill
        method: GET
        description: Retrieve latest Bill
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: accountId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the Account for which the latest Bill should be retrieved.
        - name: additional
          in: query
          type: array
          description: Comma separated list of additional fields.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-billid-debitlineitems
      path: /organizations/{orgId}/bills/{billId}/debitlineitems
      operations:
      - name: listdebitlineitems
        method: GET
        description: List Debit Line Items
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter
            service.
        - name: billId
          in: path
          type: string
          required: true
          description: UUID of the bill.
        - name: pageSize
          in: query
          type: integer
          description: Number of line items to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: '`nextToken` for multi page retrievals.'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: postdebitlineitem
        method: POST
        description: Create Debit Line Item
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter
            service.
        - name: billId
          in: path
          type: string
          required: true
          description: UUID of the bill.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-id
      path: /organizations/{orgId}/bills/{id}
      operations:
      - name: getbill
        method: GET
        description: Retrieve Bill
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: id
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the Bill to retrieve.
        - name: additional
          in: query
          type: array
          description: Comma separated list of additional fields.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletebill
        method: DELETE
        description: Delete Bill
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: id
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the Bill to delete.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-balances-balanceid-balancech
      path: /organizations/{orgId}/balances/{balanceId}/balancechargeschedules/{id}
      operations:
      - name: getbalancechargeschedule
        method: GET
        description: Retrieve BalanceChargeSchedule
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization
        - name: balanceId
          in: path
          type: string
          required: true
          description: UUID of the balance
        - name: id
          in: path
          type: string
          required: true
          description: The UUID of the BalanceChargeSchedule to retrieve.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatebalancechargeschedule
        method: PUT
        description: Update BalanceChargeSchedule
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization
        - name: balanceId
          in: path
          type: string
          required: true
          description: UUID of the balance
        - name: id
          in: path
          type: string
          required: true
          description: The UUID of the BalanceChargeSchedule to update.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletebalancechargeschedule
        method: DELETE
        description: Delete BalanceChargeSchedule
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization
        - name: balanceId
          in: path
          type: string
          required: true
          description: UUID of the balance
        - name: id
          in: path
          type: string
          required: true
          description: The UUID of the BalanceChargeSchedule to update.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-balances-balanceid-balancetr
      path: /organizations/{orgId}/balances/{balanceId}/balancetransactionschedules
      operations:
      - name: listbalancetransactionschedule
        method: GET
        description: List BalanceTransactionSchedule
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization
        - name: balanceId
          in: path
          type: string
          required: true
          description: UUID of the balance
        - name: pageSize
          in: query
          type: integer
          description: Number of BalanceTransactionSchedules to retrieve per page
        - name: nextToken
          in: query
          type: string
          description: nextToken for multi page retrievals
        - name: ids
          in: query
          type: array
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createbalancetransactionschedule
        method: POST
        description: Create BalanceTransactionSchedule
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization
        - name: balanceId
          in: path
          type: string
          required: true
          description: UUID of the balance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-billid-creditlineitems
      path: /organizations/{orgId}/bills/{billId}/creditlineitems/{id}
      operations:
      - name: getcreditlineitem
        method: GET
        description: Retrieve Credit Line Item
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization. The Organization represents your company as a direct customer of the m3ter
            service.
        - name: billId
          in: path
          type: string
          required: true
          description: UUID of the Bill.
        - name: id
          in: path
          type: string
          required: true
          description: The UUID of the Credit line item to retrieve.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: putcreditlineitem
        method: PUT
        description: Update Credit Line Item
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization. The Organization represents your company as a direct customer of the m3ter
            service.
        - name: billId
          in: path
          type: string
          required: true
          description: UUID of the bill.
        - name: id
          in: path
          type: string
          required: true
          description: The UUID of the credit line item to update.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletecreditlineitem
        method: DELETE
        description: Delete Credit Line Item
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization. The Organization represents your company as a direct customer of the m3ter
            service.
        - name: billId
          in: path
          type: string
          required: true
          description: UUID of the bill.
        - name: id
          in: path
          type: string
          required: true
          description: UUID of the credit line item to delete.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-statementjobs-id-cancel
      path: /organizations/{orgId}/statementjobs/{id}/cancel
      operations:
      - name: cancelstatementjob
        method: POST
        description: Cancel StatementJob
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: id
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the StatementJob to cancel.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-balances-balanceid-balancetr
      path: /organizations/{orgId}/balances/{balanceId}/balancetransactionschedules/{id}
      operations:
      - name: getbalancetransactionschedule
        method: GET
        description: Retrieve BalanceTransactionSchedule
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization
        - name: balanceId
          in: path
          type: string
          required: true
          description: UUID of the balance
        - name: id
          in: path
          type: string
          required: true
          description: The UUID of the BalanceTransactionSchedule to retrieve.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatebalancetransactionschedule
        method: PUT
        description: Update BalanceTransactionSchedule
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization
        - name: balanceId
          in: path
          type: string
          required: true
          description: UUID of the balance
        - name: id
          in: path
          type: string
          required: true
          description: The UUID of the BalanceTransactionSchedule to update.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletebalancetransactionschedule
        method: DELETE
        description: Delete BalanceTransactionSchedule
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization
        - name: balanceId
          in: path
          type: string
          required: true
          description: UUID of the balance
        - name: id
          in: path
          type: string
          required: true
          description: The UUID of the BalanceTransactionSchedule to update.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-billconfig
      path: /organizations/{orgId}/billconfig
      operations:
      - name: getbillconfig
        method: GET
        description: Retrieve BillConfig
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization. The Organization represents your company as a direct customer of the m3ter
            service.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatebillconfig
        method: PUT
        description: Update BillConfig
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization. The Organization represents your company as a direct customer of the m3ter
            service.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills
      path: /organizations/{orgId}/bills
      operations:
      - name: listbills
        method: GET
        description: List Bills
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: pageSize
          in: query
          type: integer
          description: Specifies the maximum number of Bills to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of Bills in a paginated
            list.
        - name: accountId
          in: query
          type: string
          description: Optional filter. An Account ID - returns the Bills for the single specified Account.
        - name: locked
          in: query
          type: boolean
          description: Boolean flag specifying whether to include Bills with "locked" status. * **TRUE** - the list inlcudes
            "locked" Bills. * **FALSE** - excludes "locked" Bills from
        - name: excludeLineItems
          in: query
          type: boolean
          description: Exclude Line Items
        - name: includeBillTotal
          in: query
          type: boolean
          description: Include Bill Total
        - name: status
          in: query
          type: string
          description: Only include Bills having the given status
        - name: billDate
          in: query
          type: string
          description: The specific date in ISO 8601 format for which you want to retrieve Bills.
        - name: billDateStart
          in: query
          type: string
          description: Only include Bills with bill dates equal to or later than this date.
        - name: billDateEnd
          in: query
          type: string
          description: Only include Bills with bill dates earlier than this date.
        - name: externalInvoiceDateStart
          in: query
          type: string
          description: Only include Bills with external invoice dates equal to or later than this date.
        - name: externalInvoiceDateEnd
          in: query
          type: string
          description: Only include Bills with external invoice dates earlier than this date.
        - name: ids
          in: query
          type: array
          description: Optional filter. The list of Bill IDs to retrieve.
        - name: billJobId
          in: query
          type: string
          description: List Bill entities by the bill job that last calculated them.
        - name: additional
          in: query
          type: array
          description: Comma separated list of additional fields.
        - name: billingFrequency
          in: query
          type: string
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-id-status
      path: /organizations/{orgId}/bills/{id}/status
      operations:
      - name: updatebillstatus
        method: PUT
        description: Update Bill Status
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: id
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the Bill whose status you want to update.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-id-statement-json
      path: /organizations/{orgId}/bills/{id}/statement/json
      operations:
      - name: getbilljsonstatement
        method: GET
        description: Retrieve Bill Statement in JSON Format
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: id
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the Bill for which you want to retrieve the Statement.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-billid-lineitems
      path: /organizations/{orgId}/bills/{billId}/lineitems
      operations:
      - name: listbilllineitems
        method: GET
        description: List Line Items
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: billId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the Bill for which you want to list the line items.
        - name: pageSize
          in: query
          type: integer
          description: Specifies the maximum number of line items to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of line items in a paginated
            list.
        - name: additional
          in: query
          type: array
          description: Comma separated list of additional fields.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-balances-balanceid-transacti
      path: /organizations/{orgId}/balances/{balanceId}/transactions
      operations:
      - name: listbalancetransactions
        method: GET
        description: List Transactions
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) for your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: balanceId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) for the Balance whose Transactions you want to retrieve.
        - name: pageSize
          in: query
          type: integer
          description: The maximum number of transactions to return per page.
        - name: nextToken
          in: query
          type: string
          description: '`nextToken` for multi page retrievals. A token for retrieving the next page of transactions. You''ll
            get this from the response to your request.'
        - name: transactionTypeId
          in: query
          type: string
        - name: entityType
          in: query
          type: string
        - name: entityId
          in: query
          type: string
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: postbalancetransaction
        method: POST
        description: Create Balance Transaction
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) for your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: balanceId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) for the Balance to which you want to add a transaction.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-accountid-accountid
      path: /organizations/{orgId}/bills/accountid/{accountId}
      operations:
      - name: getallbillsforaccount
        method: GET
        description: Retrieve Bills for an Account ID
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: pageSize
          in: query
          type: integer
          description: Specifies the maximum number of Bills to retrieve per page.
        - name: nextToken
          in: query
          type: string
          description: The `nextToken` for multi-page retrievals. It is used to fetch the next page of Bills in a paginated
            list.
        - name: accountId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the Account for which you want to retrieve Bills.
        - name: additional
          in: query
          type: array
          description: Comma separated list of additional fields.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-balances-balanceid-balancetr
      path: /organizations/{orgId}/balances/{balanceId}/balancetransactionschedules/preview
      operations:
      - name: previewbalancetransactionschedule
        method: POST
        description: Preview ScheduledBalanceTransactions
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization
        - name: balanceId
          in: path
          type: string
          required: true
          description: UUID of the balance
        - name: pageSize
          in: query
          type: integer
          description: Number of BalanceTransactions to retrieve per page
        - name: nextToken
          in: query
          type: string
          description: nextToken for multi page retrievals
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-billid-lineitems-id
      path: /organizations/{orgId}/bills/{billId}/lineitems/{id}
      operations:
      - name: getbilllineitem
        method: GET
        description: Retrieve Line Item
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: billId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the Bill containing the line item.
        - name: id
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the line item you want to retrieve.
        - name: additional
          in: query
          type: array
          description: Comma separated list of additional fields.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-id-lock
      path: /organizations/{orgId}/bills/{id}/lock
      operations:
      - name: lockbill
        method: PUT
        description: Lock Bill
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: id
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of the Bill to lock.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-bills-billingperiod-lastdate
      path: /organizations/{orgId}/bills/billingperiod/{lastDateInBillingPeriod}/{billingFrequency}/approve
      operations:
      - name: approveallbillsinbillingperiod
        method: POST
        description: Approve Bills in Billing Period
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: The unique identifier (UUID) of your Organization. The Organization represents your company as a direct
            customer of our service.
        - name: lastDateInBillingPeriod
          in: path
          type: string
          required: true
          description: The last date of the billing period for which you want to approve Bills. This date defines the range
            of Bills to be approved.
        - name: billingFrequency
          in: path
          type: string
          required: true
          description: The billing frequency for the specified period. Valid options are daily, weekly, monthly, or annually.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-orgid-charges
      path: /organizations/{orgId}/charges
      operations:
      - name: listcharges
        method: GET
        description: List Charges
        inputParameters:
        - name: orgId
          in: path
          type: string
          required: true
          description: UUID of the organization
        - name: pageSize
          in: query
          type: integer
          description: Number of Charges to retrieve per page
        - name: nextToken
          in: query
          type: string
          description: nextToken for multi page retrievals
        - name: accountId
          in: query
          type: string
          description: List Charge items for the Account UUID
        - name: entityType
          in: query
          type: string
          description: List Charge items for the EntityType
        - name: entityId
          in: query
          type: string
          description: List Charge items for the Entity UUID
        - name: billDate
          in: query
          type: string
          description: List Charge items for the Bill Date
        - name: ids
          in: query
          type: array
          description: List of Charge UUIDs 

# --- truncated at 32 KB (129 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/m3ter/refs/heads/main/capabilities/m3ter-capability.yaml