# About MonetizeNow MonetizeNow provides a Quoting, Billing, and Usage platform built for the B2B SaaS enterprise. Our platform simplifies monetization for SMBs by uniting these functions in a single application.

## Core Platform Features MonetizeNow provides: - Product catalog specifically built to handle enterprise-grade selling complexity of subscriptions, one-time, and usage. - A single system that supports all your sales channels natively: self-serve, CRM, Partners, In-Product, and Marketplaces. - Complex enterprise quoting, flexible rules and approval engine, E-sign, Clean order forms - Broad API support for integrating with existing and future systems. # Getting Started with MonetizeNow APIs The MonetizeNow APIs are RESTful libraries that enable developers to integrate with the MonetizeNow platform for the complete revenue life cycle. ## Authentication The preferred authentication method is a generated API key. ### Getting an API Key You can request your API Key from your MonetizeNow tenant: 1. Navigate to the **Settings -> API Keys** page to generate an API key for your tenant.

1. Click **New Api Key**. 2. Enter a name for the key as an identifier. 3. Click **Ok**.

1. Copy and store your key in a safe place. For security reasons, this is the only time we display it. 2. Click **Ok**. You can now use this API key to interact with all MonetizeNow APIs. ## Pagination The MonetizeNow API provides pagination attributes for methods that return multiple records. **pageSize**\=n pageSize indicates the number of elements in the page. **currentPage**\=n currentPage indicates the page to start with. Use currentPage and pageSize to return a sublist from a list of sorted resources where the sort criteria is defaulted or set via API: `GET /api/accounts?currentPage=3&pageSize=20` ## Error Handling The MonetizeNow API follows standard RESTful error handling. It returns the following error types: | Title | Code | Description | | --- | --- | --- | | Bad request | 400 | The request submitted was not acceptable. Missing parameters or a malformed request body will produce this error | | Resource not found by ID | 404 | The request submitted an identifier that does not match a record for the target entity. | | Resource is not in the required state | 409 | The identified resource is not an eligible target. For example, attempting to restore an offering that has not been archived returns a 409. | | Internal server error | 500 | An unexpected error occurred. Contact MonetizeNow Support. | ## Webhooks Use webhooks to integrate MonetizeNow with external services. The following events are supported. | Entity | Event | Occurs When | | --- | --- | --- | | Account | account.created | an account is created | | | account.updated | an account is updated | | Contact | contact.created | a contact is created | | | contact.updated | a contact is updated | | Quote | quote.created | a quote is created | | | quote.updated | a quote is updated | | | quote.accepted | a quote is accepted | | | quote.processed | a quote is processed | | | quote.cancelled | a quote is cancelled | | | quote.offering.created | an offering is added to a quote | | | quote.offering.updated | an offering on a quote is updated | | | quote.offering.deleted | an offering is deleted from a quote | | Opportunity | opportunity.created | an opportunity is created | | | opportunity.updated | an opportunity is updated | | Offering | offering.created | an offering is created | | | offering.updated | an offering is updated | | Contract | contract.created | a contract is created | | | contract.updated | a contract is updated | | Rate | rate.created | a rate is created | | | rate.updated | a rate is updated | | | rate.deleted | a rate is deleted | | | price.deleted | a rate's price is deleted | | Bill Group | dunning.step.tiggered | a dunning step is triggered | # Concepts ## Product Catalog The core of the MonetizeNow platform is the product catalog. The entities that make up the Product Catalog are: - Product - Usage Type - Price - Offering - Rate The **Product** is the starting point for any quote, the simplest line item. If that line item has a usage component, then a **Usage Type** is assigned. A single Product has a **Price**. However, a Product can be one of several included in an **Offering**, or bundle. Offerings are available at one \*_Rate \*_or more. A Rate is a different way to price products and model an offering. You can create multiple Rates of different currencies and billing frequencies. For example, the Products in a product catalog might include software access, services, setup fees, and API calls. Your organization may allow a customer to order a single set of 200 API calls, or you may provide a package of support hours and API calls as an Offering. Prices might be directly related to set of API calls or calculated by means of an "Get Started" Offering and Rate for API access. ## Accounts Accounts represent your existing and potential customers. The entities related to account records include: - Contacts - Bill Groups - Subscriptions - Quotes - Contracts - Invoices - Credits - Payments Each **Account** represents a current or potential customer. **Contacts** are people your organization has interacted with. **Bill Groups** represent departments, divisions, or other separate destinations for billing within that business. A **Subscription** represents a renewable request for an **Offering**. A **Quote** is a formal statement of what is being ordered and how much the items will cost. A **Contract** stores information on the Subscriptions that have been quoted and captures the result of Quote acceptance. An **Invoice** results from the agreement to make a purchase. It includes items and costs, as well as payment conditions. An Invoice might include **Credits** as adjustments to the Invoice, reducing the final amount due. For example, you might have an Account with Acme, Inc. During the sales process, your team has interacted with John, Paul, and Janis, who are now Contacts. John and Paul are in the Construction Bill Group, while Janis is in the Demolition Bill Group, reflecting their organization's structure and different payment policies. Once Janis requests a Quote for Offering A, your team adds that Offering to her Subscription. A Contract is included to specify the parameters of customer support limitations for onboarding. When Janis agrees to the purchase, your team generates an Invoice, including Credits for participation in a webinar. ### Bill Day and Invoices Each **Bill Group** has a **Bill Day** field. Bill Day specifies the day of the month on which **Invoices** will be generated. Bill Day defaults to the day on which the Bill Group was created unless you specify an alternate number in the Bill Day field. ### Quotes and Future Start Dates You might set the **Start Date** of a **Quote** to a future date, maybe to align with your customer's budgeting process. That date automatically applies to the associated **Contract**. In this case, both the Contract and the quoted **Subscriptions** remain in a Pending state until the Start Date. ### Payment Methods The **Payment Methods** available to a **Bill Group** represent the payment service providers you have integrated with your MonetizeNow tenant. Payments made through integrated gateways are reflected in **Payment** records credited to the Bill Group. # Sample Workflows ## Sending Usage/Consumption Data Sending Usage Events to the MonetizeNow Usage Service requires calls to both the CPQ/Billing API and the Usage API. Here's a basic workflow: | Task | Call | | --- | --- | | Get Subscriptions for Account | GET /api/accounts/{accountId}/subscriptions | | Determine which Usage Types apply to each Subscription | | | Post usage Events by Subscription | POST /events | # Object Life Cycles ## Quotes The Quote life cycle depends on whether the request for a new quote is actually a renewal or amendment of an existing quote. Event for a customer who has ordered before, any difference in the underlying contract makes a the new quote route necessary. The following diagram outlines the differences in the life cycles of new quotes and renewals.

200Update price uplift configuration by id

400Bad Request

404Resource not found by Id

500Internal server error. Please contact the support team.