Jump to Content
Documentation
API Endpoints
Discussions
API Endpoints
Moon (Dark Mode)
Sun (Light Mode)
Documentation
API Endpoints
Discussions
/api/quotes/{quoteId}/archive
All
Pages
Start typing to search…
JUMP TO
MonetizeNow APIs
Getting Started
Webhooks
Webhook Payload Examples
API Breaking Change Policy
Self Service (pre-release)
Self-Serve / Product-Led-Growth
Product Catalog API
Account Management API
Trials
Evergreen Subscriptions (AKA Contracts with no fixed end date)
Pricing API
Contract Management & Checkout APIs
OpenAPI definition
Account
Get account
get
Update account
put
Cancel account
put
Activate account
put
Get account
get
Update account
put
Get all accounts
get
Create account
post
Search accounts by id, customId, and name
get
Run Billing Batch for Account
post
Update account's shipping or billing address
put
BillGroup
Get a single billgroup
get
Update a billgroup
put
Deactivate a billgroup
put
Activate a billgroup
put
Get billgroups for an account
get
Get a single billgroup
get
Contact
Get contact
get
Get contact
get
Update bill group contact
put
Get all contacts
get
Create contact
post
Get all contacts
get
Create bill group contact
post
Search contact by id, customId, and name
get
Get contact
get
Create contact for account
post
Credit
Update a credit
put
Create a credit
post
Get credit by id
get
Set Custom Fields For Credit
put
Void a credit by credit id
post
Get credit in pdf
get
Invoice
Get Invoices By id
get
Update vat number, purchase order number, registration number, custom fields for invoice
put
Preview an upcoming invoice
get
Get Invoices By Account ID
get
Get Invoices By Account ID and BillGroup id
get
Generate Invoice Pdf
get
Offering
Get an Offering
get
Deactivate Offering
put
Cancel an Offering
put
Activate an Offering
put
Get all Offerings
get
Archive Offering
post
Get all Offerings
get
Search offerings by id, customId, and name
get
Update an Offering
put
Create an Offering
post
Payment
Pay an invoice
post
Pay an invoice using manually payment
post
Pay all invoices of a bill group
post
Retrieve payments for an invoice
get
Retrieve payment by id
get
Refund a payment
post
Update Manual Payment
put
/api/payments/{paymentId}/print
get
Payment Gateway
Create setup intent
post
Get payment gateway list
get
PaymentMethod
Set default payment method
put
Retrieve all the payment methods for the account
get
Create payment method for an account
post
Import external payment methods for an account
post
Retrieve a gateway account
get
Create a gateway account
post
Retrieve a payment method
get
Products
Get product by Id
get
Updates a product
put
Deactivate product
put
Activate product by product Id
put
Get all products
get
Creates a new product
post
Search products by id, customId, and name
get
Rate
Get a rate object by providing offering and rate Id
get
Update a rate for offering
put
Delete rate.
del
Cancel rate
put
Activate rate
put
Get all the rates for an offering
get
Create a rate for offering
post
Get all the rates
get
Get rate
get
Subscription
Get subscription by Id
get
Get a list of subscriptions by providing a billGroupId
get
Get a list of subscriptions by providing a billGroupId and a subscriptionId
get
Get a list of subscriptions by providing an accountId
get
Usage
Void a usage event
put
Update units consumed and/or the rated price
put
Get usage events
get
Record usage events
post
Get usage consumption per day
get
Get usage consumption
get
Account Overview
/api/v2/accounts/{accountId}/subscriptions/overview
get
Get account overview by account
get
Contract
/api/contracts/{contractId}
get
/api/contracts/{contractId}
put
/api/contracts/{contractId}/renew
post
/api/contracts/{contractId}/changeOwner/{userId}
post
/api/contracts/{contractId}/amend
post
/api/contracts
get
/api/accounts/{accountId}/contracts
get
CreditNote
/api/invoices/{invoiceId}/creditNotes
get
/api/invoices/{invoiceId}/creditNotes
post
/api/creditNotes/{creditNoteId}
get
/api/accounts/{accountId}/creditNotes
get
Set Custom Fields for CreditNote By id
put
Void a credit note by credit note id
post
/api/creditNotes/{creditNoteId}/print
get
Opportunity
/api/opportunities/{opportunityId}
get
/api/opportunities/{opportunityId}/quotes/{quoteId}/setPrimary
put
/api/opportunities/{opportunityId}/quotes/{quoteId}/link
put
/api/opportunities
get
/api/opportunities
post
/api/opportunities/customId/{customId}
get
Price Uplift Configuration
/api/priceUplift/{priceUpliftConfigurationId}
get
/api/priceUplift/{priceUpliftConfigurationId}
put
Quote
/api/quotes/{quoteId}
get
Updates an existing quote
put
/api/quotes/{quoteId}
del
/api/quotes/{quoteId}/quoteOfferings/{quoteOfferingId}
get
Updates a quote offering
put
/api/quotes/{quoteId}/quoteOfferings/{quoteOfferingId}
del
Set Custom Fields for Quote By id
put
/api/quotes/{quoteId}/contacts
get
/api/quotes/{quoteId}/contacts
put
/api/quotes/{quoteId}/archive
put
/api/quotes/{quoteId}/addresses
put
/api/quotes
get
Create a new quote
post
/api/quotes/{quoteId}/send
post
/api/quotes/{quoteId}/review
post
/api/quotes/{quoteId}/retract
post
Creates a quote offering
post
/api/quotes/{quoteId}/quoteOfferings/{quoteOfferingId}/priceUplift
post
/api/quotes/{quoteId}/quoteOfferings/{quoteOfferingId}/priceUplift
del
/api/quotes/{quoteId}/process
post
/api/quotes/{quoteId}/cancel
post
/api/quotes/{quoteId}/accept
post
/api/quotes/{quoteId}/opportunity
get
/api/accounts/{accountId}/quotes
get
/api/quotes/{quoteId}/edit
post
Trial
/api/trials
get
/api/trials
post
/api/accounts/{accountId}/trials/{trialId}/cancel
post
/api/accounts/{accountId}/trials
get
/api/accounts/{accountId}/trials/{trialId}/convert
post
AccountDocument
/api/accounts/{accountId}/accountDocuments/{accountDocumentId}
get
/api/accounts/{accountId}/accountDocuments/{accountDocumentId}
put
/api/accounts/{accountId}/accountDocuments/{accountDocumentId}
del
/api/accounts/{accountId}/accountDocuments/{accountDocumentId}/contacts
put
/api/accounts/{accountId}/accountDocuments
get
/api/accounts/{accountId}/accountDocuments
post
/api/accounts/{accountId}/accountDocuments/{accountDocumentId}/send
post
/api/accounts/{accountId}/accountDocuments/{accountDocumentId}/draft
post
/api/accounts/{accountId}/accountDocuments/{accountDocumentId}/signerStats
get
/api/accounts/{accountId}/accountDocuments/{accountDocumentId}/attachments/{storageId}
get
MonetizeNow Self-Service API
Catalog
Pricing
Contracts
Self-Service
Pricing
Get rates
get
Calculate prices for products
post
Checkout
Provision a new contract
post
Amend an existing contract
post
Powered by
Ask AI
/api/quotes/{quoteId}/archive
put
https://api.monetizeplatform.com/api/quotes/
{quoteId}
/archive
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
