MonetizeNow Account Overview API

The Account Overview API from MonetizeNow — 2 operation(s) for account overview.

Operations 2

GET /api/accounts/{accountId}/overview Get account overview by account #
GET /api/v2/accounts/{accountId}/subscriptions/overview Get subscriptions overview by account V2 #

Documentation

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/monetizenow-account-overview-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

monetizenow-account-overview-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: OpenAPI definition Account Overview API
  version: v0
  description: '# About MonetizeNow


    MonetizeNow provides a Quoting, Billing, and Usage platform built for the B2B SaaS enterprise.'
servers:
- url: https://api.monetizeplatform.com
tags:
- name: Account Overview
paths:
  /api/accounts/{accountId}/overview:
    get:
      tags:
      - Account Overview
      summary: Get account overview by account
      description: Account overview with billgroup and subscriptions
      operationId: accountOverview
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          example: acct_jgPH8G33rELY6LQa
        example: acct_jgPH8G33rELY6LQa
      - name: currency
        in: query
        required: false
        schema:
          type: string
          example: USD
        example: USD
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      responses:
        '200':
          description: Get Account Overview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.customer.dto.account.overview.AccountOverview'
        '404':
          description: Resource not found by Id
        '500':
          description: Internal server error. Please contact the support team.
  /api/v2/accounts/{accountId}/subscriptions/overview:
    get:
      tags:
      - Account Overview
      operationId: getSubscriptionsOverviewByAccountV2
      parameters:
      - name: accountId
        in: path
        required: true
        schema:
          type: string
          example: acct_jgPH8G33rELY6LQa
        example: acct_jgPH8G33rELY6LQa
      - name: x-api-key
        in: header
        description: x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client
        required: true
        schema:
          type: string
          example: TYQ1YzM3NWItZjQzMi00NDYwLTlmOWYtN2UwNzI5YzM2ZmV0
      responses:
        '200':
          description: Get Account's Subscriptions Overview v2
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com.monytyz.billing.customer.dto.account.overview.BillGroupListWithSubscriptionOverviews'
        '404':
          description: Resource not found by Id
        '500':
          description: Internal server error. Please contact the support team.
      summary: Get subscriptions overview by account V2
      x-summary-source: derived
