{"items":[{"type":"separator","label":"QUICKSTART API"},{"type":"link","fsPath":"other-api/quickstart-api-intro.md","metadata":{"type":"markdown"},"label":"Introduction","link":"/other-api/quickstart-api-intro","routeSlug":"/other-api/quickstart-api-intro"},{"type":"link","fsPath":"other-api/quickstart-api-requests.md","metadata":{"type":"markdown"},"label":"Making requests","link":"/other-api/quickstart-api-requests","routeSlug":"/other-api/quickstart-api-requests"},{"type":"group","label":"Quickstart API Reference","items":[{"type":"link","label":"Quickstart API Reference","link":"/other-api/quickstart-api","routeSlug":"/other-api/quickstart-api"},{"type":"separator","label":"PRODUCTS"},{"type":"group","label":"Products","link":"/other-api/quickstart-api/products","routeSlug":"/other-api/quickstart-api/products","items":[{"label":"Retrieve a product","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/products/getproduct","routeSlug":"/other-api/quickstart-api/products/getproduct","metadata":{"seo":{"title":"Retrieve a product","description":"Retrieves the product with the given ID."}},"httpPath":"/products/{product_id}"},{"label":"Update a product","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/products/updateproduct","routeSlug":"/other-api/quickstart-api/products/updateproduct","metadata":{"seo":{"title":"Update a product","description":"Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/products/{product_id}"},{"label":"Delete a product","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/products/deleteproduct","routeSlug":"/other-api/quickstart-api/products/deleteproduct","metadata":{"seo":{"title":"Delete a product","description":"Permanently deletes a product. It cannot be undone."}},"httpPath":"/products/{product_id}"},{"label":"List products","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/products/getproducts","routeSlug":"/other-api/quickstart-api/products/getproducts","metadata":{"seo":{"title":"List products","description":"Returns a dictionary with a data property that contains an array of products, starting after the cursor, if used. Each entry in the array is a separate product object. If no more products are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/products"},{"label":"Create a product","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/products/createproduct","routeSlug":"/other-api/quickstart-api/products/createproduct","metadata":{"seo":{"title":"Create a product","description":"Creates a new product object."}},"httpPath":"/products"}]},{"type":"group","label":"Plans","link":"/other-api/quickstart-api/plans","routeSlug":"/other-api/quickstart-api/plans","items":[{"label":"Retrieve a plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/plans/getplan","routeSlug":"/other-api/quickstart-api/plans/getplan","metadata":{"seo":{"title":"Retrieve a plan","description":"Retrieves the plan with the given ID."}},"httpPath":"/plans/{plan_id}"},{"label":"Update a plan","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/plans/updateplan","routeSlug":"/other-api/quickstart-api/plans/updateplan","metadata":{"seo":{"title":"Update a plan","description":"Updates the specified plan by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/plans/{plan_id}"},{"label":"Delete a plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/plans/deleteplan","routeSlug":"/other-api/quickstart-api/plans/deleteplan","metadata":{"seo":{"title":"Delete a plan","description":"Permanently deletes a plan. It cannot be undone."}},"httpPath":"/plans/{plan_id}"},{"label":"List plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/plans/getplans","routeSlug":"/other-api/quickstart-api/plans/getplans","metadata":{"seo":{"title":"List plans","description":"Returns a dictionary with a data property that contains an array of plans, starting after the cursor, if used. Each entry in the array is a separate plan object. If no more plans are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/plans"},{"label":"Create a plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/plans/createplan","routeSlug":"/other-api/quickstart-api/plans/createplan","metadata":{"seo":{"title":"Create a plan","description":"Creates a new plan for an existing product."}},"httpPath":"/plans"}]},{"type":"group","label":"Prices","link":"/other-api/quickstart-api/prices","routeSlug":"/other-api/quickstart-api/prices","items":[{"label":"Retrieve a price","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/prices/getprice","routeSlug":"/other-api/quickstart-api/prices/getprice","metadata":{"seo":{"title":"Retrieve a price","description":"Retrieves the price with the given ID."}},"httpPath":"/prices/{price_id}"},{"label":"Update a price","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/prices/patchprice","routeSlug":"/other-api/quickstart-api/prices/patchprice","metadata":{"seo":{"title":"Update a price","description":"Updates the specified price by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/prices/{price_id}"},{"label":"Delete a price","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/prices/deleteprice","routeSlug":"/other-api/quickstart-api/prices/deleteprice","metadata":{"seo":{"title":"Delete a price","description":"Permanently deletes a price. It cannot be undone."}},"httpPath":"/prices/{price_id}"},{"label":"List prices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/prices/getprices","routeSlug":"/other-api/quickstart-api/prices/getprices","metadata":{"seo":{"title":"List prices","description":"Returns a dictionary with a data property that contains an array of prices, starting after the cursor, if used. Each entry in the array is a separate price object. If no more prices are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/prices"},{"label":"Create a price","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/prices/createprice","routeSlug":"/other-api/quickstart-api/prices/createprice","metadata":{"seo":{"title":"Create a price","description":"Creates a new price for an existing plan."}},"httpPath":"/prices"}]},{"type":"separator","label":"CUSTOMER ACCOUNTS"},{"type":"group","label":"Accounts","link":"/other-api/quickstart-api/accounts","routeSlug":"/other-api/quickstart-api/accounts","items":[{"label":"List accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/accounts/getaccounts","routeSlug":"/other-api/quickstart-api/accounts/getaccounts","metadata":{"seo":{"title":"List accounts","description":"Returns a dictionary with a data property that contains an array of accounts, starting after the cursor, if used. Each entry in the array is a separate account object. If no more accounts are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/accounts"},{"label":"Create an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/accounts/createaccount","routeSlug":"/other-api/quickstart-api/accounts/createaccount","metadata":{"seo":{"title":"Create an account","description":"Creates a new account object."}},"httpPath":"/accounts"},{"label":"Retrieve an account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/accounts/getaccount","routeSlug":"/other-api/quickstart-api/accounts/getaccount","metadata":{"seo":{"title":"Retrieve an account","description":"Retrieves the account with the given ID."}},"httpPath":"/accounts/{account_id}"},{"label":"Update an account","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/accounts/updateaccount","routeSlug":"/other-api/quickstart-api/accounts/updateaccount","metadata":{"seo":{"title":"Update an account","description":"Updates the specified account by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/accounts/{account_id}"},{"label":"Delete an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/accounts/deleteaccount","routeSlug":"/other-api/quickstart-api/accounts/deleteaccount","metadata":{"seo":{"title":"Delete an account","description":"Permanently deletes an account. It cannot be undone."}},"httpPath":"/accounts/{account_id}"},{"label":"Generate billing documents for an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/accounts/generatebillingdocuments","routeSlug":"/other-api/quickstart-api/accounts/generatebillingdocuments","metadata":{"seo":{"title":"Generate billing documents for an account","description":"Creates billing documents for an account."}},"httpPath":"/accounts/{account_id}/bill"},{"label":"Preview an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/accounts/previewaccount","routeSlug":"/other-api/quickstart-api/accounts/previewaccount","metadata":{"seo":{"title":"Preview an account","description":"Generates a preview of future invoice and credit memo items for a customer account.              Previewing a customer account shows you how much a single customer will be invoiced from the most recent invoice to a specific end of term date in the future.            Previewing a customer account only calculates taxes for charges if you use Zuora Tax and the price associated with the invoice item is tax inclusive; otherwise, it does not calculate taxes."}},"httpPath":"/accounts/{account_id}/preview"}]},{"type":"group","label":"Contacts","link":"/other-api/quickstart-api/contacts","routeSlug":"/other-api/quickstart-api/contacts","items":[{"label":"Retrieve a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/contacts/getcontact","routeSlug":"/other-api/quickstart-api/contacts/getcontact","metadata":{"seo":{"title":"Retrieve a contact","description":"Retrieves the contact with the given ID."}},"httpPath":"/contacts/{contact_id}"},{"label":"Update a contact","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/contacts/updatecontact","routeSlug":"/other-api/quickstart-api/contacts/updatecontact","metadata":{"seo":{"title":"Update a contact","description":"Updates the specified contact by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/contacts/{contact_id}"},{"label":"Delete a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/contacts/deletecontact","routeSlug":"/other-api/quickstart-api/contacts/deletecontact","metadata":{"seo":{"title":"Delete a contact","description":"Permanently deletes a contact. It cannot be undone."}},"httpPath":"/contacts/{contact_id}"},{"label":"List contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/contacts/getcontacts","routeSlug":"/other-api/quickstart-api/contacts/getcontacts","metadata":{"seo":{"title":"List contacts","description":"Returns a dictionary with a data property that contains an array of contacts, starting after the cursor, if used. Each entry in the array is a separate contact object. If no more contacts are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/contacts"},{"label":"Create a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/contacts/createcontact","routeSlug":"/other-api/quickstart-api/contacts/createcontact","metadata":{"seo":{"title":"Create a contact","description":"Creates a new contact object."}},"httpPath":"/contacts"},{"label":"Scrub a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/contacts/scrubcontact","routeSlug":"/other-api/quickstart-api/contacts/scrubcontact","metadata":{"seo":{"title":"Scrub a contact","description":"Scrubs the sensitive data for the contact with the given ID."}},"httpPath":"/contacts/{contact_id}/scrub"}]},{"type":"separator","label":"ORDERS AND SUBSCRIPTIONS"},{"type":"group","label":"Orders","link":"/other-api/quickstart-api/orders","routeSlug":"/other-api/quickstart-api/orders","items":[{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/orders/getorders","routeSlug":"/other-api/quickstart-api/orders/getorders","metadata":{"seo":{"title":"List orders","description":"Lists all or a subset of orders in your tenant."}},"httpPath":"/orders"},{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/orders/createorder","routeSlug":"/other-api/quickstart-api/orders/createorder","metadata":{"seo":{"title":"Create an order","description":"You can use this operation to create subscriptions and make changes to existing subscriptions. You can also use this operation to create order line items.       Note that the following limitations apply to this operation:             Up to 50 subscriptions are allowed in a single call.      Up to 100 order line items are allowed in an order.       Up to 1000 orders are allowed on a subscription.      "}},"httpPath":"/orders"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/orders/getorder","routeSlug":"/other-api/quickstart-api/orders/getorder","metadata":{"seo":{"title":"Retrieve an order","description":"Use this operation to retrieve the detailed information about a specific order."}},"httpPath":"/orders/{order_id}"},{"label":"Delete an order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/orders/deleteorder","routeSlug":"/other-api/quickstart-api/orders/deleteorder","metadata":{"seo":{"title":"Delete an order","description":"Deletes an order."}},"httpPath":"/orders/{order_id}"},{"label":"Preview an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/orders/createorderpreview","routeSlug":"/other-api/quickstart-api/orders/createorderpreview","metadata":{"seo":{"title":"Preview an order","description":"Retrieves the preview of the order delta metrics and invoice items of a specified order. Preview for subscriptions and order line items are both supported. This operation is only an order preview and no order is created.        Note that the following limitations apply to this operation:             Up to 50 subscriptions are allowed in a single call.       Up to 100 order line items are allowed in an order preview.       "}},"httpPath":"/orders/preview"},{"label":"Activate an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/orders/activateorder","routeSlug":"/other-api/quickstart-api/orders/activateorder","metadata":{"seo":{"title":"Activate an order","description":"Activates a draft order."}},"httpPath":"/orders/{order_id}/activate"},{"label":"Cancel an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/orders/cancelorder","routeSlug":"/other-api/quickstart-api/orders/cancelorder","metadata":{"seo":{"title":"Cancel an order","description":"Cancels a draft order."}},"httpPath":"/orders/{order_id}/cancel"}]},{"type":"group","label":"Order Line Items","link":"/other-api/quickstart-api/order-line-items","routeSlug":"/other-api/quickstart-api/order-line-items","items":[{"label":"Retrieve an order line item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/order-line-items/getorderlineitem","routeSlug":"/other-api/quickstart-api/order-line-items/getorderlineitem","metadata":{"seo":{"title":"Retrieve an order line item","description":"Use this operation to retrieve the detailed information about a specific order line item."}},"httpPath":"/order_line_items/{order_line_item_id}"},{"label":"Update an order line item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/order-line-items/patchorderlineitem","routeSlug":"/other-api/quickstart-api/order-line-items/patchorderlineitem","metadata":{"seo":{"title":"Update an order line item","description":"Use this operation to update the information of a specific order line item."}},"httpPath":"/order_line_items/{order_line_item_id}"}]},{"type":"group","label":"Subscriptions","link":"/other-api/quickstart-api/subscriptions","routeSlug":"/other-api/quickstart-api/subscriptions","items":[{"label":"Retrieve a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/getsubscriptionbykey","routeSlug":"/other-api/quickstart-api/subscriptions/getsubscriptionbykey","metadata":{"seo":{"title":"Retrieve a subscription","description":"Retrieves the subscription with the given subscription key (number or ID)."}},"httpPath":"/subscriptions/{subscription_id}"},{"label":"Update a subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/patchsubscription","routeSlug":"/other-api/quickstart-api/subscriptions/patchsubscription","metadata":{"seo":{"title":"Update a subscription","description":"Updates the specified subscription by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/subscriptions/{subscription_id}"},{"label":"List subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/getsubscriptions","routeSlug":"/other-api/quickstart-api/subscriptions/getsubscriptions","metadata":{"seo":{"title":"List subscriptions","description":"Returns a dictionary with a data property that contains an array of subscriptions, starting after the cursor, if used. Each entry in the array is a separate subscription object. If no more subscriptions are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/subscriptions"},{"label":"Create a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/createsubscription","routeSlug":"/other-api/quickstart-api/subscriptions/createsubscription","metadata":{"seo":{"title":"Create a subscription","description":"Creates a new subscription."}},"httpPath":"/subscriptions"},{"label":"Pause a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/pausesubscription","routeSlug":"/other-api/quickstart-api/subscriptions/pausesubscription","metadata":{"seo":{"title":"Pause a subscription","description":"Pauses a subscription."}},"httpPath":"/subscriptions/{subscription_id}/pause"},{"label":"Resume a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/resumesubscription","routeSlug":"/other-api/quickstart-api/subscriptions/resumesubscription","metadata":{"seo":{"title":"Resume a subscription","description":"Resumes a subscription."}},"httpPath":"/subscriptions/{subscription_id}/resume"},{"label":"Cancel a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/cancelsubscription","routeSlug":"/other-api/quickstart-api/subscriptions/cancelsubscription","metadata":{"seo":{"title":"Cancel a subscription","description":"Cancels a subscription."}},"httpPath":"/subscriptions/{subscription_id}/cancel"},{"label":"Activate a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/activatesubscription","routeSlug":"/other-api/quickstart-api/subscriptions/activatesubscription","metadata":{"seo":{"title":"Activate a subscription","description":"A subscription must be active before you can bill your subscribers. Activating a subscription requires entering at least one of the following dates: contract_effective, service_activation, and customer_acceptance. See Billing Trigger Dates for more information."}},"httpPath":"/subscriptions/{subscription_id}/activate"},{"label":"Preview a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/previewsubscription","routeSlug":"/other-api/quickstart-api/subscriptions/previewsubscription","metadata":{"seo":{"title":"Preview a subscription","description":"You can preview the billing document metrics or the order delta metrics across a specified time frame."}},"httpPath":"/subscriptions/preview"},{"label":"Preview an existing subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/previewexistingsubscription","routeSlug":"/other-api/quickstart-api/subscriptions/previewexistingsubscription","metadata":{"seo":{"title":"Preview an existing subscription","description":"You can preview the billing document metrics or the order delta metrics across a specified time frame."}},"httpPath":"/subscriptions/{subscription_id}/preview"},{"label":"List all versions of a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/getsubscriptionbyversion","routeSlug":"/other-api/quickstart-api/subscriptions/getsubscriptionbyversion","metadata":{"seo":{"title":"List all versions of a subscription","description":"Lists all versions of the specified subscription."}},"httpPath":"/subscriptions/{subscription_id}/versions"},{"label":"Uncancel a subscription","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscriptions/uncancelsubscription","routeSlug":"/other-api/quickstart-api/subscriptions/uncancelsubscription","metadata":{"seo":{"title":"Uncancel a subscription","description":"Uncancel a cancelled subscription."}},"httpPath":"/subscriptions/{subscription_id}/keep"}]},{"type":"group","label":"Subscription Plans","link":"/other-api/quickstart-api/subscription-plans","routeSlug":"/other-api/quickstart-api/subscription-plans","items":[{"label":"Retrieve a subscription plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscription-plans/getsubscriptionplan","routeSlug":"/other-api/quickstart-api/subscription-plans/getsubscriptionplan","metadata":{"seo":{"title":"Retrieve a subscription plan","description":"Retrieves the subscription plan with the given ID."}},"httpPath":"/subscription_plans/{subscription_plan_id}"},{"label":"List subscription plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscription-plans/getsubscriptionplans","routeSlug":"/other-api/quickstart-api/subscription-plans/getsubscriptionplans","metadata":{"seo":{"title":"List subscription plans","description":"Returns a dictionary with a data property that contains an array of subscription plans, starting after cursor. Each entry in the array is a separate object. If no more are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/subscription_plans"}]},{"type":"group","label":"Subscription Items","link":"/other-api/quickstart-api/subscription-items","routeSlug":"/other-api/quickstart-api/subscription-items","items":[{"label":"List subscription items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/subscription-items/getsubscriptionitems","routeSlug":"/other-api/quickstart-api/subscription-items/getsubscriptionitems","metadata":{"seo":{"title":"List subscription items","description":"List items contained in subscriptions."}},"httpPath":"/subscription_items"}]},{"type":"group","label":"Fulfillments","link":"/other-api/quickstart-api/fulfillments","routeSlug":"/other-api/quickstart-api/fulfillments","items":[{"label":"List fulfilllments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillments/getfulfillments","routeSlug":"/other-api/quickstart-api/fulfillments/getfulfillments","metadata":{"seo":{"title":"List fulfilllments","description":"Returns a dictionary with a data property that contains an array of fulfillments, starting after the cursor, if used. Each entry in the array is a separate fulfillment object. If no more fulfillment are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/fulfillments"},{"label":"Create a fulfillment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillments/createfulfillment","routeSlug":"/other-api/quickstart-api/fulfillments/createfulfillment","metadata":{"seo":{"title":"Create a fulfillment","description":"Creates a new fulfillment object."}},"httpPath":"/fulfillments"},{"label":"Retrieve a fulfillment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillments/getfulfillment","routeSlug":"/other-api/quickstart-api/fulfillments/getfulfillment","metadata":{"seo":{"title":"Retrieve a fulfillment","description":"Retrieves the fulfillment with the given ID."}},"httpPath":"/fulfillments/{fulfillment_id}"},{"label":"Update a fulfillment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillments/updatefulfillment","routeSlug":"/other-api/quickstart-api/fulfillments/updatefulfillment","metadata":{"seo":{"title":"Update a fulfillment","description":"Updates the specified fulfillment by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/fulfillments/{fulfillment_id}"},{"label":"Delete a fulfillment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillments/deletefulfillment","routeSlug":"/other-api/quickstart-api/fulfillments/deletefulfillment","metadata":{"seo":{"title":"Delete a fulfillment","description":"Permanently deletes a fulfillment. It cannot be undone."}},"httpPath":"/fulfillments/{fulfillment_id}"},{"label":"Create fulfillments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillments/createfulfillments","routeSlug":"/other-api/quickstart-api/fulfillments/createfulfillments","metadata":{"seo":{"title":"Create fulfillments","description":"Creates multiple fulfillments."}},"httpPath":"/fulfillments/bulk_create"}]},{"type":"group","label":"Fulfillment Items","link":"/other-api/quickstart-api/fulfillment-items","routeSlug":"/other-api/quickstart-api/fulfillment-items","items":[{"label":"Retrieve a fulfillment item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillment-items/getfulfillmentitem","routeSlug":"/other-api/quickstart-api/fulfillment-items/getfulfillmentitem","metadata":{"seo":{"title":"Retrieve a fulfillment item","description":"Retrieves the fulfillment item with the given ID."}},"httpPath":"/fulfillments_items/{fulfillment_item_id}"},{"label":"Update a fulfillment item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillment-items/updatefulfillmentitem","routeSlug":"/other-api/quickstart-api/fulfillment-items/updatefulfillmentitem","metadata":{"seo":{"title":"Update a fulfillment item","description":"Updates the specified fulfillment item by setting the values of the fields passed. Any fields not provided remain unchanged."}},"httpPath":"/fulfillments_items/{fulfillment_item_id}"},{"label":"Delete a fulfillment item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillment-items/deletefulfillmentitem","routeSlug":"/other-api/quickstart-api/fulfillment-items/deletefulfillmentitem","metadata":{"seo":{"title":"Delete a fulfillment item","description":"Permanently deletes a fulfillment item. This operation cannot be undone."}},"httpPath":"/fulfillments_items/{fulfillment_item_id}"},{"label":"List fulfillment items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillment-items/getfulfillmentitems","routeSlug":"/other-api/quickstart-api/fulfillment-items/getfulfillmentitems","metadata":{"seo":{"title":"List fulfillment items","description":"Returns a dictionary with a data property that contains an array of fulfillment items, starting after the cursor, if used. Each entry in the array is a separate fulfillment item object. If no more fulfillment item are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/fulfillments_items"},{"label":"Create a fulfillment item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillment-items/createfulfillmentitem","routeSlug":"/other-api/quickstart-api/fulfillment-items/createfulfillmentitem","metadata":{"seo":{"title":"Create a fulfillment item","description":"Creates a new fulfillment item object."}},"httpPath":"/fulfillments_items"},{"label":"Create fulfillment items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/fulfillment-items/createfulfillmentitems","routeSlug":"/other-api/quickstart-api/fulfillment-items/createfulfillmentitems","metadata":{"seo":{"title":"Create fulfillment items","description":"Bulk create fulfillment items."}},"httpPath":"/fulfillments_items/bulk_create"}]},{"type":"separator","label":"BILLING DOCUMENTS"},{"type":"group","label":"Invoices","link":"/other-api/quickstart-api/invoices","routeSlug":"/other-api/quickstart-api/invoices","items":[{"label":"Retrieve an invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/getinvoice","routeSlug":"/other-api/quickstart-api/invoices/getinvoice","metadata":{"seo":{"title":"Retrieve an invoice","description":"Retrieves the invoice with the given invoice ID."}},"httpPath":"/invoices/{invoice_id}"},{"label":"Update an invoice","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/patchinvoice","routeSlug":"/other-api/quickstart-api/invoices/patchinvoice","metadata":{"seo":{"title":"Update an invoice","description":"Updates an invoice by setting the values of the specified fields. Any fields not provided in the request remain unchanged."}},"httpPath":"/invoices/{invoice_id}"},{"label":"Delete an invoice","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/deleteinvoice","routeSlug":"/other-api/quickstart-api/invoices/deleteinvoice","metadata":{"seo":{"title":"Delete an invoice","description":"Deletes an invoice that has not been canceled."}},"httpPath":"/invoices/{invoice_id}"},{"label":"List invoices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/getinvoices","routeSlug":"/other-api/quickstart-api/invoices/getinvoices","metadata":{"seo":{"title":"List invoices","description":"Returns a dictionary with a data property that contains an array of invoices, starting after cursor. Each entry in the array is a separate invoice object. If no more invoices are available, the resulting array will be empty."}},"httpPath":"/invoices"},{"label":"Create an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/createinvoice","routeSlug":"/other-api/quickstart-api/invoices/createinvoice","metadata":{"seo":{"title":"Create an invoice","description":"Creates an invoice for an account."}},"httpPath":"/invoices"},{"label":"List invoice items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/getinvoiceitems","routeSlug":"/other-api/quickstart-api/invoices/getinvoiceitems","metadata":{"seo":{"title":"List invoice items","description":"Retrieves information about all items of invoices."}},"httpPath":"/invoice_items"},{"label":"Reverse an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/reverseinvoice","routeSlug":"/other-api/quickstart-api/invoices/reverseinvoice","metadata":{"seo":{"title":"Reverse an invoice","description":"Reverses a posted invoice."}},"httpPath":"/invoices/{invoice_id}/reverse"},{"label":"Post an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/postinvoice","routeSlug":"/other-api/quickstart-api/invoices/postinvoice","metadata":{"seo":{"title":"Post an invoice","description":"Opens a draft invoice."}},"httpPath":"/invoices/{invoice_id}/post"},{"label":"Unpost an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/unpostinvoice","routeSlug":"/other-api/quickstart-api/invoices/unpostinvoice","metadata":{"seo":{"title":"Unpost an invoice","description":"Unposts an open invoice that has not been applied or refunded, and changes its state to draft."}},"httpPath":"/invoices/{invoice_id}/unpost"},{"label":"Email an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/emailinvoice","routeSlug":"/other-api/quickstart-api/invoices/emailinvoice","metadata":{"seo":{"title":"Email an invoice","description":"Emails an email to your customer."}},"httpPath":"/invoices/{invoice_id}/email"},{"label":"Pay an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/payinvoice","routeSlug":"/other-api/quickstart-api/invoices/payinvoice","metadata":{"seo":{"title":"Pay an invoice","description":"Pays an invoice using an existing payment method."}},"httpPath":"/invoices/{invoice_id}/pay"},{"label":"Cancel an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/cancelinvoice","routeSlug":"/other-api/quickstart-api/invoices/cancelinvoice","metadata":{"seo":{"title":"Cancel an invoice","description":"Cancels an invoice. Only the invoice with the draft status can be canceled."}},"httpPath":"/invoices/{invoice_id}/cancel"},{"label":"Write off an invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/invoices/writeoffinvoice","routeSlug":"/other-api/quickstart-api/invoices/writeoffinvoice","metadata":{"seo":{"title":"Write off an invoice","description":"Writes off an invoice"}},"httpPath":"/invoices/{invoice_id}/write-off"}]},{"type":"group","label":"Credit Memos","link":"/other-api/quickstart-api/credit-memos","routeSlug":"/other-api/quickstart-api/credit-memos","items":[{"label":"Retrieve a credit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/getcreditmemo","routeSlug":"/other-api/quickstart-api/credit-memos/getcreditmemo","metadata":{"seo":{"title":"Retrieve a credit memo","description":"Retrieves the credit memo with the given ID."}},"httpPath":"/credit_memos/{credit_memo_id}"},{"label":"Update a credit memo","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/patchcreditmemo","routeSlug":"/other-api/quickstart-api/credit-memos/patchcreditmemo","metadata":{"seo":{"title":"Update a credit memo","description":"Updates a credit memo by setting the values of the specified fields. Any fields not provided in the request remain unchanged."}},"httpPath":"/credit_memos/{credit_memo_id}"},{"label":"Delete a credit memo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/deletecreditmemo","routeSlug":"/other-api/quickstart-api/credit-memos/deletecreditmemo","metadata":{"seo":{"title":"Delete a credit memo","description":"Permanently deletes a credit memo. This operation cannot be undone once it is performed."}},"httpPath":"/credit_memos/{credit_memo_id}"},{"label":"List credit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/getcreditmemos","routeSlug":"/other-api/quickstart-api/credit-memos/getcreditmemos","metadata":{"seo":{"title":"List credit memos","description":"Returns a dictionary with a data property that contains an array of credit memos, starting after cursor. Each entry in the array is a separate credit memo object. If no more credit memos are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/credit_memos"},{"label":"Create a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/createcreditmemo","routeSlug":"/other-api/quickstart-api/credit-memos/createcreditmemo","metadata":{"seo":{"title":"Create a credit memo","description":"Creates a new credit memo."}},"httpPath":"/credit_memos"},{"label":"List credit memo items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/getcreditmemoitems","routeSlug":"/other-api/quickstart-api/credit-memos/getcreditmemoitems","metadata":{"seo":{"title":"List credit memo items","description":"Retrieves information about all items of credit memos. A credit memo item is a single line item in a credit memo."}},"httpPath":"/credit_memo_items"},{"label":"Apply a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/applycreditmemo","routeSlug":"/other-api/quickstart-api/credit-memos/applycreditmemo","metadata":{"seo":{"title":"Apply a credit memo","description":"Apply a credit memo to one or more other billing documents."}},"httpPath":"/credit_memos/{credit_memo_id}/apply"},{"label":"Unapply a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/unapplycreditmemo","routeSlug":"/other-api/quickstart-api/credit-memos/unapplycreditmemo","metadata":{"seo":{"title":"Unapply a credit memo","description":"Unapply an applied credit memo."}},"httpPath":"/credit_memos/{credit_memo_id}/unapply"},{"label":"Unpost a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/unpostcreditmemo","routeSlug":"/other-api/quickstart-api/credit-memos/unpostcreditmemo","metadata":{"seo":{"title":"Unpost a credit memo","description":"Unposts an open credit memo that has not been applied, and changes its state to draft."}},"httpPath":"/credit_memos/{credit_memo_id}/unpost"},{"label":"Post a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/postcreditmemo","routeSlug":"/other-api/quickstart-api/credit-memos/postcreditmemo","metadata":{"seo":{"title":"Post a credit memo","description":"Opens a draft credit memo."}},"httpPath":"/credit_memos/{credit_memo_id}/post"},{"label":"Cancel a credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/credit-memos/cancelcreditmemo","routeSlug":"/other-api/quickstart-api/credit-memos/cancelcreditmemo","metadata":{"seo":{"title":"Cancel a credit memo","description":"Cancels a credit memo. Only credit memos with the Draft status can be cancelled."}},"httpPath":"/credit_memos/{credit_memo_id}/cancel"}]},{"type":"group","label":"Debit Memos","link":"/other-api/quickstart-api/debit-memos","routeSlug":"/other-api/quickstart-api/debit-memos","items":[{"label":"Retrieve a debit memo","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/debit-memos/getdebitmemo","routeSlug":"/other-api/quickstart-api/debit-memos/getdebitmemo","metadata":{"seo":{"title":"Retrieve a debit memo","description":"Retrieves the debit memo with the given ID."}},"httpPath":"/debit_memos/{debit_memo_id}"},{"label":"Update a debit memo","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/debit-memos/patchdebitmemo","routeSlug":"/other-api/quickstart-api/debit-memos/patchdebitmemo","metadata":{"seo":{"title":"Update a debit memo","description":"Updates a debit memo by setting the values of the specified fields. Any fields not provided in the request remain unchanged."}},"httpPath":"/debit_memos/{debit_memo_id}"},{"label":"Delete a debit memo","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/debit-memos/deletedebitmemo","routeSlug":"/other-api/quickstart-api/debit-memos/deletedebitmemo","metadata":{"seo":{"title":"Delete a debit memo","description":"Permanently deletes a debit memo. This operation cannot be undone once it is performed."}},"httpPath":"/debit_memos/{debit_memo_id}"},{"label":"List debit memos","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/debit-memos/getdebitmemoes","routeSlug":"/other-api/quickstart-api/debit-memos/getdebitmemoes","metadata":{"seo":{"title":"List debit memos","description":"Returns a dictionary with a data property that contains an array of debit memoes, starting after cursor. Each entry in the array is a separate invoice object. If no more invoices are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/debit_memos"},{"label":"Create a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/debit-memos/createdebitmemo","routeSlug":"/other-api/quickstart-api/debit-memos/createdebitmemo","metadata":{"seo":{"title":"Create a debit memo","description":"Creates debit memo"}},"httpPath":"/debit_memos"},{"label":"Cancel a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/debit-memos/canceldebitmemo","routeSlug":"/other-api/quickstart-api/debit-memos/canceldebitmemo","metadata":{"seo":{"title":"Cancel a debit memo","description":"Cancels a debit memo. Only the debit memos with the draft status can be canceled."}},"httpPath":"/debit_memos/{debit_memo_id}/cancel"},{"label":"List debit memo items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/debit-memos/getdebitmemoitems","routeSlug":"/other-api/quickstart-api/debit-memos/getdebitmemoitems","metadata":{"seo":{"title":"List debit memo items","description":"Lists item information on all or a subset of debit memos."}},"httpPath":"/debit_memo_items"},{"label":"Post a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/debit-memos/postsdebitmemo","routeSlug":"/other-api/quickstart-api/debit-memos/postsdebitmemo","metadata":{"seo":{"title":"Post a debit memo","description":"Opens a draft debit memo."}},"httpPath":"/debit_memos/{debit_memo_id}/post"},{"label":"Unpost a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/debit-memos/unpostsdebitmemo","routeSlug":"/other-api/quickstart-api/debit-memos/unpostsdebitmemo","metadata":{"seo":{"title":"Unpost a debit memo","description":"Unposts an open debit memo that has not been applied or refunded, and changes its state to draft."}},"httpPath":"/debit_memos/{debit_memo_id}/unpost"},{"label":"Pay a debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/debit-memos/paydebitmemo","routeSlug":"/other-api/quickstart-api/debit-memos/paydebitmemo","metadata":{"seo":{"title":"Pay a debit memo","description":"Pays a debit memo using an existing payment method."}},"httpPath":"/debit_memos/{debit_memo_id}/pay"}]},{"type":"separator","label":"BILL RUNS"},{"type":"group","label":"Bill Runs","link":"/other-api/quickstart-api/bill-runs","routeSlug":"/other-api/quickstart-api/bill-runs","items":[{"label":"Retrieve a bill run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/bill-runs/getbillrun","routeSlug":"/other-api/quickstart-api/bill-runs/getbillrun","metadata":{"seo":{"title":"Retrieve a bill run","description":"Retrieves the bill run information with the given ID."}},"httpPath":"/bill_runs/{bill_run_id}"},{"label":"Delete a bill run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/bill-runs/deletebillrun","routeSlug":"/other-api/quickstart-api/bill-runs/deletebillrun","metadata":{"seo":{"title":"Delete a bill run","description":"Deletes a bill run. Only the bill runs with the canceled status can be deleted."}},"httpPath":"/bill_runs/{bill_run_id}"},{"label":"List bill runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/bill-runs/getbillruns","routeSlug":"/other-api/quickstart-api/bill-runs/getbillruns","metadata":{"seo":{"title":"List bill runs","description":"Returns an array of bill runs. Each entry in the array is a separate bill run object. If no more bill runs are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/bill_runs"},{"label":"Create a bill run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/bill-runs/createbillrun","routeSlug":"/other-api/quickstart-api/bill-runs/createbillrun","metadata":{"seo":{"title":"Create a bill run","description":"Creates a bill run on a single account, or a batch of customer accounts."}},"httpPath":"/bill_runs"},{"label":"Post a bill run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/bill-runs/postbillrun","routeSlug":"/other-api/quickstart-api/bill-runs/postbillrun","metadata":{"seo":{"title":"Post a bill run","description":"Posts a bill run. Only the bill runs with the completed status can be posted."}},"httpPath":"/bill_runs/{bill_run_id}/post"},{"label":"Cancel a bill run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/bill-runs/cancelbillrun","routeSlug":"/other-api/quickstart-api/bill-runs/cancelbillrun","metadata":{"seo":{"title":"Cancel a bill run","description":"Cancels a bill run. Only the bill run that has no posted invoices can be canceled."}},"httpPath":"/bill_runs/{bill_run_id}/cancel"}]},{"type":"group","label":"Bill Run Previews","link":"/other-api/quickstart-api/bill-run-previews","routeSlug":"/other-api/quickstart-api/bill-run-previews","items":[{"label":"Retrieve a bill run preview","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/bill-run-previews/getbillrunpreview","routeSlug":"/other-api/quickstart-api/bill-run-previews/getbillrunpreview","metadata":{"seo":{"title":"Retrieve a bill run preview","description":"Retrieves the bill run preview information with the given ID."}},"httpPath":"/bill_run_previews/{bill_run_preview_id}"},{"label":"Create a bill run preview","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/bill-run-previews/createbillrunpreview","routeSlug":"/other-api/quickstart-api/bill-run-previews/createbillrunpreview","metadata":{"seo":{"title":"Create a bill run preview","description":"Creates a bill run preview for a batch of customer accounts."}},"httpPath":"/bill_run_previews"}]},{"type":"separator","label":"TAX"},{"type":"group","label":"Taxation Items","link":"/other-api/quickstart-api/taxation-items","routeSlug":"/other-api/quickstart-api/taxation-items","items":[{"label":"List taxation items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/taxation-items/gettaxationitems","routeSlug":"/other-api/quickstart-api/taxation-items/gettaxationitems","metadata":{"seo":{"title":"List taxation items","description":"Returns an array of taxation items. Each entry in the array is a separate Taxation Item object. If no more taxation items are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/taxation_items"},{"label":"Create a taxation item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/taxation-items/createtaxationitem","routeSlug":"/other-api/quickstart-api/taxation-items/createtaxationitem","metadata":{"seo":{"title":"Create a taxation item","description":"Creates a taxation item."}},"httpPath":"/taxation_items"},{"label":"Retrieve a taxation item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/taxation-items/gettaxationitem","routeSlug":"/other-api/quickstart-api/taxation-items/gettaxationitem","metadata":{"seo":{"title":"Retrieve a taxation item","description":"Retrieves the taxation item with the given ID."}},"httpPath":"/taxation_items/{taxation_item_id}"},{"label":"Update a taxation item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/taxation-items/updatetaxationitem","routeSlug":"/other-api/quickstart-api/taxation-items/updatetaxationitem","metadata":{"seo":{"title":"Update a taxation item","description":"Updates a taxation item by setting the values of the specified fields. Any fields not provided in the request remain unchanged."}},"httpPath":"/taxation_items/{taxation_item_id}"},{"label":"Delete a taxation item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/taxation-items/deletetaxationitem","routeSlug":"/other-api/quickstart-api/taxation-items/deletetaxationitem","metadata":{"seo":{"title":"Delete a taxation item","description":"Permanently deletes a taxation item. This operation cannot be undone once it is performed."}},"httpPath":"/taxation_items/{taxation_item_id}"}]},{"type":"separator","label":"USAGE"},{"type":"group","label":"Usage Records","link":"/other-api/quickstart-api/usage-records","routeSlug":"/other-api/quickstart-api/usage-records","items":[{"label":"List usage records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/usage-records/getusagerecords","routeSlug":"/other-api/quickstart-api/usage-records/getusagerecords","metadata":{"seo":{"title":"List usage records","description":"Returns an array of usage records. Each entry in the array is a separate Usage object. If no more usages are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/usage_records"},{"label":"Create a usage record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/usage-records/createusage","routeSlug":"/other-api/quickstart-api/usage-records/createusage","metadata":{"seo":{"title":"Create a usage record","description":"Creates a new Usage object."}},"httpPath":"/usage_records"},{"label":"Retrieve a usage record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/usage-records/getusage","routeSlug":"/other-api/quickstart-api/usage-records/getusage","metadata":{"seo":{"title":"Retrieve a usage record","description":"Retrieves the usage with the given ID."}},"httpPath":"/usage_records/{id}"},{"label":"Update a usage record","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/usage-records/updateusage","routeSlug":"/other-api/quickstart-api/usage-records/updateusage","metadata":{"seo":{"title":"Update a usage record","description":"Updates the usage record. Any fields on the object not provided in the request are not changed."}},"httpPath":"/usage_records/{id}"},{"label":"Delete a usage record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/usage-records/deleteusage","routeSlug":"/other-api/quickstart-api/usage-records/deleteusage","metadata":{"seo":{"title":"Delete a usage record","description":"Permanently deletes a usage object. It cannot be undone."}},"httpPath":"/usage_records/{id}"}]},{"type":"separator","label":"PAYMENTS"},{"type":"group","label":"Payment Methods","link":"/other-api/quickstart-api/payment-methods","routeSlug":"/other-api/quickstart-api/payment-methods","items":[{"label":"List payment methods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-methods/getpaymentmethods","routeSlug":"/other-api/quickstart-api/payment-methods/getpaymentmethods","metadata":{"seo":{"title":"List payment methods","description":"Returns a dictionary with a data property that contains an array of payment methods, starting after the cursor, if used. Each entry in the array is a separate payment method object. If no more payment methods are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/payment_methods"},{"label":"Create a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-methods/createpaymentmethod","routeSlug":"/other-api/quickstart-api/payment-methods/createpaymentmethod","metadata":{"seo":{"title":"Create a payment method","description":"Creates a new payment method object. See Payment Pages 2.0 implementation overview to learn how to create payment methods through Hosted Payment Pages."}},"httpPath":"/payment_methods"},{"label":"Retrieve a payment method","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-methods/getpaymentmethodbyid","routeSlug":"/other-api/quickstart-api/payment-methods/getpaymentmethodbyid","metadata":{"seo":{"title":"Retrieve a payment method","description":"Retrieves the payment method with the given ID."}},"httpPath":"/payment_methods/{payment_method_id}"},{"label":"Update a payment method","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-methods/updatepaymentmethod","routeSlug":"/other-api/quickstart-api/payment-methods/updatepaymentmethod","metadata":{"seo":{"title":"Update a payment method","description":"Updates the specified payment method by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/payment_methods/{payment_method_id}"},{"label":"Delete a payment method","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-methods/deletepaymentmethod","routeSlug":"/other-api/quickstart-api/payment-methods/deletepaymentmethod","metadata":{"seo":{"title":"Delete a payment method","description":"Permanently deletes a payment method. It cannot be undone."}},"httpPath":"/payment_methods/{payment_method_id}"},{"label":"Verify a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-methods/verifypaymentmethod","routeSlug":"/other-api/quickstart-api/payment-methods/verifypaymentmethod","metadata":{"seo":{"title":"Verify a payment method","description":"Sends an authorization request to the corresponding payment gateway to verify the payment method. Supported payment methods are credit cards and Paypal."}},"httpPath":"/payment_methods/{payment_method_id}/verify"},{"label":"Create a payment authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-methods/authorizepaymentmethod","routeSlug":"/other-api/quickstart-api/payment-methods/authorizepaymentmethod","metadata":{"seo":{"title":"Create a payment authorization","description":"Verifies a payment method and block the amount of fund that will be used for payment."}},"httpPath":"/payment_methods/{payment_method_id}/authorize"},{"label":"Cancel a payment authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-methods/voidauthorizationpaymentmethod","routeSlug":"/other-api/quickstart-api/payment-methods/voidauthorizationpaymentmethod","metadata":{"seo":{"title":"Cancel a payment authorization","description":"Cancel or void the blocked fund from the specified payment method."}},"httpPath":"/payment_methods/{payment_method_id}/void_authorization"},{"label":"Scrub a payment method","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-methods/scrubpaymentmethod","routeSlug":"/other-api/quickstart-api/payment-methods/scrubpaymentmethod","metadata":{"seo":{"title":"Scrub a payment method","description":"Scrubs sensitive data such as card number on the specified payment method."}},"httpPath":"/payment_methods/{payment_method_id}/scrub"}]},{"type":"group","label":"Payments","link":"/other-api/quickstart-api/payments","routeSlug":"/other-api/quickstart-api/payments","items":[{"label":"Retrieve a payment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payments/getpayment","routeSlug":"/other-api/quickstart-api/payments/getpayment","metadata":{"seo":{"title":"Retrieve a payment","description":"Retrieves the payment with the given ID."}},"httpPath":"/payments/{payment_id}"},{"label":"Update a payment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payments/updatepayment","routeSlug":"/other-api/quickstart-api/payments/updatepayment","metadata":{"seo":{"title":"Update a payment","description":"Updates the specified payment by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/payments/{payment_id}"},{"label":"List payments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payments/getpayments","routeSlug":"/other-api/quickstart-api/payments/getpayments","metadata":{"seo":{"title":"List payments","description":"Returns a dictionary with a data property that contains an array of payments, starting after the cursor, if used. Each entry in the array is a separate payment object. If no more payments are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/payments"},{"label":"Create a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payments/createpayment","routeSlug":"/other-api/quickstart-api/payments/createpayment","metadata":{"seo":{"title":"Create a payment","description":"Creates a new payment object."}},"httpPath":"/payments"},{"label":"Cancel a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payments/cancelpayment","routeSlug":"/other-api/quickstart-api/payments/cancelpayment","metadata":{"seo":{"title":"Cancel a payment","description":"Cancels an unapplied payment."}},"httpPath":"/payments/{payment_id}/cancel"},{"label":"Apply a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payments/applypayment","routeSlug":"/other-api/quickstart-api/payments/applypayment","metadata":{"seo":{"title":"Apply a payment","description":"Applies a payment to one or more invoices or debit memos."}},"httpPath":"/payments/{payment_id}/apply"},{"label":"Unapply a payment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payments/unapplypayment","routeSlug":"/other-api/quickstart-api/payments/unapplypayment","metadata":{"seo":{"title":"Unapply a payment","description":"Unapplies an applied payment."}},"httpPath":"/payments/{payment_id}/unapply"}]},{"type":"group","label":"Payment Runs","link":"/other-api/quickstart-api/payment-runs","routeSlug":"/other-api/quickstart-api/payment-runs","items":[{"label":"List payment runs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-runs/getpaymentruns","routeSlug":"/other-api/quickstart-api/payment-runs/getpaymentruns","metadata":{"seo":{"title":"List payment runs","description":"Returns an array of payment runs. Each entry in the array is a separate payment run object. If no more payment runs are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/payment_runs"},{"label":"Create a payment run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-runs/createpaymentruns","routeSlug":"/other-api/quickstart-api/payment-runs/createpaymentruns","metadata":{"seo":{"title":"Create a payment run","description":"Creates a payment run."}},"httpPath":"/payment_runs"},{"label":"Retrieve a payment run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-runs/getpaymentrun","routeSlug":"/other-api/quickstart-api/payment-runs/getpaymentrun","metadata":{"seo":{"title":"Retrieve a payment run","description":"Retrieves the payment run information with the given ID."}},"httpPath":"/payment_runs/{payment_run_id}"},{"label":"Update a payment run","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-runs/updatepaymentruns","routeSlug":"/other-api/quickstart-api/payment-runs/updatepaymentruns","metadata":{"seo":{"title":"Update a payment run","description":"Updates a payment run by setting the values of the specified fields. Any fields not provided in the request remain unchanged."}},"httpPath":"/payment_runs/{payment_run_id}"},{"label":"Delete a payment run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-runs/deletepaymentruns","routeSlug":"/other-api/quickstart-api/payment-runs/deletepaymentruns","metadata":{"seo":{"title":"Delete a payment run","description":"Deletes a payment run. Only the payment runs with the canceled or pending status can be deleted."}},"httpPath":"/payment_runs/{payment_run_id}"}]},{"type":"group","label":"Payment Schedules","link":"/other-api/quickstart-api/payment-schedules","routeSlug":"/other-api/quickstart-api/payment-schedules","items":[{"label":"Retrieve a payment schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-schedules/getpaymentschedule","routeSlug":"/other-api/quickstart-api/payment-schedules/getpaymentschedule","metadata":{"seo":{"title":"Retrieve a payment schedule","description":"Retrieves the payment schedule with the given ID."}},"httpPath":"/payment_schedules/{payment_schedule_id}"},{"label":"Update a payment schedule","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-schedules/updatepaymentschedule","routeSlug":"/other-api/quickstart-api/payment-schedules/updatepaymentschedule","metadata":{"seo":{"title":"Update a payment schedule","description":"Updates the specified payment schedule by setting the values of the parameters passed. Any parameters not provided will remain unchanged."}},"httpPath":"/payment_schedules/{payment_schedule_id}"},{"label":"Create a payment schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-schedules/createpaymentschedule","routeSlug":"/other-api/quickstart-api/payment-schedules/createpaymentschedule","metadata":{"seo":{"title":"Create a payment schedule","description":"Creates a new Payment Schedule object."}},"httpPath":"/payment_schedules"},{"label":"Cancel a payment schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-schedules/cancelpaymentschedule","routeSlug":"/other-api/quickstart-api/payment-schedules/cancelpaymentschedule","metadata":{"seo":{"title":"Cancel a payment schedule","description":"Cancels the payment schedule with the given ID."}},"httpPath":"/payment_schedules/{payment_schedule_id}/cancel"}]},{"type":"group","label":"Payment Schedule Items","link":"/other-api/quickstart-api/payment-schedule-items","routeSlug":"/other-api/quickstart-api/payment-schedule-items","items":[{"label":"Retrieve a payment schedule item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-schedule-items/getpaymentscheduleitem","routeSlug":"/other-api/quickstart-api/payment-schedule-items/getpaymentscheduleitem","metadata":{"seo":{"title":"Retrieve a payment schedule item","description":"Retrieves the payment schedule item with the given ID."}},"httpPath":"/payment_schedule_items/{payment_schedule_item_id}"},{"label":"Update a payment schedule item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-schedule-items/updatepaymentscheduleitem","routeSlug":"/other-api/quickstart-api/payment-schedule-items/updatepaymentscheduleitem","metadata":{"seo":{"title":"Update a payment schedule item","description":"Updates the specified payment schedule item by setting the values of the parameters passed. Any parameters not provided will remain unchanged."}},"httpPath":"/payment_schedule_items/{payment_schedule_item_id}"},{"label":"Create a payment schedule item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-schedule-items/createpaymentscheduleitem","routeSlug":"/other-api/quickstart-api/payment-schedule-items/createpaymentscheduleitem","metadata":{"seo":{"title":"Create a payment schedule item","description":"Creates a new Payment Schedule Item object."}},"httpPath":"/payment_schedule_items"},{"label":"Cancel a payment schedule item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-schedule-items/cancelpaymentscheduleitem","routeSlug":"/other-api/quickstart-api/payment-schedule-items/cancelpaymentscheduleitem","metadata":{"seo":{"title":"Cancel a payment schedule item","description":"Cancels the payment schedule item with the given ID."}},"httpPath":"/payment_schedule_items/{payment_schedule_item_id}/cancel"},{"label":"Retry a payment shedule item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-schedule-items/retrypaymentscheduleitem","routeSlug":"/other-api/quickstart-api/payment-schedule-items/retrypaymentscheduleitem","metadata":{"seo":{"title":"Retry a payment shedule item","description":"Retries the payment schedule item with the given ID."}},"httpPath":"/payment_schedule_items/{payment_schedule_item_id}/retry"},{"label":"Skip a payment schedule item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/payment-schedule-items/skippaymentscheduleitem","routeSlug":"/other-api/quickstart-api/payment-schedule-items/skippaymentscheduleitem","metadata":{"seo":{"title":"Skip a payment schedule item","description":"Skips the payment schedule item with the given ID."}},"httpPath":"/payment_schedule_items/{payment_schedule_item_id}/skip"}]},{"type":"group","label":"Refunds","link":"/other-api/quickstart-api/refunds","routeSlug":"/other-api/quickstart-api/refunds","items":[{"label":"List refunds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/refunds/getrefunds","routeSlug":"/other-api/quickstart-api/refunds/getrefunds","metadata":{"seo":{"title":"List refunds","description":"Returns a dictionary with a data property that contains an array of refunds, starting after cursor. Each entry in the array is a separate object. If no more are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/refunds"},{"label":"Create a refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/refunds/createrefund","routeSlug":"/other-api/quickstart-api/refunds/createrefund","metadata":{"seo":{"title":"Create a refund","description":"Creates a new refund object."}},"httpPath":"/refunds"},{"label":"Retrieve a refund","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/refunds/getrefund","routeSlug":"/other-api/quickstart-api/refunds/getrefund","metadata":{"seo":{"title":"Retrieve a refund","description":"Retrieves the refund with the given ID."}},"httpPath":"/refunds/{refund_id}"},{"label":"Update a refund","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/refunds/updaterefund","routeSlug":"/other-api/quickstart-api/refunds/updaterefund","metadata":{"seo":{"title":"Update a refund","description":"Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/refunds/{refund_id}"},{"label":"Delete a refund","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/refunds/deleterefund","routeSlug":"/other-api/quickstart-api/refunds/deleterefund","metadata":{"seo":{"title":"Delete a refund","description":"Permanently deletes a refund. Note that once you have deleted a refund, it cannot be undone."}},"httpPath":"/refunds/{refund_id}"},{"label":"Cancel a refund","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/refunds/cancelrefund","routeSlug":"/other-api/quickstart-api/refunds/cancelrefund","metadata":{"seo":{"title":"Cancel a refund","description":"Cancels an unapplied refund."}},"httpPath":"/refunds/{refund_id}/cancel"}]},{"type":"separator","label":"PLATFORM"},{"type":"group","label":"Custom Objects","link":"/other-api/quickstart-api/custom-objects","routeSlug":"/other-api/quickstart-api/custom-objects","items":[{"label":"List custom objects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/custom-objects/getcustomobjects","routeSlug":"/other-api/quickstart-api/custom-objects/getcustomobjects","metadata":{"seo":{"title":"List custom objects","description":"Returns a list of your custom objects."}},"httpPath":"/custom_objects/{custom_object_type}"},{"label":"Create a custom object","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/custom-objects/createcustomobject","routeSlug":"/other-api/quickstart-api/custom-objects/createcustomobject","metadata":{"seo":{"title":"Create a custom object","description":"Creates a new custom object."}},"httpPath":"/custom_objects/{custom_object_type}"},{"label":"Retrieve a custom object","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/custom-objects/getcustomobject","routeSlug":"/other-api/quickstart-api/custom-objects/getcustomobject","metadata":{"seo":{"title":"Retrieve a custom object","description":"Retrieves the custom object with the given ID."}},"httpPath":"/custom_objects/{custom_object_type}/{custom_object_id}"},{"label":"Update a custom object","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/custom-objects/updatecustomobject","routeSlug":"/other-api/quickstart-api/custom-objects/updatecustomobject","metadata":{"seo":{"title":"Update a custom object","description":"Updates the specified custom object by setting the values of the parameters passed. Any parameters not provided will be left unchanged."}},"httpPath":"/custom_objects/{custom_object_type}/{custom_object_id}"},{"label":"Delete a custom object","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/custom-objects/deletecustomobject","routeSlug":"/other-api/quickstart-api/custom-objects/deletecustomobject","metadata":{"seo":{"title":"Delete a custom object","description":"Permanently deletes a custom object. It cannot be undone."}},"httpPath":"/custom_objects/{custom_object_type}/{custom_object_id}"}]},{"type":"group","label":"Query Runs","link":"/other-api/quickstart-api/query-runs","routeSlug":"/other-api/quickstart-api/query-runs","items":[{"label":"Retrieve a query run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/query-runs/getqueryrun","routeSlug":"/other-api/quickstart-api/query-runs/getqueryrun","metadata":{"seo":{"title":"Retrieve a query run","description":"Retrieves the query run with the given ID."}},"httpPath":"/query_runs/{query_run_id}"},{"label":"Create a query run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/query-runs/createqueryrun","routeSlug":"/other-api/quickstart-api/query-runs/createqueryrun","metadata":{"seo":{"title":"Create a query run","description":"Creates a new query run job."}},"httpPath":"/query_runs"},{"label":"Cancel a query run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/query-runs/cancelqueryrun","routeSlug":"/other-api/quickstart-api/query-runs/cancelqueryrun","metadata":{"seo":{"title":"Cancel a query run","description":"Cancels a query run. This operation is only applicable if the state of the query run is accepted or in_progress."}},"httpPath":"/query_runs/{query_run_id}/cancel"}]},{"type":"group","label":"Workflows","link":"/other-api/quickstart-api/workflows","routeSlug":"/other-api/quickstart-api/workflows","items":[{"label":"Run a workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/workflows/runworkflow","routeSlug":"/other-api/quickstart-api/workflows/runworkflow","metadata":{"seo":{"title":"Run a workflow","description":"Run a specified workflow. In the request body, you can include parameters that you want to pass to the workflow. For the parameters to be recognized and picked up by tasks in the workflow, you need to define the parameters first."}},"httpPath":"/workflows/{workflow_id}/run"}]},{"type":"separator","label":"DEPRECATED"},{"type":"group","label":"Billing Documents","link":"/other-api/quickstart-api/billing-documents","routeSlug":"/other-api/quickstart-api/billing-documents","items":[{"label":"Retrieve a billing document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/billing-documents/getbillingdocument","routeSlug":"/other-api/quickstart-api/billing-documents/getbillingdocument","metadata":{"seo":{"title":"Retrieve a billing document","description":"Retrieves the billing document with the given ID."}},"httpPath":"/billing_documents/{billing_document_id}"},{"label":"List billing documents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/billing-documents/getbillingdocuments","routeSlug":"/other-api/quickstart-api/billing-documents/getbillingdocuments","metadata":{"seo":{"title":"List billing documents","description":"Returns a dictionary with a data property that contains an array of billing documents, starting after cursor. Each entry in the array is a separate billing document object. If no more billing documents are available, the resulting array will be empty. This request should never return an error."}},"httpPath":"/billing_documents"},{"label":"Create a billing document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/billing-documents/postbillingdocument","routeSlug":"/other-api/quickstart-api/billing-documents/postbillingdocument","metadata":{"seo":{"title":"Create a billing document","description":"Creates different types of billing document objects, including invoices, credit memos, and debit memos."}},"httpPath":"/billing_documents"}]},{"type":"group","label":"Billing Document Items","link":"/other-api/quickstart-api/billing-document-items","routeSlug":"/other-api/quickstart-api/billing-document-items","items":[{"label":"List billing document items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/quickstart-api/billing-document-items/getbillingdocumentitems","routeSlug":"/other-api/quickstart-api/billing-document-items/getbillingdocumentitems","metadata":{"seo":{"title":"List billing document items","description":"List billing document items"}},"httpPath":"/billing_document_items"}]}]},{"type":"separator","label":"REVENUE"},{"type":"link","fsPath":"other-api/revenue-api-authentication.md","metadata":{"type":"markdown"},"label":"Revenue API Authentication","link":"/other-api/revenue-api-authentication","routeSlug":"/other-api/revenue-api-authentication"},{"type":"link","fsPath":"docs/get-started/changelogs/revenue-api-changelog.md","metadata":{"type":"markdown"},"label":"Changelog","link":"/docs/get-started/changelogs/revenue-api-changelog","routeSlug":"/docs/get-started/changelogs/revenue-api-changelog"},{"type":"group","label":"Revenue API","items":[{"type":"link","label":"Revenue API Reference","link":"/other-api/revenue-api-3.0","routeSlug":"/other-api/revenue-api-3.0"},{"type":"group","label":"Introduction","link":"/other-api/revenue-api-3.0/section/introduction","routeSlug":"/other-api/revenue-api-3.0/section/introduction","items":[{"type":"link","label":"Endpoints","link":"/other-api/revenue-api-3.0/section/introduction/endpoints","routeSlug":"/other-api/revenue-api-3.0/section/introduction/endpoints"},{"type":"link","label":"Requirements","link":"/other-api/revenue-api-3.0/section/introduction/requirements","routeSlug":"/other-api/revenue-api-3.0/section/introduction/requirements"},{"type":"link","label":"Requests and Responses","link":"/other-api/revenue-api-3.0/section/introduction/requests-and-responses","routeSlug":"/other-api/revenue-api-3.0/section/introduction/requests-and-responses"},{"type":"link","label":"Inbound Data Error","link":"/other-api/revenue-api-3.0/section/introduction/inbound-data-error","routeSlug":"/other-api/revenue-api-3.0/section/introduction/inbound-data-error"}]},{"type":"separator","label":"Authentication"},{"type":"group","label":"Authentication","link":"/other-api/revenue-api-3.0/authentication","routeSlug":"/other-api/revenue-api-3.0/authentication","items":[{"label":"Create authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/authentication/post_authenticate","routeSlug":"/other-api/revenue-api-3.0/authentication/post_authenticate","metadata":{"seo":{"title":"Create authentication","description":"Authenticates and gets the Json Web Token to push and pull data from your Zuora Revenue instance."}},"httpPath":"/api/integration/v1/authenticate"}]},{"type":"separator","label":"Data Ingestion File Uploads"},{"type":"group","label":"Adapter","link":"/other-api/revenue-api-3.0/adapter","routeSlug":"/other-api/revenue-api-3.0/adapter","items":[{"label":"List upload field mappings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/adapter/get_fileuploadmapping","routeSlug":"/other-api/revenue-api-3.0/adapter/get_fileuploadmapping","metadata":{"seo":{"title":"List upload field mappings","description":"Gets the field mapping information in the upload template definitions for transactions, events, or bundle configuration from Zuora Revenue."}},"httpPath":"/api/integration/v1/upload/mapping"}]},{"type":"group","label":"File Upload","link":"/other-api/revenue-api-3.0/file-upload","routeSlug":"/other-api/revenue-api-3.0/file-upload","items":[{"label":"Retrieve the file upload status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/file-upload/get_fileuploadstatus","routeSlug":"/other-api/revenue-api-3.0/file-upload/get_fileuploadstatus","metadata":{"seo":{"title":"Retrieve the file upload status","description":"Gets the status information about the specified file upload request."}},"httpPath":"/api/integration/v1/fileupload/status/{file_request_id}"},{"label":"Upload file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/file-upload/post_uploadfile","routeSlug":"/other-api/revenue-api-3.0/file-upload/post_uploadfile","metadata":{"seo":{"title":"Upload file","description":"Upload the event or transaction data in a CSV file to Zuora Revenue in UTF-8."}},"httpPath":"/api/integration/v1/upload/file"}]},{"type":"group","label":"Inbound","link":"/other-api/revenue-api-3.0/inbound","routeSlug":"/other-api/revenue-api-3.0/inbound","items":[{"label":"Retrieve the upload status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/inbound/get_uploadstatus","routeSlug":"/other-api/revenue-api-3.0/inbound/get_uploadstatus","metadata":{"seo":{"title":"Retrieve the upload status","description":"Gets the status information about the Create upload operation."}},"httpPath":"/api/integration/v1/csv/upload/status"},{"label":"Create upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/inbound/post_upload","routeSlug":"/other-api/revenue-api-3.0/inbound/post_upload","metadata":{"seo":{"title":"Create upload","description":"Uploads the transaction, events, or bundle configuration data as a CSV (text/plain) file with UTF-8 encoding."}},"httpPath":"/api/integration/v1/csv/upload"}]},{"type":"separator","label":"Staging Errors"},{"type":"group","label":"Stage Error","link":"/other-api/revenue-api-3.0/stage-error","routeSlug":"/other-api/revenue-api-3.0/stage-error","items":[{"label":"List staging errors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/stage-error/get_staggingerror","routeSlug":"/other-api/revenue-api-3.0/stage-error/get_staggingerror","metadata":{"seo":{"title":"List staging errors","description":"Gets the information about transaction staging errors or event staging errors."}},"httpPath":"/api/integration/v1/stage/error/{errortype}"}]},{"type":"separator","label":"Revenue Transfer Accounting"},{"type":"group","label":"Transfer Accounting","link":"/other-api/revenue-api-3.0/transfer-accounting","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting","items":[{"label":"Update transfer batch status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/transfer-accounting/put_transferbatchstatus","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting/put_transferbatchstatus","metadata":{"seo":{"title":"Update transfer batch status","description":"Updates the transfer batch status to Transferred in Zuora Revenue."}},"httpPath":"/api/integration/v1/journal/batch/status/{batch_id}"},{"label":"Retrieve a transfer batch","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/transfer-accounting/get_transferbatch","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting/get_transferbatch","metadata":{"seo":{"title":"Retrieve a transfer batch","description":"Downloads the general ledger (GL) transfer batch data for the specified batch ID and page number.For more information, see Best practice for using Revenue APIs."}},"httpPath":"/api/integration/v1/journal/batch/{batchid}/{pagenum}"},{"label":"List transfer batches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/transfer-accounting/get_transferbatchlist","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting/get_transferbatchlist","metadata":{"seo":{"title":"List transfer batches","description":"Gets a list of the transfer accounting batches that are available in Zuora Revenue."}},"httpPath":"/api/integration/v1/journal/list"}]},{"type":"group","label":"Transfer Accounting Files","link":"/other-api/revenue-api-3.0/transfer-accounting-files","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting-files","items":[{"label":"Download a transfer batch file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/transfer-accounting-files/get_transferbatchfile","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting-files/get_transferbatchfile","metadata":{"seo":{"title":"Download a transfer batch file","description":"Downloads the GL transfer batch files from Zuora Revenue for the specified batch ID."}},"httpPath":"/api/integration/v1/download/transferbatchfile/{batch_id}"}]},{"type":"separator","label":"Revenue Jobs and Programs"},{"type":"group","label":"Revenue Jobs","link":"/other-api/revenue-api-3.0/revenue-jobs","routeSlug":"/other-api/revenue-api-3.0/revenue-jobs","items":[{"label":"List available programs and program parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-jobs/get_programdetails","routeSlug":"/other-api/revenue-api-3.0/revenue-jobs/get_programdetails","metadata":{"seo":{"title":"List available programs and program parameters","description":"Retrieves a list of programs that can be started with Revenue APIs and the program parameters that you can specify."}},"httpPath":"/api/integration/v1/programs"},{"label":"List available organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-jobs/get_revenueorgdetails","routeSlug":"/other-api/revenue-api-3.0/revenue-jobs/get_revenueorgdetails","metadata":{"seo":{"title":"List available organizations","description":"Retrieves the list of organizations that are set up in Zuora Revenue."}},"httpPath":"/api/integration/v1/revenue-orgs"},{"label":"Submit a program with specified parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-jobs/post_submitrevenuejob","routeSlug":"/other-api/revenue-api-3.0/revenue-jobs/post_submitrevenuejob","metadata":{"seo":{"title":"Submit a program with specified parameters","description":"Submits a program in Zuora Revenue and returns the job ID."}},"httpPath":"/api/integration/v1/{orgId}/programs/{programId}/submit"},{"label":"Retrieve the job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-jobs/get_revenuejobstatus","routeSlug":"/other-api/revenue-api-3.0/revenue-jobs/get_revenuejobstatus","metadata":{"seo":{"title":"Retrieve the job status","description":"Retrieves the status of a submitted job in Zuora Revenue."}},"httpPath":"/api/integration/v1/{orgId}/jobs/{jobId}"}]},{"type":"group","label":"Data Collection","link":"/other-api/revenue-api-3.0/data-collection","routeSlug":"/other-api/revenue-api-3.0/data-collection","items":[{"label":"Submit data collection job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/data-collection/post_collection","routeSlug":"/other-api/revenue-api-3.0/data-collection/post_collection","metadata":{"seo":{"title":"Submit data collection job","description":"Submit a data collection job based on the specified RC template."}},"httpPath":"/api/integration/v1/job/collection/template"},{"label":"Retrieve data collection job details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/data-collection/get_collectiondetails","routeSlug":"/other-api/revenue-api-3.0/data-collection/get_collectiondetails","metadata":{"seo":{"title":"Retrieve data collection job details","description":"Get the status of the data collection job."}},"httpPath":"/api/integration/v1/job/collection/template/{job_id}"}]},{"type":"separator","label":"Revenue Reporting"},{"type":"group","label":"Report Catalog","link":"/other-api/revenue-api-3.0/report-catalog","routeSlug":"/other-api/revenue-api-3.0/report-catalog","items":[{"label":"List reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/listreports","routeSlug":"/other-api/revenue-api-3.0/report-catalog/listreports","metadata":{"seo":{"title":"List reports","description":"Returns the report definitions in your tenant's report catalog, sorted by report name. Each item identifies a report and describes what it contains. This operation does not run a report and returns no report data."}},"httpPath":"/revenue/services/v1/reports"},{"label":"Retrieve a report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/getreport","routeSlug":"/other-api/revenue-api-3.0/report-catalog/getreport","metadata":{"seo":{"title":"Retrieve a report","description":"Returns one report definition by its identifier."}},"httpPath":"/revenue/services/v1/reports/{reportId}"},{"label":"List layouts of a report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/listreportlayouts","routeSlug":"/other-api/revenue-api-3.0/report-catalog/listreportlayouts","metadata":{"seo":{"title":"List layouts of a report","description":"Returns every layout of a report, sorted by layout name. Each layout includes its output columns (fields) and its filters with default values, required flags and allowed values."}},"httpPath":"/revenue/services/v1/reports/{reportId}/layouts"},{"label":"Retrieve a report layout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/getreportlayout","routeSlug":"/other-api/revenue-api-3.0/report-catalog/getreportlayout","metadata":{"seo":{"title":"Retrieve a report layout","description":"Returns one layout of a report, including its output columns and filters."}},"httpPath":"/revenue/services/v1/reports/{reportId}/layouts/{layoutId}"},{"label":"List the columns of a layout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/listreportlayoutfields","routeSlug":"/other-api/revenue-api-3.0/report-catalog/listreportlayoutfields","metadata":{"seo":{"title":"List the columns of a layout","description":"Returns only the output columns of a layout, in output order."}},"httpPath":"/revenue/services/v1/reports/{reportId}/layouts/{layoutId}/fields"},{"label":"Retrieve report metadata by ID or name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/getreportmetadata","routeSlug":"/other-api/revenue-api-3.0/report-catalog/getreportmetadata","metadata":{"seo":{"title":"Retrieve report metadata by ID or name","description":"Returns a report's identity, whether it is a standard or custom report, every field it can output, and its layouts with the default layout flagged."}},"httpPath":"/revenue/services/v1/reports/{reportIdentifier}/metadata"}]},{"type":"group","label":"Report Runs","link":"/other-api/revenue-api-3.0/report-runs","routeSlug":"/other-api/revenue-api-3.0/report-runs","items":[{"label":"Run a report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-runs/runreport","routeSlug":"/other-api/revenue-api-3.0/report-runs/runreport","metadata":{"seo":{"title":"Run a report","description":"Submits a report layout for background execution and returns the new run. A 200 response means the run was accepted, not that the file is ready. Poll Get a report run until status is Available, then call Get a download URL."}},"httpPath":"/revenue/services/v1/reports/{reportId}/run"},{"label":"Retrieve a report run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-runs/getreportrun","routeSlug":"/other-api/revenue-api-3.0/report-runs/getreportrun","metadata":{"seo":{"title":"Retrieve a report run","description":"Returns the current state of one report run."}},"httpPath":"/revenue/services/v1/reports/run/{submissionId}"},{"label":"Retrieve the latest finished report run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-runs/getlatestreportrun","routeSlug":"/other-api/revenue-api-3.0/report-runs/getlatestreportrun","metadata":{"seo":{"title":"Retrieve the latest finished report run","description":"Returns the most recent report run in the tenant, across all reports, that has reached a final status (Available, Error, Terminated or Cancelled)."}},"httpPath":"/revenue/services/v1/reports/run/latest"},{"label":"Retrieve a download URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-runs/getreportrundownloadurl","routeSlug":"/other-api/revenue-api-3.0/report-runs/getreportrundownloadurl","metadata":{"seo":{"title":"Retrieve a download URL","description":"Returns a pre-signed HTTPS URL for the output file of an Available run. The URL is valid for 30 minutes. Download the file with a plain HTTP GET on that URL, without an Authorization header."}},"httpPath":"/revenue/services/v1/reports/run/{submissionId}/download"}]},{"type":"group","label":"Report Files","link":"/other-api/revenue-api-3.0/report-files","routeSlug":"/other-api/revenue-api-3.0/report-files","items":[{"label":"List report files by date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/listreportfilesbydate","routeSlug":"/other-api/revenue-api-3.0/report-files/listreportfilesbydate","metadata":{"seo":{"title":"List report files by date","description":"Returns the Available report files created on one calendar day, limited to the organizations your role can access. Runs that are still in progress or failed are not returned."}},"httpPath":"/api/integration/v1/reports/list"},{"label":"Retrieve a report file by submission ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/getreportfile","routeSlug":"/other-api/revenue-api-3.0/report-files/getreportfile","metadata":{"seo":{"title":"Retrieve a report file by submission ID","description":"Returns the report file of one run when that run is Available and belongs to an organization your role can access."}},"httpPath":"/api/integration/v1/reports/{report_id}"},{"label":"List recent report files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/listrecentreportfiles","routeSlug":"/other-api/revenue-api-3.0/report-files/listrecentreportfiles","metadata":{"seo":{"title":"List recent report files","description":"Returns up to number_of_records Available report files, sorted by creation time with the newest first."}},"httpPath":"/api/integration/v1/reports/recent-n/{number_of_records}"},{"label":"Download a report file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/downloadreportfile","routeSlug":"/other-api/revenue-api-3.0/report-files/downloadreportfile","metadata":{"seo":{"title":"Download a report file","description":"Streams the bytes of a report file stored in your tenant's Revenue file store. Supports .csv and .zip files."}},"httpPath":"/api/integration/v1/reports/download/{filename}"},{"label":"Retrieve a signed URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/getreportsignedurl","routeSlug":"/other-api/revenue-api-3.0/report-files/getreportsignedurl","metadata":{"seo":{"title":"Retrieve a signed URL","description":"Returns a signed HTTPS URL, valid for 30 minutes, for the file of an Available run stored in cloud storage. Download the file with a plain HTTP GET on the URL. GET and POST behave the same; POST takes no body."}},"httpPath":"/api/integration/v2/reports/signedurl/{report_id}"},{"label":"Get a signed URL (POST)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/getreportsignedurlpost","routeSlug":"/other-api/revenue-api-3.0/report-files/getreportsignedurlpost","metadata":{"seo":{"title":"Get a signed URL (POST)","description":"Returns a signed HTTPS URL, valid for 30 minutes, for the file of an Available run stored in cloud storage. Download the file with a plain HTTP GET on the URL. GET and POST behave the same; POST takes no body."}},"httpPath":"/api/integration/v2/reports/signedurl/{report_id}"}]},{"type":"separator","label":"BI Views"},{"type":"group","label":"BI Views","link":"/other-api/revenue-api-3.0/bi-views","routeSlug":"/other-api/revenue-api-3.0/bi-views","items":[{"label":"Retrieve BI View data (v2, paged)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav2","routeSlug":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav2","metadata":{"seo":{"title":"Retrieve BI View data (v2, paged)","description":"Returns one page of BI View rows for a date range as CSV or gzip-compressed CSV. Page 1 starts a background task that writes all pages; the response carries a continuation-token header that you send to read pages 2, 3 and so on. Use POST with a Fields body to return only selected columns."}},"httpPath":"/api/integration/v2/biviews/{tmpl_name}"},{"label":"Get BI View data (v2, paged) (POST)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav2post","routeSlug":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav2post","metadata":{"seo":{"title":"Get BI View data (v2, paged) (POST)","description":"Returns one page of BI View rows for a date range as CSV or gzip-compressed CSV. Page 1 starts a background task that writes all pages; the response carries a continuation-token header that you send to read pages 2, 3 and so on. Use POST with a Fields body to return only selected columns."}},"httpPath":"/api/integration/v2/biviews/{tmpl_name}"},{"label":"Count BI View rows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/countbiviewrowsv2","routeSlug":"/other-api/revenue-api-3.0/bi-views/countbiviewrowsv2","metadata":{"seo":{"title":"Count BI View rows","description":"Returns the number of rows in a BI View for a date range, limited to the organizations your role can access."}},"httpPath":"/api/integration/v2/biviews/count/{tmpl_name}"},{"label":"List BI View columns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/describebiviewcolumnsv2","routeSlug":"/other-api/revenue-api-3.0/bi-views/describebiviewcolumnsv2","metadata":{"seo":{"title":"List BI View columns","description":"Returns the columns of a BI View with their data types and sizes."}},"httpPath":"/api/integration/v2/biviews/{tmpl_name}/describe-columns"},{"label":"Submit a BI View report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/submitbiviewreport","routeSlug":"/other-api/revenue-api-3.0/bi-views/submitbiviewreport","metadata":{"seo":{"title":"Submit a BI View report","description":"Submits a background job that writes the whole BI View for a date range to a report file. Returns the submission ID of the job."}},"httpPath":"/api/integration/v2/biviews/report/{in_view_name}"},{"label":"Retrieve BI View data (v1)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav1","routeSlug":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav1","metadata":{"seo":{"title":"Retrieve BI View data (v1)","description":"Returns BI View rows as CSV, one page per call, for a date range. Without a date range it returns the view's columns; with count=true it returns the row count; with format=csv and no dates it returns only the CSV header row. Use POST with a Fields body to select columns."}},"httpPath":"/api/integration/v1/biviews/{tmpl_name}"},{"label":"Get BI View data (v1) (POST)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav1post","routeSlug":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav1post","metadata":{"seo":{"title":"Get BI View data (v1) (POST)","description":"Returns BI View rows as CSV, one page per call, for a date range. Without a date range it returns the view's columns; with count=true it returns the row count; with format=csv and no dates it returns only the CSV header row. Use POST with a Fields body to select columns."}},"httpPath":"/api/integration/v1/biviews/{tmpl_name}"}]},{"type":"group","label":"BI View Tasks","link":"/other-api/revenue-api-3.0/bi-view-tasks","routeSlug":"/other-api/revenue-api-3.0/bi-view-tasks","items":[{"label":"List BI View tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-view-tasks/listbiviewtasks","routeSlug":"/other-api/revenue-api-3.0/bi-view-tasks/listbiviewtasks","metadata":{"seo":{"title":"List BI View tasks","description":"Returns the tenant's background BI View tasks grouped into active, completed, stale and draining."}},"httpPath":"/api/integration/v2/biviews-status"},{"label":"Retrieve a BI View task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-view-tasks/getbiviewtask","routeSlug":"/other-api/revenue-api-3.0/bi-view-tasks/getbiviewtask","metadata":{"seo":{"title":"Retrieve a BI View task","description":"Returns the state of one background BI View task."}},"httpPath":"/api/integration/v2/biviews-status/{task_id}"},{"label":"Cancel a BI View task","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-view-tasks/cancelbiviewtask","routeSlug":"/other-api/revenue-api-3.0/bi-view-tasks/cancelbiviewtask","metadata":{"seo":{"title":"Cancel a BI View task","description":"Stops a background BI View task and marks it CANCELLED. Pages already written can no longer be relied on."}},"httpPath":"/api/integration/v2/biviews-status/{task_id}"}]},{"type":"separator","label":"Revenue Manual Journals"},{"type":"group","label":"Journal Entries","link":"/other-api/revenue-api-3.0/journal-entries","routeSlug":"/other-api/revenue-api-3.0/journal-entries","items":[{"label":"Create a journal entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/createjournalentry","routeSlug":"/other-api/revenue-api-3.0/journal-entries/createjournalentry","metadata":{"seo":{"title":"Create a journal entry","description":"Purpose"}},"httpPath":"/journal-entries"},{"label":"List journal entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/listjournalentries","routeSlug":"/other-api/revenue-api-3.0/journal-entries/listjournalentries","metadata":{"seo":{"title":"List journal entries","description":"Purpose"}},"httpPath":"/journal-entries"},{"label":"Search journal entries (filter in body)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/queryjournalentries","routeSlug":"/other-api/revenue-api-3.0/journal-entries/queryjournalentries","metadata":{"seo":{"title":"Search journal entries (filter in body)","description":"Purpose"}},"httpPath":"/journal-entries/query"},{"label":"Retrieve a journal entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/getjournalentry","routeSlug":"/other-api/revenue-api-3.0/journal-entries/getjournalentry","metadata":{"seo":{"title":"Retrieve a journal entry","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}"},{"label":"Update a journal entry","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/updatejournalentry","routeSlug":"/other-api/revenue-api-3.0/journal-entries/updatejournalentry","metadata":{"seo":{"title":"Update a journal entry","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}"},{"label":"Delete a journal entry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/deletejournalentry","routeSlug":"/other-api/revenue-api-3.0/journal-entries/deletejournalentry","metadata":{"seo":{"title":"Delete a journal entry","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}"},{"label":"Copy a journal entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/copyjournalentry","routeSlug":"/other-api/revenue-api-3.0/journal-entries/copyjournalentry","metadata":{"seo":{"title":"Copy a journal entry","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/copy"},{"label":"List journal entries by name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/searchjournalentriesbyname","routeSlug":"/other-api/revenue-api-3.0/journal-entries/searchjournalentriesbyname","metadata":{"seo":{"title":"List journal entries by name","description":"Purpose"}},"httpPath":"/journal-entries/search/{jeName}"},{"label":"List journal entries for an organization and book","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/listjournalentriesbyorgandbook","routeSlug":"/other-api/revenue-api-3.0/journal-entries/listjournalentriesbyorgandbook","metadata":{"seo":{"title":"List journal entries for an organization and book","description":"Purpose"}},"httpPath":"/journal-entries/by-org/{secAtrVal}/book/{bookId}"}]},{"type":"group","label":"Service Health","link":"/other-api/revenue-api-3.0/service-health","routeSlug":"/other-api/revenue-api-3.0/service-health","items":[{"label":"Check service health","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/service-health/checkjournalentryservicehealth","routeSlug":"/other-api/revenue-api-3.0/service-health/checkjournalentryservicehealth","metadata":{"seo":{"title":"Check service health","description":"Purpose"}},"httpPath":"/journal-entries/healthcheck"}]},{"type":"group","label":"Journal Entry Lines","link":"/other-api/revenue-api-3.0/journal-entry-lines","routeSlug":"/other-api/revenue-api-3.0/journal-entry-lines","items":[{"label":"List journal entry lines","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entry-lines/listjournalentrylines","routeSlug":"/other-api/revenue-api-3.0/journal-entry-lines/listjournalentrylines","metadata":{"seo":{"title":"List journal entry lines","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/lines"},{"label":"Delete a journal entry line","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entry-lines/deletejournalentryline","routeSlug":"/other-api/revenue-api-3.0/journal-entry-lines/deletejournalentryline","metadata":{"seo":{"title":"Delete a journal entry line","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/lines/{lineId}"},{"label":"Copy journal entry lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entry-lines/copyjournalentrylines","routeSlug":"/other-api/revenue-api-3.0/journal-entry-lines/copyjournalentrylines","metadata":{"seo":{"title":"Copy journal entry lines","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/lines/copy"},{"label":"List journal entry lines by sales order number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entry-lines/searchjournalentrylinesbysalesorder","routeSlug":"/other-api/revenue-api-3.0/journal-entry-lines/searchjournalentrylinesbysalesorder","metadata":{"seo":{"title":"List journal entry lines by sales order number","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/lines/search/{soNumber}"}]},{"type":"group","label":"Schedules and Waterfall","link":"/other-api/revenue-api-3.0/schedules-and-waterfall","routeSlug":"/other-api/revenue-api-3.0/schedules-and-waterfall","items":[{"label":"List journal entry schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/schedules-and-waterfall/listjournalentryschedules","routeSlug":"/other-api/revenue-api-3.0/schedules-and-waterfall/listjournalentryschedules","metadata":{"seo":{"title":"List journal entry schedules","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/schedules"},{"label":"List revenue waterfall entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/schedules-and-waterfall/listjournalentrywaterfallentries","routeSlug":"/other-api/revenue-api-3.0/schedules-and-waterfall/listjournalentrywaterfallentries","metadata":{"seo":{"title":"List revenue waterfall entries","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/waterfall-entries"},{"label":"Retrieve the waterfall status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/schedules-and-waterfall/getjournalentrywaterfallstatus","routeSlug":"/other-api/revenue-api-3.0/schedules-and-waterfall/getjournalentrywaterfallstatus","metadata":{"seo":{"title":"Retrieve the waterfall status","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/waterfall-status"},{"label":"Retry waterfall generation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/schedules-and-waterfall/retryjournalentrywaterfall","routeSlug":"/other-api/revenue-api-3.0/schedules-and-waterfall/retryjournalentrywaterfall","metadata":{"seo":{"title":"Retry waterfall generation","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/waterfall-retry"}]},{"type":"group","label":"Approval Workflow","link":"/other-api/revenue-api-3.0/approval-workflow","routeSlug":"/other-api/revenue-api-3.0/approval-workflow","items":[{"label":"Submit a journal entry for approval","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/submitjournalentry","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/submitjournalentry","metadata":{"seo":{"title":"Submit a journal entry for approval","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/submit"},{"label":"Approve journal entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/approvejournalentries","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/approvejournalentries","metadata":{"seo":{"title":"Approve journal entries","description":"Purpose"}},"httpPath":"/journal-entries/approve"},{"label":"Reject journal entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/rejectjournalentries","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/rejectjournalentries","metadata":{"seo":{"title":"Reject journal entries","description":"Purpose"}},"httpPath":"/journal-entries/reject"},{"label":"Recall journal entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/recalljournalentries","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/recalljournalentries","metadata":{"seo":{"title":"Recall journal entries","description":"Purpose"}},"httpPath":"/journal-entries/recall"},{"label":"Reverse a journal entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/reversejournalentry","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/reversejournalentry","metadata":{"seo":{"title":"Reverse a journal entry","description":"Purpose"}},"httpPath":"/journal-entries/reverse"},{"label":"Delete several journal entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/bulkdeletejournalentries","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/bulkdeletejournalentries","metadata":{"seo":{"title":"Delete several journal entries","description":"Purpose"}},"httpPath":"/journal-entries/bulk-delete"},{"label":"Check allowed actions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/getjournalentryprivileges","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/getjournalentryprivileges","metadata":{"seo":{"title":"Check allowed actions","description":"Purpose"}},"httpPath":"/journal-entries/privileges"},{"label":"List journal entry audit events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/listjournalentryevents","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/listjournalentryevents","metadata":{"seo":{"title":"List journal entry audit events","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/events"},{"label":"Retrieve the validation status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/getjournalentryvalidationstatus","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/getjournalentryvalidationstatus","metadata":{"seo":{"title":"Retrieve the validation status","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/validation-status"}]},{"type":"group","label":"Reference Data","link":"/other-api/revenue-api-3.0/reference-data","routeSlug":"/other-api/revenue-api-3.0/reference-data","items":[{"label":"Retrieve reference data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getjournalentrymetadata","routeSlug":"/other-api/revenue-api-3.0/reference-data/getjournalentrymetadata","metadata":{"seo":{"title":"Retrieve reference data","description":"Purpose"}},"httpPath":"/journal-entries/metadata"},{"label":"List posting and reversal periods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getjournalentryperiods","routeSlug":"/other-api/revenue-api-3.0/reference-data/getjournalentryperiods","metadata":{"seo":{"title":"List posting and reversal periods","description":"Purpose"}},"httpPath":"/journal-entries/metadata/periods"},{"label":"Retrieve field configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getjournalentryconfigurations","routeSlug":"/other-api/revenue-api-3.0/reference-data/getjournalentryconfigurations","metadata":{"seo":{"title":"Retrieve field configuration","description":"Purpose"}},"httpPath":"/journal-entries/configurations"},{"label":"Retrieve the current open period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getcurrentopenperiod","routeSlug":"/other-api/revenue-api-3.0/reference-data/getcurrentopenperiod","metadata":{"seo":{"title":"Retrieve the current open period","description":"Purpose"}},"httpPath":"/journal-entries/current-period"},{"label":"List transaction currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/listjournalentrycurrencies","routeSlug":"/other-api/revenue-api-3.0/reference-data/listjournalentrycurrencies","metadata":{"seo":{"title":"List transaction currencies","description":"Purpose"}},"httpPath":"/journal-entries/currencies"},{"label":"List functional currencies for a Set of Books","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/listfunctionalcurrencies","routeSlug":"/other-api/revenue-api-3.0/reference-data/listfunctionalcurrencies","metadata":{"seo":{"title":"List functional currencies for a Set of Books","description":"Purpose"}},"httpPath":"/journal-entries/functional-currencies"},{"label":"Retrieve debit and credit totals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getjournalentrysummary","routeSlug":"/other-api/revenue-api-3.0/reference-data/getjournalentrysummary","metadata":{"seo":{"title":"Retrieve debit and credit totals","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/summary"},{"label":"Check the soft-freeze status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/checksoftfreeze","routeSlug":"/other-api/revenue-api-3.0/reference-data/checksoftfreeze","metadata":{"seo":{"title":"Check the soft-freeze status","description":"Purpose"}},"httpPath":"/journal-entries/soft-freeze-check"},{"label":"Retrieve the caller's access level","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getjournalentryuserrole","routeSlug":"/other-api/revenue-api-3.0/reference-data/getjournalentryuserrole","metadata":{"seo":{"title":"Retrieve the caller's access level","description":"Purpose"}},"httpPath":"/journal-entries/role"},{"label":"List journal entry object definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/describejournalentryobjects","routeSlug":"/other-api/revenue-api-3.0/reference-data/describejournalentryobjects","metadata":{"seo":{"title":"List journal entry object definitions","description":"Purpose"}},"httpPath":"/journal-entries/describe"},{"label":"Retrieve the revenue contract for an RC, sales order, or line","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getrevenuecontractredirection","routeSlug":"/other-api/revenue-api-3.0/reference-data/getrevenuecontractredirection","metadata":{"seo":{"title":"Retrieve the revenue contract for an RC, sales order, or line","description":"Purpose"}},"httpPath":"/journal-entries/rc-redirection"}]},{"type":"group","label":"Attachments","link":"/other-api/revenue-api-3.0/attachments","routeSlug":"/other-api/revenue-api-3.0/attachments","items":[{"label":"Upload an attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/attachments/uploadjournalentryattachment","routeSlug":"/other-api/revenue-api-3.0/attachments/uploadjournalentryattachment","metadata":{"seo":{"title":"Upload an attachment","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/attachments"},{"label":"List journal entry attachments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/attachments/listjournalentryattachments","routeSlug":"/other-api/revenue-api-3.0/attachments/listjournalentryattachments","metadata":{"seo":{"title":"List journal entry attachments","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/attachments"},{"label":"Delete an attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/attachments/deletejournalentryattachment","routeSlug":"/other-api/revenue-api-3.0/attachments/deletejournalentryattachment","metadata":{"seo":{"title":"Delete an attachment","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/attachments/{attachmentId}"},{"label":"Download an attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/attachments/downloadjournalentryattachment","routeSlug":"/other-api/revenue-api-3.0/attachments/downloadjournalentryattachment","metadata":{"seo":{"title":"Download an attachment","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/attachments/{attachmentId}/download"}]},{"type":"group","label":"Templates and Exports","link":"/other-api/revenue-api-3.0/templates-and-exports","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports","items":[{"label":"Download the CSV upload template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/templates-and-exports/downloadjournalentrytemplate","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports/downloadjournalentrytemplate","metadata":{"seo":{"title":"Download the CSV upload template","description":"Purpose"}},"httpPath":"/journal-entries/template"},{"label":"Export journal entries to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentries","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentries","metadata":{"seo":{"title":"Export journal entries to CSV","description":"Purpose"}},"httpPath":"/journal-entries/export"},{"label":"Export lines to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentrylines","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentrylines","metadata":{"seo":{"title":"Export lines to CSV","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/lines/export"},{"label":"Export schedules to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentryschedules","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentryschedules","metadata":{"seo":{"title":"Export schedules to CSV","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/schedules/export"},{"label":"Export waterfall to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentrywaterfall","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentrywaterfall","metadata":{"seo":{"title":"Export waterfall to CSV","description":"Purpose"}},"httpPath":"/journal-entries/{jeId}/waterfall-entries/export"}]},{"type":"separator","label":"Revenue Contract Management and Workbench Operations"},{"type":"group","label":"Revenue Contracts","link":"/other-api/revenue-api-3.0/revenue-contracts","routeSlug":"/other-api/revenue-api-3.0/revenue-contracts","items":[{"label":"List revenue contracts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contracts/listrevenuecontracts","routeSlug":"/other-api/revenue-api-3.0/revenue-contracts/listrevenuecontracts","metadata":{"seo":{"title":"List revenue contracts","description":"Purpose"}},"httpPath":"/contracts/list"},{"label":"Retrieve a revenue contract","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contracts/getrevenuecontract","routeSlug":"/other-api/revenue-api-3.0/revenue-contracts/getrevenuecontract","metadata":{"seo":{"title":"Retrieve a revenue contract","description":"Purpose"}},"httpPath":"/contracts/{rcId}"}]},{"type":"group","label":"Revenue Contract Lines","link":"/other-api/revenue-api-3.0/revenue-contract-lines","routeSlug":"/other-api/revenue-api-3.0/revenue-contract-lines","items":[{"label":"List lines of a revenue contract","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contract-lines/listrevenuecontractlines","routeSlug":"/other-api/revenue-api-3.0/revenue-contract-lines/listrevenuecontractlines","metadata":{"seo":{"title":"List lines of a revenue contract","description":"Purpose"}},"httpPath":"/contracts/{rcId}/lines"},{"label":"Retrieve a revenue contract line","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contract-lines/getrevenuecontractline","routeSlug":"/other-api/revenue-api-3.0/revenue-contract-lines/getrevenuecontractline","metadata":{"seo":{"title":"Retrieve a revenue contract line","description":"Purpose"}},"httpPath":"/contracts/{rcId}/lines/{lineId}"},{"label":"List contract lines for a charge number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contract-lines/listrevenuecontractlinesbychargenumber","routeSlug":"/other-api/revenue-api-3.0/revenue-contract-lines/listrevenuecontractlinesbychargenumber","metadata":{"seo":{"title":"List contract lines for a charge number","description":"Purpose"}},"httpPath":"/contracts/{rcId}/lines/charge-number/{chargeNumber}"},{"label":"List charge lines across contracts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contract-lines/listchargelines","routeSlug":"/other-api/revenue-api-3.0/revenue-contract-lines/listchargelines","metadata":{"seo":{"title":"List charge lines across contracts","description":"Purpose"}},"httpPath":"/contracts/charges"}]},{"type":"group","label":"Revenue Holds","link":"/other-api/revenue-api-3.0/revenue-holds","routeSlug":"/other-api/revenue-api-3.0/revenue-holds","items":[{"label":"List revenue hold definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-holds/listrevenueholds","routeSlug":"/other-api/revenue-api-3.0/revenue-holds/listrevenueholds","metadata":{"seo":{"title":"List revenue hold definitions","description":"Purpose"}},"httpPath":"/revenue-holds"},{"label":"Retrieve a revenue hold definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-holds/getrevenuehold","routeSlug":"/other-api/revenue-api-3.0/revenue-holds/getrevenuehold","metadata":{"seo":{"title":"Retrieve a revenue hold definition","description":"Purpose"}},"httpPath":"/revenue-holds/{holdId}"}]},{"type":"group","label":"Contract Status","link":"/other-api/revenue-api-3.0/contract-status","routeSlug":"/other-api/revenue-api-3.0/contract-status","items":[{"label":"Open or close a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-status/openorcloserevenuecontract","routeSlug":"/other-api/revenue-api-3.0/contract-status/openorcloserevenuecontract","metadata":{"seo":{"title":"Open or close a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/open-close/{action}"},{"label":"Unfreeze a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-status/unfreezerevenuecontract","routeSlug":"/other-api/revenue-api-3.0/contract-status/unfreezerevenuecontract","metadata":{"seo":{"title":"Unfreeze a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/unfreeze"}]},{"type":"group","label":"Apply and Release Holds","link":"/other-api/revenue-api-3.0/apply-and-release-holds","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds","items":[{"label":"Apply a hold to a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/applycontracthold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/applycontracthold","metadata":{"seo":{"title":"Apply a hold to a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/holds/{holdId}/apply"},{"label":"Release a hold from a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/releasecontracthold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/releasecontracthold","metadata":{"seo":{"title":"Release a hold from a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/holds/{holdId}/release"},{"label":"Apply a hold to contract lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/applylinehold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/applylinehold","metadata":{"seo":{"title":"Apply a hold to contract lines","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/lines/holds/{holdId}/apply"},{"label":"Release a hold from contract lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/releaselinehold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/releaselinehold","metadata":{"seo":{"title":"Release a hold from contract lines","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/lines/holds/{holdId}/release"},{"label":"Apply a hold to contract POBs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/applypobhold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/applypobhold","metadata":{"seo":{"title":"Apply a hold to contract POBs","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/pobs/holds/{holdId}/apply"},{"label":"Release a hold from contract POBs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/releasepobhold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/releasepobhold","metadata":{"seo":{"title":"Release a hold from contract POBs","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/pobs/holds/{holdId}/release"},{"label":"Apply a hold to contract charges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/applychargehold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/applychargehold","metadata":{"seo":{"title":"Apply a hold to contract charges","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/charges/holds/{holdId}/apply"},{"label":"Release a hold from contract charges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/releasechargehold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/releasechargehold","metadata":{"seo":{"title":"Release a hold from contract charges","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/charges/holds/{holdId}/release"}]},{"type":"group","label":"Revenue Deferral and Release","link":"/other-api/revenue-api-3.0/revenue-deferral-and-release","routeSlug":"/other-api/revenue-api-3.0/revenue-deferral-and-release","items":[{"label":"Defer revenue for a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-deferral-and-release/deferrevenueforcontract","routeSlug":"/other-api/revenue-api-3.0/revenue-deferral-and-release/deferrevenueforcontract","metadata":{"seo":{"title":"Defer revenue for a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/defer-revenue"},{"label":"Defer revenue for a POB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-deferral-and-release/deferrevenueforpob","routeSlug":"/other-api/revenue-api-3.0/revenue-deferral-and-release/deferrevenueforpob","metadata":{"seo":{"title":"Defer revenue for a POB","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/pobs/{pobId}/defer-revenue"},{"label":"Release revenue for a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-deferral-and-release/releaserevenueforcontract","routeSlug":"/other-api/revenue-api-3.0/revenue-deferral-and-release/releaserevenueforcontract","metadata":{"seo":{"title":"Release revenue for a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/release-revenue"},{"label":"Release revenue for a POB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-deferral-and-release/releaserevenueforpob","routeSlug":"/other-api/revenue-api-3.0/revenue-deferral-and-release/releaserevenueforpob","metadata":{"seo":{"title":"Release revenue for a POB","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/pobs/{pobId}/release-revenue"}]},{"type":"group","label":"Cost Deferral and Release","link":"/other-api/revenue-api-3.0/cost-deferral-and-release","routeSlug":"/other-api/revenue-api-3.0/cost-deferral-and-release","items":[{"label":"Defer cost on a contract line","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/cost-deferral-and-release/defercost","routeSlug":"/other-api/revenue-api-3.0/cost-deferral-and-release/defercost","metadata":{"seo":{"title":"Defer cost on a contract line","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/defer-cost"},{"label":"Release cost on a contract line","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/cost-deferral-and-release/releasecost","routeSlug":"/other-api/revenue-api-3.0/cost-deferral-and-release/releasecost","metadata":{"seo":{"title":"Release cost on a contract line","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/release-cost"}]},{"type":"group","label":"Allocation","link":"/other-api/revenue-api-3.0/allocation","routeSlug":"/other-api/revenue-api-3.0/allocation","items":[{"label":"Reallocate or mark a contract allocation-eligible","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/allocation/performallocationaction","routeSlug":"/other-api/revenue-api-3.0/allocation/performallocationaction","metadata":{"seo":{"title":"Reallocate or mark a contract allocation-eligible","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/allocate-action"},{"label":"Switch the allocation treatment of a contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/allocation/switchallocation","routeSlug":"/other-api/revenue-api-3.0/allocation/switchallocation","metadata":{"seo":{"title":"Switch the allocation treatment of a contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/switch-allocation"}]},{"type":"group","label":"Lines and POBs","link":"/other-api/revenue-api-3.0/lines-and-pobs","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs","items":[{"label":"Edit custom attributes of a contract line","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/editrevenuecontractline","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/editrevenuecontractline","metadata":{"seo":{"title":"Edit custom attributes of a contract line","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/lines/{lineId}/edit"},{"label":"Edit several POBs of a contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/editpobs","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/editpobs","metadata":{"seo":{"title":"Edit several POBs of a contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/pobs/edit"},{"label":"Edit one POB of a contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/editpob","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/editpob","metadata":{"seo":{"title":"Edit one POB of a contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/pobs/{pobId}/edit"},{"label":"Copy a line into a new manual POB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/copyline","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/copyline","metadata":{"seo":{"title":"Copy a line into a new manual POB","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/copyLn"},{"label":"Switch the lead line of a POB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/switchleadline","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/switchleadline","metadata":{"seo":{"title":"Switch the lead line of a POB","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/switch-lead-line"},{"label":"Move a POB to a different derived POB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/movepob","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/movepob","metadata":{"seo":{"title":"Move a POB to a different derived POB","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/move-pob"}]},{"type":"group","label":"Contract Grouping","link":"/other-api/revenue-api-3.0/contract-grouping","routeSlug":"/other-api/revenue-api-3.0/contract-grouping","items":[{"label":"Link contracts into a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/linkcontracts","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/linkcontracts","metadata":{"seo":{"title":"Link contracts into a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/link-rc"},{"label":"Link POBs into a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/linkpobs","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/linkpobs","metadata":{"seo":{"title":"Link POBs into a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/pobs/link"},{"label":"Link lines into a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/linklines","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/linklines","metadata":{"seo":{"title":"Link lines into a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/lines/link"},{"label":"Link charges into a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/linkcharges","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/linkcharges","metadata":{"seo":{"title":"Link charges into a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/charges/link"},{"label":"Link subscriptions into a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/linksubscriptions","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/linksubscriptions","metadata":{"seo":{"title":"Link subscriptions into a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/subscriptions/link"},{"label":"Delink a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/delinkcontract","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/delinkcontract","metadata":{"seo":{"title":"Delink a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/delink-rc"},{"label":"Delink POBs from a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/delinkpobs","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/delinkpobs","metadata":{"seo":{"title":"Delink POBs from a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/pobs/delink"},{"label":"Delink lines from a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/delinklines","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/delinklines","metadata":{"seo":{"title":"Delink lines from a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/lines/delink"},{"label":"Delink charges from a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/delinkcharges","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/delinkcharges","metadata":{"seo":{"title":"Delink charges from a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/charges/delink"},{"label":"Delink subscriptions from a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/delinksubscriptions","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/delinksubscriptions","metadata":{"seo":{"title":"Delink subscriptions from a revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/subscriptions/delink"},{"label":"Undo a delink","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/undodelink","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/undodelink","metadata":{"seo":{"title":"Undo a delink","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/undoDelink"},{"label":"Create a manual revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/createmanualrevenuecontract","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/createmanualrevenuecontract","metadata":{"seo":{"title":"Create a manual revenue contract","description":"Purpose"}},"httpPath":"/revenue-management/contracts/create-manual"}]},{"type":"group","label":"Variable Consideration","link":"/other-api/revenue-api-3.0/variable-consideration","routeSlug":"/other-api/revenue-api-3.0/variable-consideration","items":[{"label":"List variable consideration types for a line","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/variable-consideration/listvariableconsiderationtypes","routeSlug":"/other-api/revenue-api-3.0/variable-consideration/listvariableconsiderationtypes","metadata":{"seo":{"title":"List variable consideration types for a line","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/vc-types"},{"label":"Apply variable consideration to a line","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/variable-consideration/applyvariableconsideration","routeSlug":"/other-api/revenue-api-3.0/variable-consideration/applyvariableconsideration","metadata":{"seo":{"title":"Apply variable consideration to a line","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/apply-vc"},{"label":"Expire variable consideration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/variable-consideration/expirevariableconsideration","routeSlug":"/other-api/revenue-api-3.0/variable-consideration/expirevariableconsideration","metadata":{"seo":{"title":"Expire variable consideration","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/expire-vc"}]},{"type":"group","label":"Impairment","link":"/other-api/revenue-api-3.0/impairment","routeSlug":"/other-api/revenue-api-3.0/impairment","items":[{"label":"Apply impairment to contract lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/impairment/applyimpairment","routeSlug":"/other-api/revenue-api-3.0/impairment/applyimpairment","metadata":{"seo":{"title":"Apply impairment to contract lines","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/apply-impairment"}]},{"type":"group","label":"Usage","link":"/other-api/revenue-api-3.0/usage","routeSlug":"/other-api/revenue-api-3.0/usage","items":[{"label":"Edit usage records","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/usage/editusage","routeSlug":"/other-api/revenue-api-3.0/usage/editusage","metadata":{"seo":{"title":"Edit usage records","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/edit-usage"},{"label":"Cancel a usage record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/usage/cancelusage","routeSlug":"/other-api/revenue-api-3.0/usage/cancelusage","metadata":{"seo":{"title":"Cancel a usage record","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/usage-cancel"}]},{"type":"group","label":"Billing","link":"/other-api/revenue-api-3.0/billing","routeSlug":"/other-api/revenue-api-3.0/billing","items":[{"label":"Void a billing document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/billing/voidbilling","routeSlug":"/other-api/revenue-api-3.0/billing/voidbilling","metadata":{"seo":{"title":"Void a billing document","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/void-billing"}]},{"type":"group","label":"Forecast","link":"/other-api/revenue-api-3.0/forecast","routeSlug":"/other-api/revenue-api-3.0/forecast","items":[{"label":"Generate the revenue forecast","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/forecast/generateforecast","routeSlug":"/other-api/revenue-api-3.0/forecast/generateforecast","metadata":{"seo":{"title":"Generate the revenue forecast","description":"Purpose"}},"httpPath":"/revenue-management/contracts/{rcId}/generate-forecast"}]}]}]}