components:
  schemas:
    com.monytyz.billing.payment.dto.paymentgateway.AmountConfiguration:
      required:
      - currency
      type: object
      properties:
        currency:
          type: string
          description: Currency to which the amount configuration applies
          example: USD
          enum:
          - AUD
          - BYN
          - CAD
          - CNY
          - DKK
          - EUR
          - GBP
          - INR
          - ISK
          - MYR
          - NOK
          - SEK
          - SGD
          - TWD
          - USD
        minimum:
          type: number
          description: Minimum payment amount allowed for payment type and currency
          example: 25
        maximum:
          type: number
          description: Maximum payment amount allowed for payment type and currency
          example: 500
      description: Minimum and maximum amounts for payment type per currency
    com.monytyz.billing.customer.dto.account.AccountSummary:
      required:
      - accountType
      - id
      - isTestAccount
      - status
      type: object
      properties:
        id:
          type: string
        customId:
          type: string
        isTestAccount:
          type: boolean
        locale:
          type: string
        accountName:
          type: string
        defaultCurrency:
          type: string
          enum:
          - AUD
          - BYN
          - CAD
          - CNY
          - DKK
          - EUR
          - GBP
          - INR
          - ISK
          - MYR
          - NOK
          - SEK
          - SGD
          - TWD
          - USD
        status:
          type: string
          enum:
          - ACTIVE
          - CANCELED
          - SUSPENDED
          - INACTIVE
        accountType:
          type: string
          enum:
          - CUSTOMER
          - PARTNER
        defaultLegalEntityId:
          type: string
    com.monytyz.billing.customer.dto.account.overview.AccountSubscriptionOverviewDto:
      type: object
      properties:
        id:
          type: string
          example: acct_jgPH8G33rELY6LQa
        name:
          type: string
          example: Sales Account
        totalProducts:
          type: integer
          format: int32
          example: 100
        renewalEstimate:
          type: number
          example: 10000
    com.monytyz.billing.dunning.dto.dunningprocess.DunningProcessDetailDto:
      type: object
      properties:
        createdBy:
          type: string
          description: Identifier for the user who created the record
          example: usr_X0XZ05bvkrB1RpLS
        createDate:
          type: string
          description: Timestamp of when the record was created
          format: date-time
        lastModifiedBy:
          type: string
          description: Identifier for the user who last modified the record
          example: usr_X0XZ05bvkrB1RpLS
        modifyDate:
          type: string
          description: Timestamp of when the record was last modified
          format: date-time
        id:
          type: string
          example: dunpr_H4b4ap97J2EqfuvX
        name:
          type: string
          example: Quote Dunning Process
        totalDunningStep:
          type: integer
          format: int32
          example: 10
        dunningProcessDays:
          type: integer
          format: int32
          example: 10
        dunningSteps:
          type: array
          items:
            $ref: '#/components/schemas/com.monytyz.billing.dunning.dto.dunningstep.DunningStepDto'
        defaultProcess:
          type: boolean
    com.monytyz.billing.payment.dto.paymentmethod.PaymentMethodSupport:
      required:
      - enabled
      - method
      type: object
      properties:
        method:
          type: string
          description: Payment method type like CREDIT_CARD, DIRECT_DEBIT, ACH_CREDIT etc
          example: DIRECT_DEBIT
          enum:
          - CREDIT_CARD
          - DIRECT_DEBIT
          - ACH_CREDIT
          - US_BANK_TRANSFER
          - MANUAL
        enabled:
          type: boolean
          description: A boolean field indicating that the payment method type should be enabled or not
          example: true
      description: A list of allowed payment methods
    com.monytyz.billing.dunning.dto.dunningstep.DunningStepDto:
      type: object
      properties:
        createdBy:
          type: string
          description: Identifier for the user who created the record
          example: usr_X0XZ05bvkrB1RpLS
        createDate:
          type: string
          description: Timestamp of when the record was created
          format: date-time
        lastModifiedBy:
          type: string
          description: Identifier for the user who last modified the record
          example: usr_X0XZ05bvkrB1RpLS
        modifyDate:
          type: string
          description: Timestamp of when the record was last modified
          format: date-time
        id:
          type: string
          description: Unique identifier for the dunning step
          example: dunst_SFYBah2GCQXhh
        stepName:
          type: string
          description: Name of the dunning step
          example: Upcoming Payment Due
        customId:
          type: string
          description: Unique id provided by the customer
          example: 66548E95-42AE-483F-A4BC-57847B856346
        stepSequence:
          type: integer
          description: Sequence of the step
          format: int32
          example: 1
        daysSinceDueDate:
          type: integer
          description: Days since due date to activate the step
          format: int32
          example: 0
        retryCollection:
          type: boolean
          description: Boolean field to indicate if payment collection should be retried
          example: true
        sendEmail:
          type: boolean
          description: Boolean field to indicate if email should be sent
          example: true
        emailTemplateId:
          type: string
          description: Email template that will be used to send email.
          example: d-e7a983bd771343ada7429
        emailBillGroupShippingContact:
          type: boolean
          description: Boolean field to indicate if email should be sent to the BillGroup's shipping contact
          example: true
        emailBillGroupCCEmails:
          type: boolean
          description: Boolean field to indicate if email should be sent to the BillGroup's CC contacts
          example: true
        internalCCEmails:
          uniqueItems: true
          type: array
          description: CC emails to be used
          example: '[''abc@gmail.com'', ''def@gmail.com'']'
          items:
            type: string
            description: CC emails to be used
            example: '[''abc@gmail.com'', ''def@gmail.com'']'
        emailAccountCCEmails:
          type: boolean
          description: Boolean field to indicate if email should be sent to the Account's CC email addresses
          example: true
    com.monytyz.billing.payment.dto.paymentgateway.PaymentGatewayConfigurations:
      required:
      - configurations
      type: object
      properties:
        configurations:
          type: array
          description: Configuration for minimum and maximum payments amounts
          example: US_BANK_TRANSFER
          items:
            $ref: '#/components/schemas/com.monytyz.billing.payment.dto.paymentgateway.PaymentGatewayConfiguration'
      description: Configuration for minimum and maximum payments amounts
    com.monytyz.billing.payment.dto.paymentgateway.PaymentGatewayDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the payment gateway
          example: pmtgw_EMfbqn56S9h9CweL
        type:
          type: string
          description: Payment gateway type like STRIPEV2, BRAINTREE, WORLDPAY etc
          example: STRIPEV2
          enum:
          - STRIPEV2
          - BRAINTREE
          - WORLDPAY
          - AUTHNET
          - ADYEN
          - VANTIV
          - PAYPAL_PRO
          - PAYMENT_TECH
          - TEST_PASS
          - TEST_FAIL
        status:
          type: string
          description: Payment gateway status like ACTIVE, INACTIVE OR ARCHIVED
          example: ACTIVE
          enum:
          - ACTIVE
          - INACTIVE
          - ARCHIVED
        testGateway:
          type: boolean
          description: A boolean field indicating that it is the test gateway or not
          example: false
        description:
          type: string
          description: Description of the payment gateway
          example: Description for the payment gateway
        publicKey:
          type: string
          description: Public key for the payment gateway. It's publishable key for Stripe
          example: pk_test_51Hwfowe23LJ02M1f5WZ6c23
        defaultGateway:
          type: boolean
          description: A boolean field indicating that it is the default gateway or not
          example: true
        locked:
          type: boolean
          description: A boolean field indicating that the gateway is locked or not
          example: true
        webhookId:
          type: string
          description: Unique identifier for the webhook
          example: we_1MEaM8BVaXRvkQL7LqeaOCgy
        allowedPaymentMethods:
          uniqueItems: true
          type: array
          description: A list of allowed payment methods
          items:
            $ref: '#/components/schemas/com.monytyz.billing.payment.dto.paymentmethod.PaymentMethodSupport'
        paymentConfiguration:
          $ref: '#/components/schemas/com.monytyz.billing.payment.dto.paymentgateway.PaymentGatewayConfigurations'
      description: Payment gateway details of the payment method
    com.monytyz.billing.customer.dto.account.overview.AccountOverview:
      required:
      - arr
      - lifetimeValue
      - mrr
      - recentInvoiceAmount
      type: object
      properties:
        recentInvoiceAmount:
          type: number
          description: The most recent invoice's amount by created date
          example: 1048
        mrr:
          type: number
          description: Monthly recurring revenue
          example: 795.75
        arr:
          type: number
          description: Annual recurring revenue
          example: 9549
        lifetimeValue:
          type: number
          description: Total paid invoices amount of an account
          example: 3043
    com.monytyz.billing.customer.dto.billgroup.BillGroupSummary:
      required:
      - autoEmailInvoice
      - currency
      - id
      - netTerms
      - status
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        nextInvoiceDate:
          type: string
          format: date
        previousInvoiceDate:
          type: string
          format: date
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          - CANCELED
          - SUSPENDED
        invoicingFrequency:
          type: string
          enum:
          - DAILY
          - MONTHLY
          - QUARTERLY
          - SEMIANNUALLY
          - ANNUALLY
          - CUSTOM
        autoEmailInvoice:
          type: boolean
        billDay:
          type: integer
          format: int32
        netTerms:
          type: string
          enum:
          - NET_0
          - NET_5
          - NET_7
          - NET_8
          - NET_10
          - NET_14
          - NET_15
          - NET_20
          - NET_21
          - NET_30
          - NET_45
          - NET_60
          - NET_75
          - NET_90
          - NET_100
          - NET_120
          - NET_150
          - NET_180
        currency:
          type: string
          enum:
          - AUD
          - BYN
          - CAD
          - CNY
          - DKK
          - EUR
          - GBP
          - INR
          - ISK
          - MYR
          - NOK
          - SEK
          - SGD
          - TWD
          - USD
    com.monytyz.billing.customer.dto.account.overview.BillGroupWithSubscriptionOverviews:
      type: object
      properties:
        billgroup:
          $ref: '#/components/schemas/com.monytyz.billing.customer.dto.billgroup.BillGroupSummary'
        paymentMethod:
          $ref: '#/components/schemas/com.monytyz.billing.payment.dto.paymentmethod.PaymentMethodDto'
        dunningProcess:
          $ref: '#/components/schemas/com.monytyz.billing.dunning.dto.dunningprocess.DunningProcessDetailDto'
        subscriptionOverviews:
          type: array
          items:
            $ref: '#/components/schemas/com.monytyz.billing.customer.dto.account.overview.AccountSubscriptionOverviewDto'
    com.monytyz.billing.customer.dto.account.overview.BillGroupListWithSubscriptionOverviews:
      required:
      - subscriptionOverviewsByBillGroup
      type: object
      properties:
        subscriptionOverviewsByBillGroup:
          type: array
          items:
            $ref: '#/components/schemas/com.monytyz.billing.customer.dto.account.overview.BillGroupWithSubscriptionOverviews'
    com.monytyz.billing.payment.dto.paymentmethod.BillingDetails:
      type: object
      properties:
        fullName:
          type: string
          description: Full name of the contact
          example: Bob Smith
        email:
          type: string
          description: Email of the contact
          example: contact@example.com
        phone:
          type: string
          description: Phone of the contact
          example: +44 7700 900278
        title:
          type: string
          description: Title of the contact
          example: CFO
        line1:
          type: string
          description: First line of the address
          example: 8 Louise Court
        line2:
          type: string
          description: Second line of the address
          example: 12–13 Beaulieu Road
        city:
          type: string
          description: City of the address
          example: Southampton
        state:
          type: string
          description: State of the address
          example: London
        postalCode:
          type: string
          description: Postal code of the address
          example: PO2 0DN
        country:
          type: string
          description: Country of the address
          example: UK
      description: Billing details of the payment method
    com.monytyz.billing.payment.dto.paymentgateway.PaymentGatewayConfiguration:
      required:
      - amountConfigurations
      - type
      type: object
      properties:
        type:
          type: string
          description: Payment method type
          example: US_BANK_TRANSFER
          enum:
          - CREDIT_CARD
          - DIRECT_DEBIT
          - ACH_CREDIT
          - US_BANK_TRANSFER
          - MANUAL
        amountConfigurations:
          type: array
          description: Minimum and maximum amounts for payment type per currency
          items:
            $ref: '#/components/schemas/com.monytyz.billing.payment.dto.paymentgateway.AmountConfiguration'
      description: Configuration for minimum and maximum payments amounts
      example: US_BANK_TRANSFER
    com.monytyz.billing.payment.dto.paymentmethod.PaymentMethodDto:
      type: object
      properties:
        createdBy:
          type: string
          description: Identifier for the user who created the record
          example: usr_X0XZ05bvkrB1RpLS
        createDate:
          type: string
          description: Timestamp of when the record was created
          format: date-time
        lastModifiedBy:
          type: string
          description: Identifier for the user who last modified the record
          example: usr_X0XZ05bvkrB1RpLS
        modifyDate:
          type: string
          description: Timestamp of when the record was last modified
          format: date-time
        id:
          type: string
          description: Unique identifier for the payment method
          example: pmmd_ljUBlyVLF10JQ
        account:
          $ref: '#/components/schemas/com.monytyz.billing.customer.dto.account.AccountSummary'
        paymentMethodName:
          type: string
          description: Name of the payment method
          example: Test Payment
        customId:
          type: string
          description: A user provided identifier for the payment method
          example: '123456789'
        defaultPaymentMethod:
          type: boolean
          description: A boolean field indicating that it is the default payment method or not
          example: true
        paymentGateway:
          $ref: '#/components/schemas/com.monytyz.billing.payment.dto.paymentgateway.PaymentGatewayDto'
        creditCardType:
          type: string
          description: Payment method credit card type like VISA, MASTERCARD, DISCOVER, AMEX, DINERS, JCB or UNIONPAY
          example: VISA
          enum:
          - VISA
          - MASTERCARD
          - DISCOVER
          - AMEX
          - DINERS
          - JCB
          - UNIONPAY
        creditCardNumber:
          type: string
          description: Credit card number for the payment method
          example: '461156147593489'
        lastFour:
          type: string
          description: Last four digit of a credit card number
          example: '3489'
        expirationYear:
          type: integer
          description: Credit card expiration year
          format: int32
          example: 2024
        expirationMonth:
          type: integer
          description: Credit card expiration month
          format: int32
          example: 9
        cvcValidation:
          type: boolean
          description: A boolean field indicating that credit card CVC is validate or not
          example: true
        addressValidation:
          type: boolean
          description: A boolean field indicating that payment method address is validate or not
          example: true
        postalValidation:
          type: boolean
          description: A boolean field indicating that payment method post code is validate or not
          example: false
        paymentMethodType:
          type: string
          description: Payment method type like CREDIT_CARD, DIRECT_DEBIT, ACH_CREDIT etc
          example: DIRECT_DEBIT
          enum:
          - CREDIT_CARD
          - DIRECT_DEBIT
          - ACH_CREDIT
          - US_BANK_TRANSFER
          - MANUAL
        creditCardGateWayToken:
          type: string
          description: Credit card gateway token
        gatewayCustomerId:
          type: string
          description: A provided id to reference this payment method uniquely
          example: cus_NvH7QU3I0O50DG
        description:
          type: string
          description: Payment method description
          example: Payment description
        status:
          type: string
          description: Payment method status like ACTIVE, INACTIVE, CANCELED OR EXPIRED
          example: ACTIVE
          enum:
          - ACTIVE
          - INACTIVE
          - CANCELED
          - EXPIRED
        oneTime:
          type: boolean
          description: A boolean field indicating that if this payment method should be available for further use or not
          example: false
        testPaymentMethod:
          type: boolean
          description: A boolean field indicating that if the payment method for testing or not.True if this payment method is associated with a test/staging payment gateway
          example: false
        externalPaymentMethodId:
          type: string
          description: External payment method id
          example: pm_1N9Qb2DOMlRAd5wBTXN469uO
        accountType:
          type: string
          description: Account type of the payment method
          example: checking
        bankName:
          type: string
          description: Bank name of the payment method
          example: Abc bank of USA
        routingNumber:
          type: string
          description: Routing number of the payment method
          example: '125000105'
        swiftCode:
          type: string
          description: Swift of the payment method
          example: USBKUS44IMT
        accountNumber:
          type: string
          description: Account number of the payment method
          example: '46113503456147593489'
        billingDetails:
          $ref: '#/components/schemas/com.monytyz.billing.payment.dto.paymentmethod.BillingDetails'
        cancellationDate:
          type: string
          format: date-time
        cancellationReason:
          type: string