{"openapi":"3.0.0","info":{"title":"Commerce","description":"[Zoom Commerce](https://developers.zoom.us/docs/commerce/) APIs allows partners to manage subscriptions, enable intergrations, and more.","termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","contact":{"name":"Zoom Developers","url":"https://developer.zoom.us/"},"version":"2"},"externalDocs":{"description":"Find out more about Swagger","url":"https://swagger.io"},"servers":[{"url":"https://api.zoom.us/v2"}],"paths":{"/commerce/account":{"post":{"tags":["Account Management"],"summary":"Create an end customer account","description":"Creates an end customer account. \n**Note** Please check the base URL for sandbox and production environments under Zoom Commerce section [here](/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:sub_account:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"createAccount","requestBody":{"content":{"application/json":{"schema":{"required":["account_name","billing_address","contacts","currency","employee_count","website"],"type":"object","properties":{"account_name":{"type":"string","description":"The account's name.","example":"John Galt"},"employee_count":{"type":"string","description":"The company's employee count.","example":"251-500","enum":["Just Me","2-10","11-50","51-250","251-500","501-1000","1001-5000","5001-10000","10001+"]},"website":{"type":"string","description":"The company's website. It should not be any social media handle or Facebook, Google, and eBay shopping front.","example":"www.example.com"},"sub_reseller_crm_account_number":{"type":"string","description":"The sub-reseller's CRM account number.","example":"A-45733"},"contacts":{"maxItems":10,"type":"array","description":"The account's contact details. Provide at least one contact.","items":{"required":["business_phone","company_email","first_name","job_title","last_name"],"type":"object","properties":{"first_name":{"type":"string","description":"The contact's first name.","example":"Tracy"},"last_name":{"type":"string","description":"The contact's last name.","example":"Smith"},"job_title":{"type":"string","description":"The contact's job title.","example":"Account Executive"},"company_email":{"type":"string","description":"The contact's company email ID. The email domain should be the same as the account domain.","example":"tsmith@somecompany.com"},"business_phone":{"type":"string","description":"The contact's business phone number.","example":"192837489342"},"primary_role":{"type":"string","description":"The contact's primary role.","example":"Decision Maker","enum":["Admin","Decision Maker","Economic Buyer","Executive Sponsor","Zoom Champion","Zoom Coach","Influencer","Technical Evaluator","End User","Legal","Procurement","Vendor Manager","Sourcing Manager","Billing"]}},"description":"The new contact details."}},"currency":{"maxLength":3,"type":"string","description":"The ISO currency code.","example":"USD"},"billing_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or ZIP code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO country code.","example":"US"}},"description":"The address details."}},"description":"The account details."}}}},"responses":{"201":{"description":"The account creation request was submitted successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracking the API call.","schema":{"type":"string","example":"WEBfgirugt59tivjmr"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"create_reference_id":{"type":"string","description":"The unique reference ID for this account creation process. Please use this ID for checking the status.","example":"ACC-2333"},"crm_account_number":{"type":"string","description":"The unique CRM account number.","example":"A-0012"},"status":{"type":"string","description":"The supported status.","example":"submitted","enum":["submitted","success","partial success","failure"]},"status_detail":{"type":"string","description":"The details in case of partial success or failure.","example":"one or more contact creation failed."}},"description":"The account update details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5101` <br>\n More than 1 account found with given domain. <br>\n**Error Code:** `5102` <br>\n Account name must be at most 255 characters. <br>\n**Error Code:** `5103` <br>\n Account name cannot be blank. <br>\n**Error Code:** `5104` <br>\n Account name must not contain following special characters @ # $ % ^  +  =  : | <br>\n**Error Code:** `5105` <br>\n First name must be at most 40 characters. <br>\n**Error Code:** `5106` <br>\n First name cannot be blank. <br>\n**Error Code:** `5107` <br>\n Last name must be at most 80 characters. <br>\n**Error Code:** `5108` <br>\n Last name cannot be blank. <br>\n**Error Code:** `5109` <br>\n Job title must be at most 128 characters. <br>\n**Error Code:** `5110` <br>\n Invalid company email. <br>\n**Error Code:** `5111` <br>\n Company email must be at most 80 characters. <br>\n**Error Code:** `5010` <br>\n Business phone must be between 10 to 15 characters long. <br>\n**Error Code:** `5113` <br>\n Address Line1 must be at most 255 characters. <br>\n**Error Code:** `5114` <br>\n City must be at most 40 characters. <br>\n**Error Code:** `5115` <br>\n State must be at most 80 characters. <br>\n**Error Code:** `5116` <br>\n Postal Code must be at most 20 characters. <br>\n**Error Code:** `5117` <br>\n Website must be in URL syntax. <br>\n**Error Code:** `5118` <br>\n Country cannot be blank. <br>\n**Error Code:** `5119` <br>\n Currency cannot be blank. <br>\n**Error Code:** `5120` <br>\n No account found. <br>\n**Error Code:** `5121` <br>\n Account create or update already in progress. <br>\n**Error Code:** `5122` <br>\n Employee count cannot be blank. <br>\n**Error Code:** `5123` <br>\n Invalid employee count. <br>\n**Error Code:** `5124` <br>\n Billing Address cannot be blank. <br>\n**Error Code:** `5125` <br>\n City cannot be blank. <br>\n**Error Code:** `5126` <br>\n Postal Code cannot be blank. <br>\n**Error Code:** `5127` <br>\n Invalid country. <br>\n**Error Code:** `5128` <br>\n State cannot be blank. <br>\n**Error Code:** `5402` <br>\n Currency should be a valid ISO currency code <br>\n**Error Code:** `5130` <br>\n Company email cannot be blank. <br>\n**Error Code:** `5131` <br>\n AddressLine1 cannot be blank. <br>\n**Error Code:** `5132` <br>\n Website cannot be blank. <br>\n**Error Code:** `5133` <br>\n The email domain of the contact must match the domain of the account website. <br>\n**Error Code:** `5134` <br>\n The contact's email domain is whitelisted as public and is therefore not permitted. <br>\n**Error Code:** `5138` <br>\n Invalid contact primary role. <br>\n**Error Code:** `5139` <br>\n At least 1 account contact is required, and company emails must be unique and have the same domain. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. Please try again later. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:write:sub_account:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:write:sub_account:admin"]}}},"/commerce/account/{accountKey}/contacts":{"post":{"tags":["Account Management"],"summary":"Add contacts to an existing end customer or your own account.","description":"Add contacts to an existing end customer or your own account. <br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:update:account:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"addAccountContact","parameters":[{"name":"accountKey","in":"path","description":"A unique account key. It can be either the CRM account number, the account create reference ID, or the Zoom account number.","required":true,"schema":{"maxLength":10,"type":"string","example":"4435343789"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contacts":{"maxItems":10,"minItems":1,"type":"array","description":"The contact details for the account. At least one contact should be provided.","items":{"required":["business_phone","company_email","first_name","job_title","last_name"],"type":"object","properties":{"first_name":{"type":"string","description":"The contact's first name.","example":"Tracy"},"last_name":{"type":"string","description":"The contact's last name.","example":"Smith"},"job_title":{"type":"string","description":"The contact's job title.","example":"Account Executive"},"company_email":{"type":"string","description":"The contact's company email ID. The email domain should be the same as the account domain.","example":"tsmith@somecompany.com"},"business_phone":{"type":"string","description":"The contact's business phone number.","example":"192837489342"},"primary_role":{"type":"string","description":"The contact's primary role.","example":"Decision Maker","enum":["Admin","Decision Maker","Economic Buyer","Executive Sponsor","Zoom Champion","Zoom Coach","Influencer","Technical Evaluator","End User","Legal","Procurement","Vendor Manager","Sourcing Manager","Billing"]}},"description":"The new contact details."}}},"description":"The account contact details."}}}},"responses":{"200":{"description":"Account contact request submitted successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBfgjriotu5698459"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"create_reference_id":{"type":"string","description":"The unique reference ID for this account creation process. Use this ID for checking the status.","example":"ACC-2333"},"crm_account_number":{"type":"string","description":"The unique CRM account number.","example":"A-0012"},"status":{"type":"string","description":"The current status of the request: submitted, success, partial success, or failure.","example":"submitted","enum":["submitted","success","partial success","failure"]},"status_detail":{"type":"string","description":"Additional details in case of partial success or error.","example":"One or more contact creation failed."}},"description":"The account update details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5105` <br>\n First name must be at most 40 characters <br>\n**Error Code:** `5106` <br>\n First name cannot be blank. <br>\n**Error Code:** `5107` <br>\n Last name must be at most 80 characters. <br>\n**Error Code:** `5108` <br>\n Last name cannot be blank. <br>\n**Error Code:** `5109` <br>\n Job title must be at most 128 characters. <br>\n**Error Code:** `5110` <br>\n Invalid company email. <br>\n**Error Code:** `5111` <br>\n Company email must be at most 80 characters. <br>\n**Error Code:** `5112` <br>\n Business phone must be at most 15 characters. <br>\n**Error Code:** `5121` <br>\n Account create or update already in progress. <br>\n**Error Code:** `5130` <br>\n Company email cannot be blank. <br>\n**Error Code:** `5139` <br>\n At least 1 account contact is required, and company emails must be unique and have the same domain. <br>\n**Error Code:** `5138` <br>\n Invalid contact primary role. <br>\n**Error Code:** `5120` <br>\n No account found. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  No account found. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. Please try again later. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:update:account:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:update:account:admin"]}}},"/commerce/accounts":{"get":{"tags":["Account Management"],"summary":"Get the list of all accounts associated with a Zoom Partner/Sub-Reseller, by the account type","description":"Returns the list of all accounts associated with a Zoom Partner and Sub-Reseller, by the account type - endCustomer, subReseller, and relatedPartner. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:account:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"getAllAccounts","parameters":[{"name":"relationship_type","in":"query","description":"The relationship type by which to filter the results.","required":false,"schema":{"type":"string","example":"endCustomer","enum":["endCustomer","subReseller","relatedPartner","siblings","certifiedPartner"]}},{"name":"account_name","in":"query","description":"The full or partial name of the account. It has a minimum of three characters. Characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"Joe"}},{"name":"currency","in":"query","description":"The ISO code for the account currency.","required":false,"schema":{"type":"string","example":"USD"}},{"name":"partner_type","in":"query","description":"Comma-separated partner types to filter on if the relationship_type is subReseller, relatedPartner, or siblings.","required":false,"schema":{"type":"string","example":"Subreseller, Reseller","enum":["Distributor","Subreseller","Reseller","Carrier"]}},{"name":"crm_account_number","in":"query","description":"The full or partial CRM account number. It has a minimum of three characters.","required":false,"schema":{"type":"string","example":"A-23432"}},{"name":"zoom_account_number","in":"query","description":"The full or partial Zoom account number. It has a minimum of three characters.","required":false,"schema":{"maxLength":10,"type":"string","example":"4435343789"}},{"name":"create_reference_id","in":"query","description":"The create reference ID for the account.","required":false,"schema":{"type":"string","example":"ACC-12"}},{"name":"sub_reseller_crm_account_number","in":"query","description":"The full CRM account number for the sub-reseller. If this is provided and account_type is endCustomer, only end customers related to this sub-reseller will be returned in the response.","required":false,"schema":{"type":"string","example":"A-2343245"}},{"name":"sibling_crm_account_number","in":"query","description":"The full CRM account number of a sibling account. If this filter is used, all the end customer, sub-reseller, sibling, or related partner accounts returned by the API will be in context of this account.","required":false,"schema":{"type":"string","example":"A-23432"}},{"name":"status","in":"query","description":"Status to filter on.","required":false,"schema":{"type":"string","example":"success","enum":["submitted","success","partial success","failure","in review","failed to submit"]}},{"name":"page_size","in":"query","description":"The number of records returned per page in the response. Maximum 100.","required":false,"schema":{"maximum":100,"minimum":20,"type":"integer","example":50,"default":20}},{"name":"page_number","in":"query","description":"The page number for fetching the next page of the result set.","required":false,"schema":{"type":"integer","example":2}}],"responses":{"200":{"description":"This endpoint returns the end customer account list.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBhfuefy383ujdbf672"}}},"content":{"application/json":{"schema":{"required":["account_list"],"type":"object","properties":{"page_count":{"type":"integer","description":"The total number of pages in the result set.","example":20},"account_list":{"maxItems":100,"type":"array","description":"The list of accounts.","items":{"type":"object","properties":{"create_reference_id":{"type":"string","description":"The unique reference ID for the account created by the Zoom commerce API.","example":"Cust-00123343242"},"crm_account_number":{"type":"string","description":"The unique CRM account number.","example":"A0012"},"account_name":{"type":"string","description":"The account name.","example":"John Galt"},"zoom_account_number":{"maxLength":10,"type":"string","description":"The Zoom account number (ZAN).","example":"3842618277"},"zoom_account_numbers":{"maxItems":10,"type":"array","description":"Additional Zoom account numbers (ZAN) associated with this CRM account.","items":{"type":"number","example":3842618277}},"account_type":{"type":"string","description":"The account type: Partner or Customer.","example":"Customer","enum":["Partner","Customer"]},"partner_type":{"type":"string","description":"The partner type.","example":"Subreseller","enum":["Distributor","Subreseller","Reseller","Carrier"]},"country":{"maxLength":3,"type":"string","description":"The ISO code for the account country.","example":"US"},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the account currency.","example":"USD"},"website":{"type":"string","description":"The account's website.","example":"www.abc.com"},"status":{"type":"string","description":"The current status of an account. ","example":"submitted","enum":["submitted","success","partial success","failure","in review","failed to submit"]}},"description":"The account list."}}},"description":"The account summary."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5007` <br>\n Invalid page number. It must start with 1 or more. <br>\n**Error Code:** `5008` <br>\n Invalid page size. It must be between 1 and 99. <br>\n**Error Code:** `5140` <br>\n Invalid account type. It must be one of: endCustomer, subReseller, relatedPartner. <br>\n**Error Code:** `5000` <br>\n Invalid character & or | in the name filter. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:account:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:account:admin"]}}},"/commerce/accounts/{accountKey}":{"get":{"tags":["Account Management"],"summary":"Get the account details for a Zoom Partner/Subreseller/End Customer","description":"Returns the account details for a Zoom Partner, Subreseller, and End Customer. <br><b>Note:</b> Please check the base URL for sandbox and production environments under the Zoom Commerce section [here](https://developers.zoom.us/docs/api/).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:account:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"getAccountDetails","parameters":[{"name":"accountKey","in":"path","description":"A unique account key - can be the CRM account number or the account `create_reference_id`.","required":true,"schema":{"type":"string","example":"A-2121"}},{"name":"contact_email","in":"query","description":"Contact email ID to filter contacts. This filter will be applied only to the following account types: Distributor, Sibling, and Subreseller.","required":false,"schema":{"type":"string","example":"abc@xyz.com"}}],"responses":{"200":{"description":"The account details.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBjfiodrgu59t854tj45"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The unique ID for the account in the Zoom CRM system.","example":"A-0012"},"create_reference_id":{"type":"string","description":"The unique reference ID for this account. Please use this ID for getting the account details if the account doesn't have an account number.","example":"ACC-2333"},"status":{"type":"string","description":"The current status of an account.","example":"submitted","enum":["submitted","success","partial success","failure","in review","failed to submit"]},"status_detail":{"type":"string","description":"The details in case of partial success or failure.","example":"Contact update failure."},"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number. This is the identifier which the end customer should refer to in any communication with Zoom.","example":"1223837102"},"zoom_account_numbers":{"maxItems":10,"type":"array","description":"Additional Zoom account numbers (ZAN) associated with this CRM account.","items":{"type":"number","example":3842618277}},"account_name":{"type":"string","description":"The account name.","example":"ABC Pvt Ltd."},"account_type":{"type":"string","description":"The account type can be either Partner or Customer.","example":"Customer","enum":["Partner","Customer"]},"created_on_date":{"type":"string","description":"The creation date.","format":"YYYY-MM-DD","example":"2022-10-18"},"employee_count":{"type":"string","description":"The company's employee count. Supported values are - Just Me, 2-10, 11-50, 51-250, 251-500, 501-1000, 1001-5000, 5001-10000, and 10000+.","example":"51-250","enum":["Just Me","2-10","11-50","51-250","251-500","501-1000","1001-5000","5001-10000","10000+"]},"website":{"type":"string","description":"The company's website. It should not be any social media handle or Facebook, Google, and eBay shopping front.","example":"www.example.com"},"currency":{"maxLength":3,"type":"string","description":"The ISO currency code for the account currency.","example":"US"},"partner_type":{"type":"string","description":"The partner type.","example":"Subreseller","enum":["Distributor","Subreseller","Reseller","Carrier"]},"contacts":{"maxItems":10,"type":"array","description":"The contacts.","items":{"required":["business_phone","company_email","first_name","job_title","last_name"],"type":"object","properties":{"contact_crm_number":{"type":"string","description":"The contact's unique CRM number.","example":"A-12428"},"first_name":{"type":"string","description":"The contact's first name.","example":"Tracy"},"last_name":{"type":"string","description":"The contact's last name.","example":"Smith"},"job_title":{"type":"string","description":"The contact's job title.","example":"Account Executive"},"company_email":{"type":"string","description":"The contact's company email ID. The email domain should be the same as the account domain.","example":"tsmith@somecompany.com"},"business_phone":{"type":"string","description":"The contact's business phone number.","example":"192837489342"},"primary_role":{"type":"string","description":"The contact's primary role.","example":"Decision Maker","enum":["Admin","Decision Maker","Economic Buyer","Executive Sponsor","Zoom Champion","Zoom Coach","Influencer","Technical Evaluator","End User","Legal","Procurement","Vendor Manager","Sourcing Manager","Billing"]}},"description":"The contact details."}},"billing_address":{"required":["city","country","line_1","state"],"type":"object","properties":{"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The Postal or ZIP code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details."},"errors":{"maxItems":50,"type":"array","description":"Array of messages in case of validation or processing errors.","items":{"type":"object","properties":{"error_code":{"type":"string","description":"Error code.","example":"5012"},"error_description":{"type":"string","description":"Error description.","example":"Invalid contact email."}},"description":"Error details."}}},"description":"The account details."}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found \n\n **Error Code:** `5009` <br>\n No records found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests For more information, see [rate limits](/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error The server encountered an unexpected condition which prevented it from fulfilling the request. Please try again later. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:account:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:account:admin"]}}},"/commerce/billing_documents":{"get":{"tags":["Billing"],"summary":"Gets all billing documents for a distributor or a reseller","description":"Returns all billing documents for a distributor or a reseller. \n\nBilling Documents represent the end customer's invoices, credit memos and debit memos. The response can be filtered by status, document date etc. By default, the list of unpaid invoices in the last 1 month are retrieved. \n\n<br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:billing_documents:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"getAllBillingDocs","parameters":[{"name":"document_type","in":"query","description":"The invoice, credit_memo, and debit_memo. The default is invoice.","required":false,"schema":{"type":"string","example":"invoice","enum":["invoice","credit_memo","debit_memo"]}},{"name":"payment_status","in":"query","description":"This field filters the list of documents by payment status. Accepted values: paid, unpaid, and all. By default all documents are returned.","required":false,"schema":{"type":"string","example":"Unpaid","enum":["Paid","Unpaid","All"]}},{"name":"document_date_start","in":"query","description":"This field filters the list of documents where document date is on or after the date provided in YYYY-MM-DD format. The default is one month.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2023-10-25"}},{"name":"document_date_end","in":"query","description":"This field filters the list of documents where document date is on or before the date provided in YYYY-MM-DD format.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2023-10-25"}},{"name":"due_date","in":"query","description":"This field filters the list of documents where document due on date is on the date provided in YYYY-MM-DD format.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2023-10-25"}},{"name":"document_number","in":"query","description":"This filed filters the list of documents by the document number, like invoice number, credit memo number and so on. Any document number which contains the parameter value will be returned.","required":false,"schema":{"type":"string","example":"INV-12121"}},{"name":"currency","in":"query","description":"The ISO currency code. The default shows documents in all currencies.","required":false,"schema":{"maxLength":3,"type":"string","example":"USD"}},{"name":"end_customer_name","in":"query","description":"This field filters the list of documents by the end customer account name. The minimum three characters should be provided. Characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"Jon"}},{"name":"end_customer_crm_account_number","in":"query","description":"This field filters results based on end customer CRM account number.","required":false,"schema":{"type":"string","example":"A-3454334"}},{"name":"end_customer_zoom_account_number","in":"query","description":"This field filters results based on a end customer Zoom account number.","required":false,"schema":{"maxLength":12,"minLength":3,"type":"string","example":"4435343789"}},{"name":"exclude_zero_balance_invoices","in":"query","description":"This field filters the list of documents by the invoice balance. All zero dollar invoices will be filtered out from the response if the value is true. By default it is false.","required":false,"schema":{"type":"boolean","example":true,"default":false}},{"name":"invoice_owner_crm_account_number","in":"query","description":"This field filters invoices by the CRM account number for the Invoice Owner.","required":false,"schema":{"type":"string","example":"A-3454374"}},{"name":"page_size","in":"query","description":"The maximum number of results returned in a page. The minimum value is one and the maximum is 99. Default is 10.","required":false,"schema":{"maximum":99,"minimum":1,"type":"integer","example":20}},{"name":"next_page_token","in":"query","description":"The token for the next page in the record set if results have more records than the number specified by the page size. The next page token paginates through a large set of result. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"feur38rhjr10"}},{"name":"sort","in":"query","description":"This field specifies the sort order of the list. Sorting can be ascending (asc) or descending (desc). The fields on which this list can be sorted are document number, document date, due date, and balance. By default the list is sorted by document date. ascending.","required":false,"schema":{"type":"string","example":"documentDate.asc","enum":["documentNumber.asc","documentDate.asc","dueDate.asc","balance.asc","documentNumber.desc","documentDate.desc","dueDate.desc","balance.desc"]}}],"responses":{"200":{"description":"Billing documents retrieved successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBhfuefy383ujdbf672"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"document_count":{"type":"integer","description":"The total number of documents.","example":100},"billing_documents":{"maxItems":100,"type":"array","description":"The billing document list.","items":{"type":"object","properties":{"document_number":{"type":"string","description":"The document number.","example":"INVC10235997"},"document_date":{"type":"string","description":"The document date.","example":"2023-10-25T00:00:00.000Z"},"document_type":{"type":"string","description":"The type of the billing document: invoice, credit memo, or debit memo.","example":"invoice","enum":["invoice","credit_memo","debit_memo"]},"customer_name":{"type":"array","description":"The end customer account name.","items":{"type":"string","example":"ABC Pvt. Ltd."}},"customer_zoom_account_number":{"type":"number","description":"The end customer zoom account number.","example":4435343789},"sub_reseller_name":{"type":"string","description":"The sub-reseller name if the subscription was created by a distributor on their behalf.","example":"Subreseller One"},"invoice_owner_name":{"type":"string","description":"The invoice owner's name.","example":"Subreseller One"},"due_date":{"type":"string","description":"The document due date.","example":"2023-11-25T00:00:00.000Z"},"payment_status":{"type":"string","description":"The status of the document: paid or unpaid.","example":"Paid","enum":["Paid","Unpaid"]},"balance":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"This field represents the sale price, list price, net amount, or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"This field represents sale price, list price, net amount, or gross amount."},"po_number":{"type":"string","description":"Purchase order number","example":"PO-10021-A"},"billing_description":{"type":"string","description":"The description or any other detail about the document.","example":"Correcting invoice error"},"posted_date":{"type":"string","description":"The posted date for the document.","example":"2023-10-26"},"reason_detail":{"type":"string","description":"The reason description or detail for which this document has been generated.","example":"Correcting invoice error"},"reference_billing_document_id":{"type":"string","description":"Any other billing document associated with this invoice or credit memo or debit memo.","example":"8a8aa183907cc66e01907d722e232bcd"}},"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"next_page_token":{"type":"string","description":"The token for the next page in the record set if result has more records than the number specified by the page size. The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","example":"gfrnkgrgfe4583492"}},"description":"Billing documents list."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5504` <br>\n Payment Status valid values are : paid, unpaid, and all. <br>\n**Error Code:** `5505` <br>\n Date range cannot be more than 3 years. <br>\n**Error Code:** `5002` <br>\n Invalid date format. Expected format: YYYY-MM-DD. <br>\n**Error Code:** `5008` <br>\n Invalid page size. It must be between 1 and 99. <br>\n**Error Code:** `5506` <br>\n 5506 - Invalid sort values. It must be one of: documentNumber.asc,  documentDate.asc, dueDate.asc,  balance.asc,  documentNumber.desc, documentDate.desc, dueDate.desc, and balance.desc. <br>\n**Error Code:** `5507` <br>\n Multiples fields not supported in sorting. <br>\n**Error Code:** `5000` <br>\n Invalid character & or | in the name filter. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:billing_documents:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:billing_documents:admin"]}}},"/commerce/billing_documents/{documentNumber}/document":{"get":{"tags":["Billing"],"summary":"Gets the PDF document for the billing document ID","description":"Returns the PDF document for the billing document ID. \n\n<br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:billing_documents:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"downloadBillingDoc","parameters":[{"name":"documentNumber","in":"path","description":"The document number.","required":true,"schema":{"type":"string","example":"IN-32432"}}],"responses":{"200":{"description":"The billing document PDF retrieved successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string"}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5501` <br>\n No document found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition, which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:billing_documents:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:billing_documents:admin"]}}},"/commerce/invoices/{invoiceNumber}":{"get":{"tags":["Billing"],"summary":"Get detailed information about a specific invoice for a distributor or a reseller","description":"Returns detailed information about a specific invoice for a distributor or a reseller. \n\nTo filter the details for a particular end customer provide the end customer Zoom account number or CRM account number. \n<br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:billing_documents:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"getInvoiceDetail","parameters":[{"name":"invoiceNumber","in":"path","description":"The invoice number.","required":true,"schema":{"type":"string","example":"INV-5485323"}},{"name":"zoom_account_number","in":"query","description":"The Zoom account number (ZAN) for the end customer.","required":false,"schema":{"maxLength":10,"type":"string","example":"3344353452"}},{"name":"crm_account_number","in":"query","description":"The CRM account number for the end customer.","required":false,"schema":{"type":"string","example":"A-435345"}}],"responses":{"200":{"description":"The invoice details retrieved successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"invoice_number":{"type":"string","description":"The document number.","example":"INVC10235997"},"invoice_date":{"type":"string","description":"The document date.","example":"2023-10-25T00:00:00.000Z"},"customer_name":{"type":"array","description":"The end customer account name.","items":{"type":"string","example":"ABC Pvt. Ltd."}},"invoice_owner_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom Account Number for the customer or partner/reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM Account Number for the customer or partner/reseller.","example":"A-1234"},"account_name":{"type":"string","description":"The account name","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"Type of address - billTo, shipTo, soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"city name","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"postal or zip code/number","example":"95114"},"state":{"maxLength":20,"type":"string","description":"state or province","example":"PA"},"country":{"maxLength":3,"type":"string","description":"ISO code for the country","example":"US"}},"description":"Address details."}},"description":"Account details."},"sub_reseller":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom Account Number for the customer or partner/reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM Account Number for the customer or partner/reseller.","example":"A-1232"},"account_name":{"type":"string","description":"The account name","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"Type of address - billTo, shipTo, soldTo","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"city name","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"postal or zip code/number","example":"95114"},"state":{"maxLength":20,"type":"string","description":"state or province","example":"PA"},"country":{"maxLength":3,"type":"string","description":"ISO code for the country","example":"US"}},"description":"Address details"}},"description":"Account details."},"sold_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"Unique CRM Number for the contact.","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the sold to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the sold to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email ID.","example":"abc@test.com"}},"description":"Sold to contact details"},"bill_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"Unique CRM Number for the contact","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the bill to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the bill to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email ID.","example":"abc@test.com"}},"description":"Bill to contact details."},"due_date":{"type":"string","description":"The document due date.","example":"2023-11-25T00:00:00.000Z"},"payment_status":{"type":"string","description":"The status of the document: paid or unpaid.","example":"Paid","enum":["Paid","Unpaid"]},"balance":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"This field represents the sale price, list price, net amount, or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"This field represents sale price, list price, net amount, or gross amount."},"po_numbers":{"type":"string","description":"All purchase order numbers associated with this invoice.","example":"PO-10021-A, PO-10021-A1"},"billing_description":{"type":"string","description":"The description or any other detail about the document.","example":"Correcting invoice error"},"posted_date":{"type":"string","description":"The posted date for the document.","format":"YYYY-MM-DD","example":"2024-10-25"},"reason_detail":{"type":"string","description":"The reason description or detail for which this document has been generated.","example":"Correcting invoice error"},"reference_billing_document_id":{"type":"string","description":"Any other billing document associated with this invoice.","example":"8a8aa183907cc66e01907d722e307bre"},"total_tax_amount":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"This field represents the total tax amount for the invoice."},"target_date":{"type":"object","description":"This date determines which charges are to be billed. All charges that are to be billed on this date or prior will be included in the invoice.","format":"YYYY-MM-DD","example":"2024-10-25"},"invoice_items":{"maxItems":100,"type":"array","description":"The invoice items.","items":{"type":"object","properties":{"end_customer_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom Account Number for the customer or partner/reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM Account Number for the customer or partner/reseller.","example":"A-1234"},"account_name":{"type":"string","description":"The account name","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"Type of address - billTo, shipTo, soldTo","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"City name","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"Postal or Zip Code/number","example":"95114"},"state":{"maxLength":20,"type":"string","description":"State or Province","example":"PA"},"country":{"maxLength":3,"type":"string","description":"ISO code for the country","example":"US"}},"description":"Address details"}},"description":"Account details."},"charge_name":{"type":"string","description":"The name of the charge.","example":"monthly recurring charge"},"charge_type":{"type":"string","description":"The type of the charge","example":"recurring"},"is_channel_discount_applicable":{"type":"boolean","description":"Whether `z_product_class` for the offer price list is 1, 2, or 3 and the class discount applies to this charge.","example":true},"description":{"type":"string","description":"The description of the invoice item","example":"Invoice for ABC Pvt. Ltd."},"offer_name":{"type":"string","description":"The name of the offer associated with this invoice item","example":"Zoom Workplace Pro"},"offer_price_list_name":{"type":"string","description":"The offer price list name","example":"Zoom Workplace Pro Annual"},"offer_price_list_id":{"type":"string","description":"The offer price list unique identifier","example":"PRL-342923"},"start_date":{"type":"string","description":"The start date of the service period for this item. For a one-time fee item, the date of the charge.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"The end date of the service period for this item, i.e., the last day of the service period","format":"YYYY-MM-DD","example":"2022-10-25"},"subscription_number":{"type":"string","description":"The subscription number associated with this invoice item","example":"A-31231322"},"partner_sku_code":{"type":"string","description":"The unique SKU for partners.","example":"PAR1-PRO-BASE-NH1Y"},"po_number":{"type":"string","description":"The purchase order number associated with the invoice item.","example":"PO-10021-A"},"quantity":{"type":"integer","description":"The quantity of this item, in the configured unit of measure for the charge.","example":100},"tax_amount":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"This field represents the sale price, list price, net amount, or gross amount."},"total_amount":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"This field represents sale price, list price, net amount, or gross amount."}},"description":"The invoice details."}}},"description":"The invoice details."}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Unauthorized access. Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5009` <br>\n No records found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:billing_documents:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:billing_documents:admin"]}}},"/commerce/campaigns":{"get":{"tags":["Deal Registration"],"summary":"Retrieves all valid Zoom Campaigns which a deal registration can be associated with.","description":"Retrieves all valid Zoom Campaigns which a deal registration can be associated with. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:deal_registration:admin`\n\n**Not supported in Gov cluster** ","operationId":"getCampaigns","parameters":[{"name":"end_customer_crm_account_number","in":"query","description":"The CRM account number for the end customer.","required":true,"schema":{"type":"string","example":"A-3454334"}},{"name":"sub_reseller_crm_account_number","in":"query","description":"The full CRM account number for the Sub Reseller. If this is provided, campaigns related to this Sub Reseller will be returned in response.","required":false,"schema":{"type":"string","example":"A-2343245"}},{"name":"campaign_member_crm_contact_number","in":"query","description":"The full CRM contact number for the Campaign Member.","required":true,"schema":{"type":"string","example":"C-2343245"}},{"name":"product_groups","in":"query","description":"The comma separated product groups associated with a campaign. Only relevant campaigns will be returned in the response. Supported values are \"Zoom Meetings\", \"Zoom Rooms\", \"Zoom Webinars\", \"Zoom Phone\", \"Zoom for Developers\", \"Premier Support\", \"Zoom Events\", \"Global Services\", \"Zoom Apps\", \"UCaaS\", \"Event Services\", \"Zoom Revenue Accelerator\", \"Zoom One\", \"Workvivo\", \"Zoom Mesh\", \"Zoom Virtual Agent\", \"Zoom Sessions\", \"Zoom Spaces\", \"Zoom Contact Center\", \"Non-Product Specific\", \"Zoom for ISV\", \"Zoom Scheduler\", \"Zoom Platform\", \"Zoom Team Chat\", \"Zoom Workplace\", \"Zoom Doc\"","required":true,"schema":{"type":"string","example":"Zoom Workplace, Zoom Phone"}}],"responses":{"200":{"description":"Campaign detail returned successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"campaigns":{"maxItems":100,"type":"array","description":"List of campaigns.","items":{"required":["campaign_number","end_date","name","start_date"],"type":"object","properties":{"campaign_number":{"type":"number","description":"Unique campaign number.","example":3423423},"campaign_name":{"type":"string","description":"Campaign name.","example":"Zoom campaign for Education"},"campaign_description":{"type":"string","description":"Campaign description.","example":"Zoom Workplace for Education focus campaign"},"campaign_start_date":{"type":"string","description":"Campaign start date in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"campaign_end_date":{"type":"string","description":"Campaign end date in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-10-03"}},"description":"Zoom campaign details."}}},"description":"Zoom Campaigns details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:deal_registration:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:deal_registration:admin"]}}},"/commerce/deal_registration":{"post":{"tags":["Deal Registration"],"summary":"Creates a new deal registration for a partner","description":"Creates a new Deal Registration for a partner. <br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:deal_registration:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"createDealReg","parameters":[{"name":"invoice-owner-crm-account-number","in":"header","description":"The CRM account number for the Invoice Owner if it is one of the sibling accounts.","required":false,"schema":{"type":"string","example":"A-3454374"}}],"requestBody":{"description":"Creates a new deal registration for a partner.","content":{"application/json":{"schema":{"required":["currency","end_customer_contact_crm_number","end_customer_crm_account_number","end_customer_industry","estimated_close_date","estimated_mrr","met_decision_maker","opportunity_name","opportunity_type","product_groups","requires_professional_services","sales_activities","sales_rep_contact_crm_number"],"type":"object","properties":{"opportunity_type":{"type":"string","description":"The type of opportunity being registered.","example":"TSD Agent Registration","enum":["Indirect Reseller Registration","Direct Reseller Registration"]},"sub_reseller_crm_account_number":{"type":"string","description":"The sub-reseller CRM account number on whose behalf this deal is being submitted.","example":"A-3243"},"sales_rep_contact_crm_number":{"type":"string","description":"Unique identifier for the partner contact who will be the primary sales representative.","example":"C-3332"},"partner_contacts":{"maxItems":10,"type":"array","description":"Additional partner contacts who will be associated with this deal registration.","items":{"type":"object","properties":{"contact_crm_number":{"type":"string","description":"Contact's unique CRM number.","example":"C-12428"}}}},"end_customer_crm_account_number":{"type":"string","description":"CRM account number for the end customer.","example":"A-343"},"end_customer_contact_crm_number":{"type":"string","description":"Contact CRM number of the primary contact for the end customer.","example":"C-132"},"end_customer_contacts":{"maxItems":10,"type":"array","description":"Additional end customer contacts who will be associated with this deal registration.","items":{"type":"object","properties":{"contact_crm_number":{"type":"string","description":"Contact's unique CRM number.","example":"A-12428"}},"description":"Deal registration end customer contact details."}},"end_customer_department":{"maxItems":3,"type":"array","description":"End customer division or department.","items":{"type":"string","example":"Engineering","enum":["Engineering","Executives","Finance","HR","IT","Marketing","Sales","Site-Wide","Other"]}},"met_decision_maker":{"type":"boolean","description":"Set to true if the partner has met the end customer's decision maker. Defaults to false.","example":false},"decision_maker_crm_number":{"type":"string","description":"End customer decision maker contact's CRM number.","example":"C-3487284"},"budget_identified":{"type":"boolean","description":"Set to true if the partner has identified the budget with the end customer's decision maker. Defaults to false.","example":false},"is_public_sector":{"type":"boolean","description":"Set to true if the end customer is a Public Sector Customer. Defaults to false. Public Sector Customer means any United States of America Federal customer (legislative branch, executive branch, judicial branch, and military services), State and Local customer (all legislative, executive, administrative, and judicial agencies within a State, County, City, or Town), Federal System Integrator customer (government contractors doing work on behalf of or selling to Federal Agencies), Public Higher Education School or Institution customers, or Public K-12 School customers.","example":false},"buy_gov_skus":{"type":"boolean","description":"Set to true if the end customer is a public sector company and will buy Zoom for Government (ZfG) SKUs.","example":false},"end_customer_industry":{"type":"string","description":"Industry category that best describes the end customer's products/services. Supported values are Commercial, FED, SLED, Education, Federal, State & Local.","example":"Commercial","enum":["Commercial","FED","SLED","Education","Federal","State & Local"]},"opportunity_name":{"type":"string","description":"Name for the opportunity.","example":"New sales opportunity"},"opportunity_desc":{"type":"string","description":"Detailed description for the opportunity.","example":"New sales opportunity"},"estimated_close_date":{"type":"string","description":"Estimated close date for the opportunity. Should be today or a future date.","format":"YYYY-MM-DD","example":"2024-10-01"},"estimated_mrr":{"type":"integer","description":"Estimated size of the opportunity in Monthly Recurring Revenue.","example":200000},"currency":{"maxLength":3,"type":"string","description":"ISO currency code for the deal.","example":"USD"},"requires_professional_services":{"type":"boolean","description":"Set to true if any professional or managed services will be provided as part of this opportunity.","example":false},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services. Recommended if \"requires_professional_services\" is true.","example":"false"},"professional_services_delivered_by":{"type":"string","description":"Comma-separated list of PSO services delivery agents.","example":"Zoom, Partner","enum":["Zoom","Partner","Third Party"]},"phone_carrier":{"type":"string","description":"Does the customer have an existing phone carrier agreement. Supported values are \"Yes, and they want to maintain it\", \"Yes, but they are willing to switch\", \"There is no existing agreement\", \"I don’t know\".","example":"Yes, and they want to maintain it","enum":["Yes, and they want to maintain it","Yes, but they are willing to switch","There is no existing agreement","I don’t know"]},"product_groups":{"maxItems":5,"type":"array","description":"Zoom product types for which this deal will be eligible.","items":{"required":["name","quantity"],"type":"object","properties":{"name":{"type":"string","description":"Deal registration product group name.","example":"Zoom Workplace (Pro or Biz)","enum":["Zoom Workplace (Pro or Biz)","Zoom Workplace (Biz+)","Zoom Workplace (Ent Essentials)","Zoom Workplace (Ent+/Premier)","Zoom Workplace Add-Ons","Zoom Phone (standalone)","Zoom Revenue Accelerator","Zoom Contact Center","Zoom Spaces","Zoom Build Platform","Workvivo","Professional Services","Support Services","Zoom Virtual Agent","Workplace AI"]},"quantity":{"type":"integer","description":"Expected license quantity.","example":1000}}}},"campaign_number":{"type":"string","description":"Valid Zoom campaign number which influenced this deal.","example":"3245"},"sales_activities":{"maxItems":10,"type":"array","description":"Sales activities associated with this deal.","items":{"required":["date","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of sales activity. Supported values are Zoom Meeting with Customer, Onsite Meeting with Customer, Zoom Demonstration, Partner SE is Engaged.","enum":["Zoom Meeting with Customer","Onsite Meeting with Customer","Zoom Demonstration","Partner SE is Engaged"]},"date":{"type":"string","description":"Date of activity in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-25"}},"description":"Sales activities associated with the Deal Registration."}},"rfp_details":{"required":["is_rfp"],"type":"object","properties":{"is_rfp":{"type":"boolean","description":"Set to true if the opportunity is part of an existing RFP/public tender.","example":false},"rfp_link":{"type":"string","description":"The link to the RFP if publicly posted.","example":"https://www.rfplink.abc.com"},"issue_date":{"type":"string","description":"Date when the RFP was issued, in YYYY-MM-DD format. Required if is_rfp is true.","format":"YYYY-MM-DD","example":"2024-07-02"},"due_date":{"type":"string","description":"Date when the RFP is due, in YYYY-MM-DD format. Required if is_rfp is true.","format":"YYYY-MM-DD","example":"2024-09-02"}},"description":"RFP details for the deal registration."},"submitter_contact_crm_number":{"type":"string","description":"Deal submitter contact CRM number.","example":"C-3332"},"migration_type":{"type":"string","description":"Migration type if deal is being registered for an end customer through some special initiative.","example":"PBX/Zoom Hybrid Integration (HI)","enum":["PBX/Zoom Hybrid Integration (HI)","PBX/Zoom HI + some Zoom Phone Migration","Some PBX to Zoom Phone Migration, No HI","None of these","Standard VLA"]},"additional_comments":{"type":"string","description":"Additional comments or special considerations for the deal.","example":"customer retention deal"},"documents":{"maxItems":10,"type":"array","description":"Array of document or attachment IDs uploaded for the deal.","items":{"type":"object","properties":{"document_reference_id":{"type":"string","description":"Unique document number.","example":"D-1212"},"document_type":{"type":"string","description":"Type of document.","example":"Deal Registration","enum":["Deal Registration","Other"]}}}}},"description":"Deal registration details."}}}},"responses":{"201":{"description":"Deal Registration created successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"fhejfhew98ru89er3kn3oi"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"create_reference_id":{"type":"string","description":"The unique reference ID for this deal registration if created using the Deal Registration API. Use this ID for checking the status.","example":"DRR-4834729"},"deal_reg_number":{"type":"string","description":"The unique deal registration number.","example":"DL-0012"},"status":{"type":"string","description":"Status of this deal registration request.","example":"submitted","enum":["submitted","success","failure"]},"errors":{"maxItems":20,"type":"array","description":"Array of messages in case of validation or processing errors.","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"Error code.","example":"5801"},"error_description":{"type":"string","description":"Error description.","example":"Invalid end customer contact CRM number."}},"description":"Error code and message."}}},"description":"Deal registration update details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5810` <br>\n Estimated close date should be in future. <br>\n**Error Code:** `5811` <br>\n This opportunity type submission is not allowed. Please reach out to partner support. <br>\n**Error Code:** `5812` <br>\n At least one sales activity is required. <br>\n**Error Code:** `5813` <br>\n At least one product is required for deal registration. <br>\n**Error Code:** `5814` <br>\n If you have met the decision maker, please provide the decision maker contact. <br>\n**Error Code:** `5815` <br>\n If opportunity is part of an RFP (is_rfp=true), rfp_due_date and rfp_issue_date cannot be blank.  <br>\n**Error Code:** `5816` <br>\n If opportunity is part of an RFP (is_rfp=true), rfp_issue_date cannot be in the past..  <br>\n**Error Code:** `5817` <br>\n End customer industry should be from the allowed list of values. <br>\n**Error Code:** `5818` <br>\n End customer department should be from the allowed list of values. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Unauthorized access. Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  See details. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:write:deal_registration:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:write:deal_registration:admin"]}}},"/commerce/deal_registrations":{"get":{"tags":["Deal Registration"],"summary":"Gets all valid Deal Registrations for a partner","description":"Retrieves all valid deal registrations for a partner. <br><b>Note:</b> Please check the base URL for sandbox and production environments under the Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:deal_registration:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"getAllDealRegs","parameters":[{"name":"deal_reg_number","in":"query","description":"The full or partial deal registration number. Minimum of three characters required.","required":false,"schema":{"type":"string","example":"DR-2363812"}},{"name":"create_reference_id","in":"query","description":"The full or partial reference ID for this deal registration. Minimum of three characters required.","required":false,"schema":{"type":"string","example":"DRR-4834729"}},{"name":"end_customer_name","in":"query","description":"Filters results based on the end customer name. Minimum of three characters required. Characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"John"}},{"name":"end_customer_crm_account_number","in":"query","description":"Filters results based on the end customer CRM account number. Minimum of three characters required.","required":false,"schema":{"type":"string","example":"A-3454334"}},{"name":"end_customer_zoom_account_number","in":"query","description":"Filters results based on the end customer Zoom account number. Minimum of three characters required.","required":false,"schema":{"maxLength":10,"minLength":3,"type":"string","example":"4435343789"}},{"name":"sub_reseller_name","in":"query","description":"Filters results based on the sub-reseller name. Minimum of three characters required. Characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"John"}},{"name":"sub_reseller_crm_account_number","in":"query","description":"Filters results based on the sub-reseller CRM account number. Minimum of three characters required.","required":false,"schema":{"type":"string","example":"A-348742"}},{"name":"invoice_owner_crm_account_number","in":"query","description":"The full CRM account number of a sibling account. If this filter is used, only this account's deal registrations will be retrieved.","required":false,"schema":{"type":"string","example":"A-23432"}},{"name":"status","in":"query","description":"Multiple status values (except 'submit failed') can be passed in this filter, separated by comma. Maximum of 10 status values can be included in one request. By default, deal registrations with all status values except 'submit failed' are returned.","required":false,"schema":{"type":"string","example":"submitted, approved, returned","enum":["submitted","pending review","denied","returned","pending sales review","approved","expired","revoked","closed-lost","closed-won","draft","qualification","solution","proof","agreement","finalize","submit failed"]}},{"name":"date_filter_option","in":"query","description":"Filter by the expected or actual close date for the opportunity.","required":false,"schema":{"type":"string","example":"closeDate","enum":["closeDate"]}},{"name":"date_from","in":"query","description":"The start date for filtering results.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2024-10-25"}},{"name":"date_to","in":"query","description":"The end date for filtering results.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2025-10-25"}},{"name":"page_size","in":"query","description":"The number of records returned per page in the response.","required":false,"schema":{"maximum":100,"minimum":20,"type":"integer","example":50,"default":20}},{"name":"page_number","in":"query","description":"The page number for retrieving the next page of the result set.","required":false,"schema":{"type":"string","example":"2"}}],"responses":{"200":{"description":"Deal registration for a partner returned successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBdfire89tu45t9jrkfeifer9f8e"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"page_count":{"type":"integer","description":"The total number of pages in the result set.","example":20},"deal_registrations":{"maxItems":100,"type":"array","description":"The list of deal registrations.","items":{"type":"object","properties":{"deal_reg_number":{"maxLength":15,"type":"string","description":"The deal registration number for the corresponding deal registration.","example":"DL-135621"},"create_reference_id":{"type":"string","description":"The unique reference ID for this deal registration. Use this ID for checking the status.","example":"DRR-4834729"},"deal_name":{"type":"string","description":"The name for the deal.","example":"New deal for Zoom Phone"},"invoice_owner_crm_account_number":{"type":"string","description":"The CRM account number for the invoice owner.","example":"A-4567"},"opportunity_stage":{"type":"string","description":"The current stage for this deal registration.","example":"closed-won","enum":["submitted","pending review","denied","returned","pending sales review","approved","expired","revoked","closed-lost","closed-won","draft","qualification","solution","proof","agreement","finalize"]},"submitted_date":{"type":"string","description":"The date this deal registration was submitted.","format":"YYYY-MM-DD","example":"2023-10-25"},"expected_closed_date":{"type":"string","description":"The expected close date for the opportunity. Must be today or a future date.","format":"YYYY-MM-DD","example":"2024-10-25"},"estimated_mrr":{"type":"integer","description":"The estimated size of the opportunity in monthly recurring revenue.","example":1000000},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the deal currency.","example":"USD"},"program_name":{"type":"string","description":"The program under which the deal is being registered.","example":"Direct Reseller Registration","enum":["Direct Reseller Registration","Indirect Reseller Registration","TSD Agent Registration","Bill on Behalf Registration","Direct Referral Registration","Standard Referral Registration","Zoom X Registration"]},"original_expiry_date":{"type":"string","description":"The original expiration date for the deal.","format":"YYYY-MM-DD","example":"2023-10-25"},"extended_expiry_date":{"type":"string","description":"The extended expiration date for the deal.","format":"YYYY-MM-DD","example":"2023-10-25"},"partner_sales_rep":{"type":"string","description":"The partner sales representative name.","example":"John Doe"},"zoom_account_executive":{"type":"string","description":"The Zoom Account Executive associated with this deal registration.","example":"John Doe"},"zoom_cam":{"type":"string","description":"The Zoom Channel Account Manager associated with this deal registration.","example":"John Doe"},"status":{"type":"string","description":"The deal registration status.","example":"submitted","enum":["submitted","pending review","denied","returned","pending sales review","approved","expired","revoked","closed-lost","closed-won","draft","qualification","solution","proof","agreement","finalize","submit failed"]},"end_customer":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The end customer's CRM account number.","example":"A-1232"},"account_name":{"type":"string","description":"The end customer's name.","example":"ABC Pvt Ltd"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The type of address: `billTo`, `shipTo`, and `soldTo`.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city's name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The details of the address."},"department":{"type":"string","description":"The end customer's division or department.","example":"Engineering","enum":["Engineering","Executives","Finance","HR","IT","Marketing","Sales","Site-Wide"," Other"]},"industry":{"type":"string","description":"The industry category that best describes the end customer's products or services. Supported values are Commercial, FED, SLED, Education, Federal, and State & Local.","example":"Commercial","enum":["Commercial","FED","SLED","Education","Federal","State & Local"]},"account_local_name":{"type":"string","description":"The account name in local language.","example":"ABC Pvt Ltd"},"employee_count":{"type":"string","description":"The company's employee count. Supported values are 'Just Me', '2-10', '11-50', '51-250', '251-500', '501-1000', '1001-5000', '5001-10000', and '10000+'.","example":"2-10","enum":["Just Me","2-10","11-50","51-250","251-500","501-1000","1001-5000","5001-10000","10000+"]},"website":{"type":"string","description":"The company's website. Must not be any social media handle or Facebook, Google, and eBay shopping front.","example":"www.zoom.com"}},"description":"The end customer associated with the deal registration."},"opportunity":{"type":"object","properties":{"opportunity_id":{"type":"string","description":"The opportunity ID for the corresponding opportunity associated with the deal registration.","example":"a56b89"},"opportunity_name":{"type":"string","description":"The corresponding opportunity's name.","example":"New sales opportunity"},"opportunity_type":{"type":"string","description":"The corresponding opportunity type.","example":"Sales Channel"},"expected_close_date":{"type":"string","description":"The expected or actual close date for this deal.","format":"YYYY-MM-DD","example":"2023-10-25"},"partner_role":{"type":"string","description":"The role the partner has in this opportunity: Deal Registration, Partner Assist, Incumbent Partner, Fulfilment, and so on.","example":"Deal Registration","enum":["Deal Registration","Partner Assist","Incumbent Partner","Fulfilment","Standard Transaction"]},"channel_sales_motion":{"type":"string","description":"The channel sales motion associated with the opportunity: Direct Reseller, Indirect Reseller, Referral, and so on.","example":"Direct Reseller","enum":["Direct Reseller","Indirect Reseller"]}},"description":"The opportunity's details."}},"description":"The deal registration's summary."}}},"description":"The deal registration's details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5201` <br>\n The deal registration number should be at least three characters. <br>\n**Error Code:** `5202` <br>\n The deal registration create reference ID should be at least three characters. <br>\n**Error Code:** `5203` <br>\n The end customer account name should be at least three characters. <br>\n**Error Code:** `5204` <br>\n The CRM account number should be at least three characters. <br>\n**Error Code:** `5205` <br>\n The Zoom account number should be at least three characters. <br>\n**Error Code:** `5247` <br>\n 'submit failed' status filter cannot be included with other status values <br>\n**Error Code:** `5000` <br>\n Invalid character & or | in the name filter. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:deal_registration:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:deal_registration:admin"]}}},"/commerce/deal_registrations/{dealRegKey}":{"get":{"tags":["Deal Registration"],"summary":"Get details of a deal registration by registration number","description":"Retrieve details for a deal registration by the deal registration number. \n\n**Note** Check the base URL for sandbox and production environments under the Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:deal_registration:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"getDealRegDetails","parameters":[{"name":"dealRegKey","in":"path","description":"A unique deal registration key. It can be either the deal registration number or deal registration reference ID.","required":true,"schema":{"type":"string","example":"DRR-42432"}}],"responses":{"200":{"description":"Deal registration details returned successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"nckjseyr83ri3nr3wehqijnrtiu4uyrt8"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"deal_reg_number":{"maxLength":15,"type":"string","description":"The deal registration number for the corresponding deal registration.","example":"DL-135621"},"create_reference_id":{"type":"string","description":"The unique reference ID for this deal registration if created using the **Deal Registration** API. Use this ID for checking the status.","example":"DRR-4834729"},"deal_name":{"type":"string","description":"The deal's name.","example":"New deal for Zoom Phone"},"deal_description":{"type":"string","description":"The deal's description.","example":"New deal for Zoom Phone"},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the deal currency.","example":"USD"},"program_name":{"type":"string","description":"The type of opportunity being registered.","example":"TSD Agent Registration","enum":["Direct Reseller Registration","Indirect Reseller Registration","TSD Agent Registration","Bill on Behalf Registration","Direct Referral Registration","Standard Referral Registration","Zoom X Registration"]},"opportunity_stage":{"type":"string","description":"The current stage for this deal registration.","example":"closed-won","enum":["submitted","pending review","denied","returned","pending sales review","approved","expired","revoked","closed-lost","closed-won","draft","qualification","solution","proof","agreement","finalize","discovery","review","submitted"]},"submitted_date":{"type":"string","description":"The date this deal registration was submitted.","format":"YYYY-MM-DD","example":"2023-10-25"},"approved_date":{"type":"string","description":"The date this deal registration was approved.","format":"YYYY-MM-DD","example":"2023-10-25"},"denied_date":{"type":"string","description":"The date this deal registration was denied.","format":"YYYY-MM-DD","example":"2023-10-25"},"expected_close_date":{"type":"string","description":"The expected close date for the deal.","format":"YYYY-MM-DD","example":"2023-10-25"},"partner_role":{"type":"string","description":"The role the partner has in this deal: Deal Registration, Partner Assist, Incumbent Partner, Fulfilment, and so on.","example":"Deal Registration","enum":["Deal Registration","Partner Assist","Incumbent Partner","Fulfilment","Standard Transaction"]},"original_expiry_date":{"type":"string","description":"The original expiration date for the deal.","format":"YYYY-MM-DD","example":"2023-10-25"},"extended_expiry_date":{"type":"string","description":"The extended expiration date for the deal.","format":"YYYY-MM-DD","example":"2023-10-25"},"sales_representative":{"type":"object","properties":{"self_sales_representative":{"type":"boolean","description":"True if the partner is the sales representative for this deal.","example":true},"sales_rep_contact":{"required":["contact_crm_number"],"type":"object","properties":{"contact_crm_number":{"type":"string","description":"The contact's unique CRM number.","example":"A-12428"},"first_name":{"type":"string","description":"The contact's first name.","example":"Tracy"},"last_name":{"type":"string","description":"The contact's last name.","example":"Smith"},"email":{"type":"string","description":"The contact's company email ID. The email domain should be the same as the account domain.","example":"tsmith@somecompany.com"},"title":{"type":"string","description":"The contact's job title.","example":"Account Executive"},"phone":{"type":"string","description":"The contact's business phone number.","example":"192837489342"}},"description":"The deal registration's contact details."}},"description":"The deal registration's sales representative."},"submitter":{"required":["contact_crm_number"],"type":"object","properties":{"contact_crm_number":{"type":"string","description":"The contact's unique CRM number.","example":"A-12428"},"first_name":{"type":"string","description":"The contact's first name.","example":"Tracy"},"last_name":{"type":"string","description":"The contact's last name.","example":"Smith"},"email":{"type":"string","description":"The contact's company email ID. The email domain should be the same as the account domain.","example":"tsmith@somecompany.com"},"title":{"type":"string","description":"The contact's job title.","example":"Account Executive"},"phone":{"type":"string","description":"The contact's business phone number.","example":"192837489342"}},"description":"The deal registration's contact details."},"related_partner":{"type":"string","description":"Any other partner account related to this deal.","example":"A-1232"},"partner_contacts":{"type":"array","description":"The additional partner contacts who are associated with this deal registration.","items":{"required":["contact_crm_number"],"type":"object","properties":{"contact_crm_number":{"type":"string","description":"The contact's unique CRM number.","example":"A-12428"},"first_name":{"type":"string","description":"The contact's first name.","example":"Tracy"},"last_name":{"type":"string","description":"The contact's last name.","example":"Smith"},"email":{"type":"string","description":"The contact's company email ID. The email domain should be the same as the account domain.","example":"tsmith@somecompany.com"},"title":{"type":"string","description":"The contact's job title.","example":"Account Executive"},"phone":{"type":"string","description":"The contact's business phone number.","example":"192837489342"}},"description":"The deal registration's contact details."}},"is_existing_customer":{"type":"boolean","description":"True if the deal registration is for an existing end customer. False if this is a new customer.","example":false},"sub_reseller":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The sub-reseller's CRM account number.","example":"A-1232"},"account_name":{"type":"string","description":"The sub-reseller's name.","example":"ABC Pvt Ltd"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The type of address: billTo, shipTo, and soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city's name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The details of the address."}},"description":"The sub-reseller associated with the deal registration."},"invoice_owner":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The distributor's CRM account number.","example":"A-1232"},"account_name":{"type":"string","description":"The distributor's name.","example":"ABC Distributors Inc"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The type of address: billTo, shipTo, and soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city's name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The details of the address."}},"description":"The distributor associated with the deal registration."},"end_customer":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The end customer's CRM account number.","example":"A-1232"},"account_name":{"type":"string","description":"The end customer's name.","example":"ABC Pvt Ltd"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The type of address: billTo, shipTo, and soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city's name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The details of the address."},"department":{"type":"string","description":"The end user's customer division or department.","example":"Engineering","enum":["Engineering","Executives","Finance","HR","IT","Marketing","Sales","Site-Wide"," Other"]},"industry":{"type":"string","description":"The industry category that best describes the end customer's products/services. Supported values are Commercial, FED, SLED, Education, Federal, or State & Local.","example":"Commercial","enum":["Commercial","FED","SLED","Education","Federal","State & Local"]},"account_local_name":{"type":"string","description":"The account name in local language.","example":"ABC Pvt Ltd"},"employee_count":{"type":"string","description":"The company's employee count. Supported values are 'Just Me', '2-10', '11-50', '51-250', '251-500', '501-1000', '1001-5000', '5001-10000', or '10000+'.","example":"2-10","enum":["Just Me","2-10","11-50","51-250","251-500","501-1000","1001-5000","5001-10000","10000+"]},"website":{"type":"string","description":"The company's website.","example":"www.zoom.com"}},"description":"The end customer associated with the deal registration."},"end_customer_primary_contact":{"required":["contact_crm_number"],"type":"object","properties":{"contact_crm_number":{"type":"string","description":"The contact's unique CRM number.","example":"A-12428"},"first_name":{"type":"string","description":"The contact's first name.","example":"Tracy"},"last_name":{"type":"string","description":"The contact's last name.","example":"Smith"},"email":{"type":"string","description":"The contact's company email ID. The email domain should be the same as the account domain.","example":"tsmith@somecompany.com"},"title":{"type":"string","description":"The contact's job title.","example":"Account Executive"},"phone":{"type":"string","description":"The contact's business phone number.","example":"192837489342"},"end_customer_contact_domain_reason":{"type":"string","description":"The reason or justification for public domain for the end customer's contact email.","example":"To be provided by customer later"}},"description":"The deal registration's contact details."},"end_customer_other_contacts":{"type":"array","description":"The additional end customer contacts who will be associated with this deal registration.","items":{"required":["contact_crm_number"],"type":"object","properties":{"contact_crm_number":{"type":"string","description":"The contact's unique CRM number.","example":"A-12428"},"first_name":{"type":"string","description":"The contact's first name.","example":"Tracy"},"last_name":{"type":"string","description":"The contact's last name.","example":"Smith"},"email":{"type":"string","description":"The contact's company email ID. The email domain should be the same as the account domain.","example":"tsmith@somecompany.com"},"title":{"type":"string","description":"The contact's job title.","example":"Account Executive"},"phone":{"type":"string","description":"The contact's business phone number.","example":"192837489342"},"end_customer_contact_domain_reason":{"type":"string","description":"The reason or justification for public domain for the end customer's contact email.","example":"To be provided by customer later"}},"description":"The deal registration's contact details."}},"end_customer_website_details":{"type":"object","properties":{"empty_website":{"type":"boolean","description":"True if the end customer doesn't have a website. Default is `false`.","example":false,"default":false},"empty_website_reason":{"type":"string","description":"The reason why the website is blank. This field is mandatory if `empty_website` is `true`.","example":"To be provided by customer"},"public_website_reason":{"type":"string","description":"The justification if the website is a public domain.","example":"To be provided by customer"}},"description":"The account website's details."},"is_public_sector":{"type":"boolean","description":"True if the end customer is a public sector customer. Public sector customer means any United States of America federal customer (legislative branch, executive branch, judicial branch, and military services), State and Local customer (all legislative, executive, administrative, and judicial agencies within a State, County, City, or Town), Federal System Integrator customer (government contractors doing work on behalf of (sell-through) or selling to Federal Agencies), Public Higher Education School or Institution customers, or Public K-12 School customers.","example":false},"budget_identified":{"type":"boolean","description":"True if the partner has identified the budget with the end customer's decision maker.","example":false},"buy_gov_skus":{"type":"boolean","description":"True if the end customer is a public sector company and will buy Zoom for Government (ZfG) SKUs.","example":false},"met_decision_maker":{"type":"boolean","description":"True if the partner has met the end customer's decision maker.","example":false},"decision_maker_email":{"type":"string","description":"The email ID for the end customer decision maker.","example":"abc@test.com"},"decision_maker_name":{"type":"string","description":"The name of the decision maker.","example":"John Doe"},"estimated_mrr":{"type":"integer","description":"The estimated size of the opportunity in monthly recurring revenue.","example":100000},"requires_professional_services":{"type":"boolean","description":"True if any professional or managed services are provided as part of this opportunity.","example":false},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services if \"requires_professional_services\" is true.","example":"Partner will provide this service."},"professional_services_delivered_by":{"type":"string","description":"Comma-separated list of PSO services delivery agents.","example":"Zoom, Partner","enum":["Zoom","Partner","Third Party"]},"phone_carrier":{"type":"string","description":"Whether the customer has an existing phone carrier agreement. Supported values are \"Yes, and they want to maintain it\", \"Yes, but they are willing to switch\", \"There is no existing agreement\", and \"I don't know\".","example":"There is no existing agreement","enum":["Yes, and they want to maintain it","Yes, but they are willing to switch","There is no existing agreement","I don't know"]},"product_groups":{"type":"array","description":"The Zoom product types for which this deal is eligible.","items":{"required":["name","quantity"],"type":"object","properties":{"name":{"type":"string","description":"Deal registration product group name.","example":"Zoom Workplace (Pro or Biz)","enum":["Zoom Workplace (Pro or Biz)","Zoom Workplace (Biz+)","Zoom Workplace (Ent Essentials)","Zoom Workplace (Ent+/Premier)","Zoom Workplace Add-Ons","Zoom Phone (standalone)","Zoom Revenue Accelerator","Zoom Contact Center","Zoom Spaces","Zoom Build Platform","Workvivo","Professional Services","Support Services","Zoom Virtual Agent","Workplace AI"]},"quantity":{"type":"integer","description":"The license quantity.","example":1000}}}},"campaign":{"type":"string","description":"The Zoom campaign that influenced this deal.","example":"Global Zoom Phone Launch"},"sales_activities":{"type":"array","description":"The sales activities associated with this deal.","items":{"required":["date","type"],"type":"object","properties":{"sales_activity_number":{"type":"string","description":"Unique identifier for the sales activity.","example":"ZDRA00011"},"type":{"type":"string","description":"The type of sales activity. Supported values are Zoom Meeting with Customer, Onsite Meeting with Customer, Zoom Demonstration, and Partner SE is Engaged.","example":"Zoom Meeting with Customer","enum":["Zoom Meeting with Customer","Onsite Meeting with Customer","Zoom Demonstration","Partner SE is Engaged"]},"date":{"type":"string","description":"The date of activity in `YYYY-MM-DD` format.","format":"YYYY-MM-DD","example":"2023-10-25"}},"description":"The sales activities associated with the deal registration."}},"rfp_details":{"type":"object","properties":{"is_rfp":{"type":"boolean","description":"True if the opportunity is part of existing RFP or public tender.","example":false},"rfp_link":{"type":"string","description":"The link to the RFP if publicly posted.","example":"https://www.rfplink.example.com"},"issue_date":{"type":"string","description":"The date when the RFP was issued, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-25"},"due_date":{"type":"string","description":"The date when the RFP is due, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-25"}},"description":"The RFP details for the deal registration."},"zoom_cams":{"type":"object","properties":{"zoom_territory_cam":{"type":"string","description":"The Zoom territory channel account manager.","example":"John Doe"},"zoom_named_cam":{"type":"string","description":"The account manager for the Zoom named channel.","example":"John Doe"},"zoom_distribution_cam":{"type":"string","description":"The account manager for the Zoom distribution channel.","example":"John Doe"}},"description":"The Zoom channel account managers."},"additional_comments":{"type":"string","description":"The additional comments or special considerations for the deal.","example":"customer retention"},"opportunity":{"type":"object","properties":{"opportunity_number":{"type":"string","description":"The opportunity number for the corresponding opportunity associated with the deal registration.","example":"a56b89"},"opportunity_name":{"type":"string","description":"The corresponding opportunity name.","example":"New sales opportunity"},"opportunity_type":{"type":"string","description":"The corresponding opportunity type.","example":"Sales Channel"},"partner_role":{"type":"string","description":"The role partner has in this opportunity: Deal Registration, Partner Assist, Incumbent Partner, Fulfilment, and so on.","example":"Deal Registration","enum":["Deal Registration","Partner Assist","Incumbent Partner","Fulfilment"]},"channel_sales_motion":{"type":"string","description":"The channel sales motion associated with the opportunity: Direct Reseller, Indirect Reseller, Referral, and so on.","example":"Direct Reseller","enum":["Direct Reseller","Indirect Reseller"]},"expected_close_date":{"type":"string","description":"The expected close date for the opportunity.","format":"YYYY-MM-DD","example":"2023-10-25"}},"description":"The opportunity's details."},"status":{"type":"string","description":"The deal registration's status.","example":"submitted","enum":["submitted","pending review","denied","returned","pending sales review","approved","expired","revoked","closed-lost","closed-won","draft","qualification","solution","proof","agreement","finalize","failure","submit failed"]},"status_detail":{"type":"object","properties":{"return_reason":{"type":"string","description":"The reason why the deal registration request was returned.","example":"RFP link is invalid."},"revoke_reason":{"type":"string","description":"The reason why the deal registration request was revoked.","example":"A duplicate deal registration is in progress."},"denied_reason":{"type":"string","description":"The reason the deal registration request was denied.","example":"The customer is not compliant for the requested deal."},"other_comments":{"type":"string","description":"Any additional comment related to current status.","example":"Conditional approval."},"failure_reason":{"type":"string","description":"Failure error message if status is 'submit failed'.","example":"Time out."}},"description":"The details in case the deal registration request has been returned without approval."},"documents":{"maxItems":10,"type":"array","description":"Documents associated with this deal registration.","items":{"type":"object","properties":{"document_reference_id":{"type":"string","description":"Unique reference ID for the document.","example":"DOC-1234"},"document_note":{"maxLength":1000,"type":"string","description":"Note associated with the document.","example":"Latest purchase order."},"document_type":{"type":"string","description":"Type of document.","example":"Deal Registration","enum":["Deal Registration","Other"]}}}},"migration_type":{"type":"string","description":"Migration type if deal is being registered for an end customer through some special initiative.","example":"PBX/Zoom Hybrid Integration (HI)","enum":["PBX/Zoom Hybrid Integration (HI)","PBX/Zoom HI + some Zoom Phone Migration","Some PBX to Zoom Phone Migration, No HI","None of these","Standard VLA"]}},"description":"The deal registration's details."}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5009` <br>\n No records found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:deal_registration:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:deal_registration:admin"]}},"patch":{"tags":["Deal Registration"],"summary":"Updates an existing deal registration","description":"Updates an existing deal registration that has been returned (Deal status = returned). <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:deal_registration:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"Updatesanexistingdealregistration","parameters":[{"name":"dealRegKey","in":"path","description":"A unique deal registration key. This can be either the deal registration number or deal registration reference ID.","required":true,"schema":{"type":"string","example":"DRR-42432"}}],"requestBody":{"description":"Updates an existing deal registration for a partner.","content":{"application/json":{"schema":{"type":"object","properties":{"sales_rep_contact_crm_number":{"type":"string","description":"Unique identifier for the partner contact who will be the primary sales representative.","example":"C-3332"},"add_partner_contacts":{"maxItems":10,"type":"array","description":"Additional partner contacts to be associated with this deal registration.","items":{"type":"object","properties":{"contact_crm_number":{"type":"string","description":"Contact's unique CRM number.","example":"C-12428"}}}},"add_end_customer_contacts":{"maxItems":10,"type":"array","description":"Additional end customer contacts to be associated with this deal registration.","items":{"type":"object","properties":{"contact_crm_number":{"type":"string","description":"Contact's unique CRM number.","example":"A-12428"}},"description":"Deal registration end customer contact details."}},"end_customer_department":{"maxItems":3,"type":"array","description":"End customer division or department.","items":{"type":"string","example":"Engineering","enum":["Engineering","Executives","Finance","HR","IT","Marketing","Sales","Site-Wide","Other"]}},"met_decision_maker":{"type":"boolean","description":"Set to true if the partner has met the end customer's decision maker. Defaults to false.","example":false},"decision_maker_crm_number":{"type":"string","description":"End customer decision maker contact's CRM number.","example":"C-3487284"},"budget_identified":{"type":"boolean","description":"Set to true if the partner has identified the budget with the end customer's decision maker. Defaults to false.","example":false},"is_public_sector":{"type":"boolean","description":"Set to true if the end customer is a Public Sector Customer. Defaults to false. Public Sector Customer means any United States of America Federal customer (legislative branch, executive branch, judicial branch, and military services), State and Local customer (all legislative, executive, administrative, and judicial agencies within a State, County, City, or Town), Federal System Integrator customer (government contractors doing work on behalf of or selling to Federal Agencies), Public Higher Education School or Institution customers, or Public K-12 School customers.","example":false},"buy_gov_skus":{"type":"boolean","description":"Set to true if the end customer is a public sector company and will buy Zoom for Government (ZfG) SKUs.","example":false},"end_customer_industry":{"type":"string","description":"Industry category that best describes the end customer's products/services. Supported values are Commercial, FED, SLED, Education, Federal, State & Local.","example":"Commercial","enum":["Commercial","FED","SLED","Education","Federal","State & Local"]},"opportunity_name":{"type":"string","description":"Name for the opportunity.","example":"New sales opportunity"},"opportunity_desc":{"type":"string","description":"Detailed description for the opportunity.","example":"New sales opportunity"},"estimated_close_date":{"type":"string","description":"Estimated close date for the opportunity. Should be today or a future date.","format":"YYYY-MM-DD","example":"2024-10-01"},"estimated_mrr":{"type":"integer","description":"Estimated size of the opportunity in Monthly Recurring Revenue.","example":200000},"currency":{"maxLength":3,"type":"string","description":"ISO code for the deal.","example":"USD"},"requires_professional_services":{"type":"boolean","description":"Set to true if any professional or managed services will be provided as part of this opportunity.","example":false},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if \"requires_professional_services\" is true.","example":"false"},"professional_services_delivered_by":{"type":"string","description":"Comma-separated list of PSO services delivery agents.","example":"Zoom, Partner","enum":["Zoom","Partner","Third Party"]},"phone_carrier":{"type":"string","description":"Does the customer have an existing phone carrier agreement. Supported values are \"Yes, and they want to maintain it\", \"Yes, but they are willing to switch\", \"There is no existing agreement\", \"I don’t know\".","example":"Yes, and they want to maintain it","enum":["Yes, and they want to maintain it","Yes, but they are willing to switch","There is no existing agreement","I don’t know"]},"add_product_groups":{"maxItems":5,"type":"array","description":"Additional Zoom product types for which this deal will be eligible.","items":{"required":["name","quantity"],"type":"object","properties":{"name":{"type":"string","description":"Deal registration product group name.","example":"Zoom Workplace (Pro or Biz)","enum":["Zoom Workplace (Pro or Biz)","Zoom Workplace (Biz+)","Zoom Workplace (Ent Essentials)","Zoom Workplace (Ent+/Premier)","Zoom Workplace Add-Ons","Zoom Phone (standalone)","Zoom Revenue Accelerator","Zoom Contact Center","Zoom Spaces","Zoom Build Platform","Workvivo","Professional Services","Support Services","Zoom Virtual Agent","Workplace AI"]},"quantity":{"type":"integer","description":"Expected license quantity.","example":1000}}}},"remove_product_groups":{"maxItems":5,"type":"array","description":"Zoom product types to remove from this deal.","items":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Deal registration product group name.","example":"Zoom Workplace (Pro or Biz)","enum":["Zoom Workplace (Pro or Biz)","Zoom Workplace (Biz+)","Zoom Workplace (Ent Essentials)","Zoom Workplace (Ent+/Premier)","Zoom Workplace Add-Ons","Zoom Phone (standalone)","Zoom Revenue Accelerator","Zoom Contact Center","Zoom Spaces","Zoom Build Platform","Workvivo","Professional Services","Support Services","Zoom Meetings (standalone)","Zoom One (without Phone)","Zoom Events & Webinar","Other","Zoom One (with Phone)","Zoom Virtual Agent","Workplace AI"]}}}},"campaign_number":{"type":"string","description":"Valid Zoom campaign number that influenced this deal.","example":"3245"},"sales_activities":{"maxItems":10,"type":"array","description":"Sales activities associated with this deal.","items":{"required":["date","type"],"type":"object","properties":{"sales_activity_number":{"type":"string","description":"Sales activity number for the activity to update. Leave this blank if a new sales activity needs to be added.","example":"ZDRA00011"},"type":{"type":"string","description":"Type of sales activity. Supported values are Zoom Meeting with Customer, Onsite Meeting with Customer, Zoom Demonstration, Partner SE is Engaged.","enum":["Zoom Meeting with Customer","Onsite Meeting with Customer","Zoom Demonstration","Partner SE is Engaged"]},"date":{"type":"string","description":"Date of activity in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-25"}},"description":"Sales activities associated with the deal registration."}},"rfp_details":{"required":["is_rfp"],"type":"object","properties":{"is_rfp":{"type":"boolean","description":"Set to true if the opportunity is part of an existing RFP/public tender.","example":false},"rfp_link":{"type":"string","description":"The link to the RFP if publicly posted.","example":"https://www.rfplink.abc.com"},"issue_date":{"type":"string","description":"Date when the RFP was issued, in YYYY-MM-DD format. Required if is_rfp is true.","format":"YYYY-MM-DD","example":"2024-07-02"},"due_date":{"type":"string","description":"Date when the RFP is due, in YYYY-MM-DD format. Required if is_rfp is true.","format":"YYYY-MM-DD","example":"2024-09-02"}},"description":"RFP details for the deal registration."},"submitter_contact_crm_number":{"type":"string","description":"Deal submitter contact CRM number.","example":"C-3332"},"additional_comments":{"type":"string","description":"Additional comments or special considerations for the deal.","example":"customer retention deal"},"documents":{"maxItems":10,"type":"array","description":"Array of document or attachment IDs uploaded for the deal.","items":{"type":"object","properties":{"document_reference_id":{"type":"string","description":"Unique document number.","example":"D-1212"},"document_type":{"type":"string","description":"Type of document.","example":"Deal Registration","enum":["Deal Registration","Other"]}}}}},"description":"Deal registration details."}}}},"responses":{"200":{"description":"Deal registration updated successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string"}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5810` <br>\n Estimated close date should be in the future. <br>\n**Error Code:** `5814` <br>\n If you have met the decision maker, please provide the decision maker's contact. <br>\n**Error Code:** `5815` <br>\n If the opportunity is part of an RFP (`is_rfp`=true), `rfp_due_date` and `rfp_issue_date` cannot be blank. <br>\n**Error Code:** `5817` <br>\n End customer industry should be from the allowed list of values. <br>\n**Error Code:** `5818` <br>\n End customer department should be from the allowed list of values. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  See details. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition that prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:write:deal_registration:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:write:deal_registration:admin"]}}},"/commerce/order":{"post":{"tags":["Order"],"summary":"Create a subscription order for a Zoom partner","description":"Create a subscription order for a Zoom partner's end customers. One order can have more than one subscription for more than one end customer. The same order can create a new subscription and also amend an existing subscription. \n**Note** Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:order:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`\n\n**Not supported in Gov cluster** ","operationId":"createOrder","parameters":[{"name":"invoice-owner-crm-account-number","in":"header","description":"The CRM account number for the invoice owner if it is one of the sibling accounts.","required":false,"schema":{"type":"string","example":"A-3454374"}}],"requestBody":{"description":"Create an order for a Zoom partner.","content":{"application/json":{"schema":{"required":["header"],"type":"object","properties":{"header":{"required":["order_date"],"type":"object","properties":{"order_type":{"type":"string","description":"The order's type. Supported values are 'trial' and 'sale'.","example":"sale","default":"sale","enum":["trial","sale"]},"order_description":{"maxLength":500,"type":"string","description":"The order's description.","example":"New Contact Center subscription for ABC Pvt. Ltd."},"deal_reg_number":{"type":"string","description":"The registration number of the deal registered by either a partner or a reseller.","example":"DELREG-1002-L1"},"order_date":{"type":"string","description":"The order date in `YYYY-MM-DD` format.","format":"YYYY-MM-DD","example":"2023-10-03"},"po_number":{"type":"string","description":"The purchase order's number.","example":"PO-10021-A"},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this order.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}}},"description":"The order header's details."},"create_subscriptions":{"maxItems":1,"type":"array","description":"The order details for creating a new subscription.","items":{"required":["currency","end_customer_crm_account_number","initial_term","sold_to_crm_contact_number"],"type":"object","properties":{"end_customer_account_number":{"maxLength":10,"type":"string","description":"The end customer's Zoom account number.","example":"5333445346"},"end_customer_crm_account_number":{"type":"string","description":"The CRM account number for the end customer.","example":"A-3454334"},"sold_to_crm_contact_number":{"type":"string","description":"The CRM contact's number for the 'sold to contact'.","example":"C-232442"},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer. If left blank, this defaults to a language based on the end customer's country.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"initial_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The subscription term's type. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, and 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"}},"description":"The subscription's initial term."},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The subscription term's type. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, and 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's renewal term. Required for paid subscriptions (order_type = sale)."},"sub_reseller":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The sub-reseller's CRM account number.","example":"A-45r33"},"account_name":{"type":"string","description":"The sub-reseller's name.","example":"Novam Corp."}},"description":"The sub-reseller's account number. This input will be ignored if a deal registration number has been provided in the request. The sub-reseller associated with that deal registration will be associated with this order request."},"service_start_date":{"type":"string","description":"The service start date. It should be equal to or before `paid_period_start_date`.","format":"YYYY-MM-DD","example":"2024-03-20"},"paid_period_start_date":{"type":"string","description":"The subscription paid period start date. Required if the subscription has a free period.","format":"YYYY-MM-DD","example":"2024-03-20"},"free_months_reason_code":{"type":"string","description":"The reason for requesting free period in the subscription. Required if the subscription has a free period.","example":"Customer's Desired Billing/Start Date","enum":["Customer's Desired Billing/Start Date","Billing at Later Date for Other Reason","Align to Customer's Renewal Date"]},"currency":{"maxLength":3,"type":"string","description":"Subscription currency in a three-letter ISO currency code.","example":"CAD"},"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of each term. Defaults to `true`. Only applicable for `createSubscription` order action if the initial term type is TERMED.","example":true,"default":true},"add_offers":{"maxItems":10,"type":"array","description":"New offers to be added to a subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription's end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Recording storage capacity in GB"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute's details."}}},"description":"The subscription plan's details."}},"add_add_ons":{"maxItems":10,"type":"array","description":"The new add-ons to be added to a subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription's end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}}},"description":"The subscription's plan details."}},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if 'requires_professional_services' is set to 'Yes, Zoom will do the deployment'.","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if `is_zoom_pso_org_engaged` is set to `Yes and I have a PSO Engagement Request ID`.","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details. Required with 'deployment_partner_name'."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment'."},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if `requires_professional_services` is true.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Creates a new subscription order."}},"amend_subscriptions":{"maxItems":1,"type":"array","description":"The order details for amending an existing subscription.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"The subscription number of the subscription being updated. Required for a paid subscription amendment.","example":"A-31231322"},"zoom_account_number":{"type":"string","description":"The end customer Zoom account number. Required for amend trial order. This field is ignored for paid subscription amendments.","example":"3428342132"},"add_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be added in the subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price's list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}}},"description":"The subscription plan details."}},"add_add_ons":{"maxItems":5,"type":"array","description":"The offer details for add-ons to be added in the subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer's price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}}},"description":"The subscription plan details."}},"upgrade_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be upgraded in the subscription. Not applicable for trial amendment order.","items":{"required":["start_date"],"type":"object","properties":{"new_offer_price_list_id":{"type":"string","description":"The new offer price list ID.","example":"Off-2323"},"new_partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"old_offer_price_list_id":{"type":"string","description":"The existing offer price list ID.","example":"Off-2564"},"old_partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"old_subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}}},"description":"Cancels and replaces the subscription plan amendment."}},"remove_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be removed from the subscription.","items":{"required":["end_date","offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID for the offer to be removed from the subscription.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"end_date":{"type":"string","description":"The date when the offer will be removed. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"remove_reason":{"type":"string","description":"The reason for cancellation.","example":"Downsell"}},"description":"Remove subscription plan."}},"update_offers":{"maxItems":5,"type":"array","description":"Update terms and quantity of an offer or add-on.","items":{"required":["offer_price_list_id","start_date"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"Offer price list ID for the offer to be updated.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"Change start date. Should be between today and subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"Offer specific attributes like number of hosts, participant capacity, etc.","items":{"type":"object","properties":{"name":{"type":"string","description":"Attribute name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"Attribute value.","example":"10"}},"description":"Offer attribute details."}}},"description":"Subscription update details."}},"cancel_subscription":{"required":["cancel_reason"],"type":"object","properties":{"cancel_by":{"type":"string","description":"When the subscription will be cancelled. Required for paid subscriptions. Currently only 'EndOfCurrentTerm' is supported.","example":"EndOfCurrentTerm","enum":["EndOfCurrentTerm","EndOfLastInvoicePeriod","SpecificDate"]},"cancel_on":{"type":"string","description":"Must be provided if cancel_by is SpecificDate.","format":"YYYY-MM-DD","example":"2023-10-03"},"cancel_reason":{"maxLength":250,"type":"string","description":"Reason for cancellation.","example":"Downsell"}},"description":"Cancellation details."},"renew_subscription":{"type":"object","properties":{"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"Start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"End date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"Subscription initial, renewal or current term."}},"description":"Renewal details."},"update_subscription":{"type":"object","properties":{"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of each term. Only applicable if the initial term type is TERMED. If auto_renew is true, providing renewal_term is required.","example":true},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's renewal term. Required for paid subscriptions (order_type = sale)."},"sold_to_crm_contact_number":{"type":"string","description":"CRM contact number for the sold to contact.","example":"C-232442"},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if 'requires_professional_services' is set to 'Yes, Zoom will do the deployment'.","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if `is_zoom_pso_org_engaged` is set to `Yes and I have a PSO Engagement Request ID`.","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The country's ISO code.","example":"US"}},"description":"The address details. Required with 'deployment_partner_name'."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment'."},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if `requires_professional_services` is true.","example":"Zoom phone professional services"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Update paid subscription attributes."},"update_trial_subscription":{"type":"object","properties":{"extend_trial_offers":{"maxItems":10,"type":"array","description":"Offers requiring trial period extension.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer's price list ID.","example":"PRL-3683272383"}}}}},"description":"Update trial subscription attributes."}},"description":"Amend order request details."}}},"description":"Order request details."}}}},"responses":{"201":{"description":"Order created successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBvfrtu94t4kntr4eiruoejf094"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of the order. Supported values are: `failedToSubmit`, `completed`, `canceled`, `submitted`, `failed`.","example":"submitted","enum":["failedToSubmit","completed","canceled","submitted","failed"]},"order_reference_id":{"type":"string","description":"Reference ID for an order.","example":"OR-3248714941"},"order_number":{"type":"string","description":"The order number is provided when the order is successfully submitted or completed.","example":"O-32487149"},"order_date":{"type":"string","description":"The date when order should be placed in the billing system.","format":"YYYY-MM-DD","example":"2023-10-03"},"subscriptions":{"maxItems":1,"type":"array","description":"Array of subscription numbers and their statuses in an order.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"Subscription number of the subscription included in this order.","example":"A-31231322"},"zoom_account_number":{"type":"string","description":"End customer zoom account number of the subscription included in this order.","example":"3578345739"},"subscription_status":{"type":"string","description":"Status of the subscription. Supported values are `active`, `pending_activation`, `pending_acceptance`, `cancelled`, `suspended`, or `expired`.","example":"active","enum":["active","pending_activation","pending_acceptance","cancelled","suspended","expired"]},"subscription_owner_id":{"type":"string","description":"The subscription owner billing account ID.","example":"A-3454334"},"invoice_owner_id":{"type":"string","description":"The invoice owner billing account ID.","example":"A-34547634"},"invoice_owner_crm_account_number":{"type":"string","description":"The CRM account number for the Invoice Owner.","example":"A-3454374"}},"description":"Order subscription details."}},"errors":{"maxItems":20,"type":"array","description":"Array of messages in case of validation or processing errors.","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"Error code.","example":"5604"},"error_description":{"type":"string","description":"Error description.","example":"No pricebook exists with given offer_price_list_id."}},"description":"Error code and message."}}},"description":"Order details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5662` <br>\n Sub Reseller account number is invalid or not associated with Partner. <br>\n**Error Code:** `5692` <br>\n End customer CRM Number or Zoom account number is not associated with Partner. <br>\n**Error Code:** `5147` <br>\n No account found for the CRM account number. <br>\n**Error Code:** `5601` <br>\n `Cancel_on` is required when `cancel_by` is `SpecificDate`. <br>\n**Error Code:** `5604` <br>\n No pricebook exists with given offer_price_list_id. <br>\n**Error Code:** `5660` <br>\n No pricebook exists with given partner SKU code. <br>\n**Error Code:** `5605` <br>\n Request body can not be blank. <br>\n**Error Code:** `5606` <br>\n Order header can not be null. <br>\n**Error Code:** `5607` <br>\n Order date cannot be blank. <br>\n**Error Code:** `5608` <br>\n Invalid order date format. Expected format is YYYY-MM-DD. <br>\n**Error Code:** `5609` <br>\n Order date can not be of past. <br>\n**Error Code:** `5611` <br>\n Invalid quantity. <br>\n**Error Code:** `5610` <br>\n Invalid PO Number. <br>\n**Error Code:** `5623` <br>\n Invalid order type - value must be trial or sale. <br>\n**Error Code:** `5616` <br>\n For amendment order, **Subscription Number** cannot be blank. <br>\n**Error Code:** `5617` <br>\n Sub reseller crm_account_number cannot be blank. <br>\n**Error Code:** `5618` <br>\n Sub reseller account_name cannot be blank. <br>\n**Error Code:** `5619` <br>\n Start date cannot be blank. <br>\n**Error Code:** `5002` <br>\n Invalid cancel on date format. Expected format is YYYY-MM-DD. <br>\n**Error Code:** `5678` <br>\n The subscription number is invalid. <br>\n**Error Code:** `5625` <br>\n Start Date should be in valid date format `YYYY-MM-DD` and greater than or equal to today. <br>\n**Error Code:** `5627` <br>\n InitialTerm: `termType` must be either `TERMED` or `EVERGREEN`. <br>\n**Error Code:** `5629` <br>\n Initial term periodType is mandatory for termType TERMED and must be one of these: Month, or Year. <br>\n**Error Code:** `5630` <br>\n Initial term termPeriod is mandatory for termType TERMED and must be between 1 to 60 months. <br>\n**Error Code:** `5633` <br>\n For cancel subscription, remove reason cannot be blank. <br>\n**Error Code:** `5634` <br>\n For cancel subscription, remove reason must be at most 255 characters. <br>\n**Error Code:** `5635` <br>\n For cancel subscription, cancel reason cannot be blank. <br>\n**Error Code:** `5636` <br>\n For cancel subscription, cancel reason must be at most 255 characters. <br>\n**Error Code:** `5639` <br>\n Currency must be in a valid ISO currency code. <br>\n**Error Code:** `5009` <br>\n Value is not a whole number. <br>\n**Error Code:** `5628` <br>\n Unable to find partner SKU for some of the offers in the order. Please try creating a quote for this transaction or contact the Zoom Partner Success team. <br>\n**Error Code:** `5629` <br>\n Amendment or renewal is not allowed for offers with $0 net price. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n **Error Code:** `5632` <br>\n Unable to process the order. <br>\n"}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:write:order:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:write:order:admin"]}}},"/commerce/order/preview":{"post":{"tags":["Order"],"summary":"Preview delta order metrics and subscriptions in an order ","description":"Previews the delta order metrics and subscriptions in an order. Validates the order and gets the metrics like TCV, applicable discounts, and net MRR before placing the order for provisioning. This operation is only an order preview, and no order is submitted for fulfillment. To submit the order, use the [order API](https://developers.zoom.us/docs/api/commerce/#tag/order/post/commerce/order/preview). \\n**Note** Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:order:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`\n\n**Not supported in Gov cluster** ","operationId":"createOrderPreview","parameters":[{"name":"invoice-owner-crm-account-number","in":"header","description":"The CRM account number for the invoice owner if it is one of the sibling accounts.","required":false,"schema":{"type":"string","example":"A-3454374"}}],"requestBody":{"description":"Create an order for a Zoom partner.","content":{"application/json":{"schema":{"required":["header"],"type":"object","properties":{"header":{"required":["order_date"],"type":"object","properties":{"order_type":{"type":"string","description":"The type of order.","example":"sale","default":"sale","enum":["trial","sale"]},"order_description":{"maxLength":500,"type":"string","description":"The description of the order.","example":"New ZCC subscription for ABC Pvt. Ltd."},"deal_reg_number":{"type":"string","description":"The registration number of the deal registered by the partner or reseller.","example":"DELREG-1002-L1"},"order_date":{"type":"string","description":"The order date in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"po_number":{"type":"string","description":"The purchase order number.","example":"PO-10021-A"},"additional_attributes":{"maxItems":10,"type":"array","description":"The order-level attributes.","items":{"type":"object","properties":{"name":{"maxLength":20,"type":"string","description":"The attribute's name.","example":"Customer segment."},"value":{"maxLength":500,"type":"string","description":"The attribute's value.","example":"Healthcare"}},"description":"The additional attribute details."}}},"description":"The order header details."},"create_subscriptions":{"maxItems":1,"type":"array","description":"The order details for creating a new subscription.","items":{"required":["currency","end_customer_crm_account_number","initial_term","sold_to_crm_contact_number"],"type":"object","properties":{"end_customer_account_number":{"maxLength":10,"type":"string","description":"The end customer Zoom account number.","example":"5333445346"},"end_customer_crm_account_number":{"type":"string","description":"The CRM account number for the end customer.","example":"A-3454334"},"sold_to_crm_contact_number":{"type":"string","description":"The CRM contact number for the sold-to contact.","example":"C-232442"},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer. Will default to a language based on the end customer's country if left blank.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"initial_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then the `term_period` field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"}},"description":"The subscription's initial term."},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then the `term_period` field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The term's duration in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The term's start date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The term's end date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's renewal term. Required for paid subscriptions where `order_type` = `sale`."},"sub_reseller":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The sub-reseller's CRM account number.","example":"A-45r33"},"account_name":{"type":"string","description":"The sub-reseller's name.","example":"Novam Corp."}},"description":"The sub-reseller's account number. This input will be ignored if a deal registration number has been provided in the request. The sub-reseller associated with that deal registration will be associated with this order request."},"service_start_date":{"type":"string","description":"The service start date. It should be equal to or before `paid_period_start_date`.","format":"YYYY-MM-DD","example":"2024-03-20"},"paid_period_start_date":{"type":"string","description":"The subscription's paid period start date. Required if the subscription has a free period.","format":"YYYY-MM-DD","example":"2024-03-20"},"free_months_reason_code":{"type":"string","description":"The reason for requesting a free period in the subscription. Required if the subscription has a free period.","example":"Billing at Later Date for Other Reason","enum":["Customer's Desired Billing/Start Date","Billing at Later Date for Other Reason","Align to Customer's Renewal Date"]},"currency":{"maxLength":3,"type":"string","description":"The subscription currency in a three-letter ISO currency code.","example":"CAD"},"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of each term. Defaults to true. Only applicable for `createSubscription` order action if the initial term type is TERMED.","example":true,"default":true},"add_offers":{"maxItems":10,"type":"array","description":"The new offers to be added to a subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges, it should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute details."}}},"description":"The subscription plan details."}},"add_add_ons":{"maxItems":10,"type":"array","description":"The new add-ons to be added to a subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges, it should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute details."}}},"description":"The subscription plan details."}},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if `requires_professional_services` is set to `Yes, Zoom will do the deployment`.","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if `is_zoom_pso_org_engaged` is set to `Yes and I have a PSO Engagement Request ID`.","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details. Required with 'deployment_partner_name'."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment.'"},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if `requires_professional_services` is true.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Creates a new subscription order."}},"amend_subscriptions":{"maxItems":1,"type":"array","description":"The order details for amending an existing subscription.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"The subscription number of the subscription which is being updated. Required for a paid subscription amendment.","example":"A-31231322"},"zoom_account_number":{"type":"string","description":"The end customer Zoom account number. Required for amend trial order. This field is ignored for paid subscription amendments.","example":"2334235678"},"add_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be added in the subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges, it should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute details."}}},"description":"The subscription plan details."}},"add_add_ons":{"maxItems":5,"type":"array","description":"The offer details for add-ons to be added in the subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges, it should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute details."}}},"description":"The subscription plan details."}},"upgrade_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be upgraded in the subscription.","items":{"required":["start_date"],"type":"object","properties":{"new_offer_price_list_id":{"type":"string","description":"The new offer price list ID.","example":"Off-2323"},"new_partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"old_offer_price_list_id":{"type":"string","description":"The existing offer price list ID.","example":"Off-2564"},"old_partner_sku_code":{"type":"string","description":"The unique SKU code for partners. Either this setting or `old_offer_price_list_id` should be provided. If this is provided, `old_offer_price_list_id` will be ignored.","example":"PAR1-PRO-BASE-NH1Y"},"old_subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges, it should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute details."}}},"description":"Cancels and replaces the subscription plan amendment."}},"remove_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be removed from the subscription.","items":{"required":["end_date","offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID for the offer to be removed from the subscription.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"end_date":{"type":"string","description":"The date when the offer will be removed. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"remove_reason":{"type":"string","description":"The reason for cancellation.","example":"Downsell"}},"description":"Removes the subscription plan."}},"update_offers":{"maxItems":5,"type":"array","description":"The update terms and quantity of an offer or add-on.","items":{"required":["offer_price_list_id","start_date"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID for the offer to be updated.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"The number of licenses. Quantity is not applicable for flat-fee charges. For other charges, it should be between minimum and maximum allowed for the plan. Defaults to applicable value if left blank.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute details."}}},"description":"The subscription update details."}},"cancel_subscription":{"required":["cancel_reason"],"type":"object","properties":{"cancel_by":{"type":"string","description":"When the subscription will be cancelled. Required for paid subscriptions. Currently only 'EndOfCurrentTerm' is supported.","example":"EndOfCurrentTerm","enum":["EndOfCurrentTerm","EndOfLastInvoicePeriod","SpecificDate"]},"cancel_on":{"type":"string","description":"Must be provided if `cancel_by` is `SpecificDate`.","format":"YYYY-MM-DD","example":"2023-10-03"},"cancel_reason":{"maxLength":250,"type":"string","description":"The reason for cancellation.","example":"Downsell"}},"description":"The cancellation details."},"renew_subscription":{"type":"object","properties":{"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then the `term_period` field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's initial, renewal, or current term."}},"description":"The renewal details."},"update_subscription":{"type":"object","properties":{"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of each term. Only applicable if the initial term type is TERMED. If auto_renew is true, providing renewal_term is required.","example":true},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then the `term_period` field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's renewal term. Required for paid subscriptions where `order_type` = `sale`."},"sold_to_crm_contact_number":{"type":"string","description":"The CRM contact number for the sold-to contact.","example":"C-232442"},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if `requires_professional_services` is set to `Yes, Zoom will do the deployment`.","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if `is_zoom_pso_org_engaged` is set to `Yes and I have a PSO Engagement Request ID`.","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details. Required with 'deployment_partner_name'."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment.'"},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if `requires_professional_services` is true.","example":"Zoom phone professional services"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Update the subscription attributes."}},"description":"Amend the order request details."}}},"description":"The order request details."}}}},"responses":{"201":{"description":"Order created successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBnfvirdhgf8e9rt78349rtu43rt"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The preview status of the order. Supported values are `draft`, `failedToSubmit`, `completed`, `canceled`, `submitted`, and `failed`.","example":"submitted","enum":["draft","failedToSubmit","completed","canceled","submitted","failed"]},"order_reference_id":{"type":"string","description":"The reference ID for an order.","example":"OR-3248714941"},"order_date":{"type":"string","description":"The date when order should be placed in the billing system.","format":"MM-DD-YYYY","example":"07-01-2024"},"order_metrics":{"type":"object","properties":{"tcv":{"type":"number","description":"The total contract value. This is the total amount that has been booked over the duration of the charge.","format":"double","example":100000},"tcb":{"type":"number","description":"The total contracted billing. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge.","format":"double","example":100000},"mrr":{"type":"number","description":"The monthly recurring revenue.","format":"double","example":1000},"total_net_amount":{"type":"number","description":"The total net amount booked in this order.","format":"double","example":100000},"total_discount_pct":{"type":"number","description":"The total discount applied (in percentage).","format":"percentage","example":0.1}},"description":"The order metrics, such as tcv, mrr, tcb, and so on."},"subscription_preview":{"maxItems":1,"type":"array","description":"The subscription metrics preview.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"The subscription number of the subscription.","example":"A-31231322"},"tcv":{"type":"number","description":"The total contract value. This is the total amount that has been booked over the duration of the charge.","format":"double","example":100000},"tcb":{"type":"number","description":"The total contracted billing. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge.","format":"double","example":100000},"mrr":{"type":"number","description":"The monthly recurring revenue.","format":"double","example":1000},"total_net_amount":{"type":"number","description":"The total net amount booked in this subscription or amendment.","format":"double","example":100000},"total_discount_pct":{"type":"number","description":"The total discount applied (in percentage).","format":"percentage","example":0.1}},"description":"The subscription metrics, such as tcv, mrr, tcb, and so on."}},"subscription_item_metrics":{"maxItems":30,"type":"array","description":"The array of subscription line items.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"The offer or plan ID.","example":"PR-2323"},"offer_name":{"type":"string","description":"The offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"The offer SKU.","example":"SKU-00000118"},"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"offer_price_list_name":{"type":"string","description":"The offer price list name.","example":"Zoom Workplace Pro Annual"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"The charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"The charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"The money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"The money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"The money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"discounts":{"maxItems":5,"type":"array","description":"The applicable discounts.","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount.","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either `percent_value` or `amount_value` is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either `percent_value` or `amount_value` is required.","format":"double","example":10},"apply_to":{"type":"string","description":"This field specifies how the discount will be applied. One time or recurring.","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"]},"discount_level":{"type":"string","description":"The application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription.","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"The discount details."}}}}},"mrr":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"Represents the sale price, list price, net amount, or gross amount."}},"description":"The subscription's line metrics."}},"errors":{"maxItems":20,"type":"array","description":"The array of messages in case of validation processing errors.","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"The error code.","example":"5604"},"error_description":{"type":"string","description":"The error description.","example":"No pricebook exists with given offer_price_list_id."}},"description":"The error code and message."}},"warnings":{"maxItems":20,"type":"array","description":"The array of messages in case of validation or processing warnings.","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"The error code.","example":"5604"},"error_description":{"type":"string","description":"The error description.","example":"No pricebook exists with given offer_price_list_id."}},"description":"The error code and message."}}},"description":"The order's preview response."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5662` <br>\n Sub Reseller account number is invalid or not associated with the partner. <br>\n**Error Code:** `5692` <br>\n End customer CRM number or Zoom account number is not associated with the partner. <br>\n**Error Code:** `5142` <br>\n No account found for the CRM account number. <br>\n**Error Code:** `5601` <br>\n `Cancel_on` is required when `cancel_by` is `SpecificDate`. <br>\n**Error Code:** `5604` <br>\n No pricebook exists with given `offer_price_list_id`. <br>\n**Error Code:** `5660` <br>\n No pricebook exists with given partner SKU code. <br>\n**Error Code:** `5605` <br>\n Request body cannot be blank. <br>\n**Error Code:** `5606` <br>\n Order header cannot be null. <br>\n**Error Code:** `5607` <br>\n Order date cannot be blank. <br>\n**Error Code:** `5608` <br>\n Invalid order date format. Expected format is YYYY-MM-DD. <br>\n**Error Code:** `5609` <br>\n Order date should be greater than or equal to today and in `YYYY-MM-DD` format. <br>\n**Error Code:** `5610` <br>\n Invalid PO number. <br>\n**Error Code:** `5611` <br>\n Invalid quantity. <br>\n**Error Code:** `5623` <br>\n Invalid order type: value must be `trial` or `sale`. <br>\n**Error Code:** `5616` <br>\n For amendment order, subscription number cannot be blank. <br>\n**Error Code:** `5617` <br>\n Sub reseller `crm_account_number` cannot be blank. <br>\n**Error Code:** `5618` <br>\n Sub reseller `account_name` cannot be blank. <br>\n**Error Code:** `5619` <br>\n Start date cannot be blank. <br>\n**Error Code:** `5002` <br>\n Invalid cancel on date format. Expected format is `YYYY-MM-DD`. <br>\n**Error Code:** `5678` <br>\n The subscription number is invalid. <br>\n**Error Code:** `5625` <br>\n Start date should be in valid date format `YYYY-MM-DD` and greater than or equal to today. <br>\n**Error Code:** `5627` <br>\n `initialTerm` `termType` must be either `TERMED` or `EVERGREEN`. <br>\n**Error Code:** `5629` <br>\n Initial term `periodType` is mandatory for `termType` TERMED and must be one of `Month` or  `Year`. <br>\n**Error Code:** `5630` <br>\n Initial term `termPeriod` is mandatory for `termType` TERMED and must be between `1` to `60` months. <br>\n**Error Code:** `5633` <br>\n For cancel subscription, remove reason cannot be blank. <br>\n**Error Code:** `5634` <br>\n For cancel subscription, remove reason must be at most 255 characters. <br>\n**Error Code:** `5635` <br>\n For cancel subscription, cancel reason cannot be blank. <br>\n**Error Code:** `5636` <br>\n For cancel subscription, cancel reason must be at most 255 characters. <br>\n**Error Code:** `5639` <br>\n Currency must be in a valid ISO currency code. <br>\n**Error Code:** `5648` <br>\n For new subscription, you must provide either the end customer's CRM account number or Zoom account number. <br>\n**Error Code:** `5009` <br>\n Value is not a whole number. <br>\n**Error Code:** `5628` <br>\n Unable to find partner SKU for some of the offers in the Order. Please try creating a quote for this transaction or contact Zoom Partner Success team. <br>\n**Error Code:** `5629` <br>\n Amendment or renewal is not allowed for offers with $0 net price. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n **Error Code:** `5632` <br>\n Unable to process the order. <br>\n"}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:write:order:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:write:order:admin"]}}},"/commerce/orders":{"get":{"tags":["Order"],"summary":"Gets all orders for a Zoom partner.","description":"Returns all orders for a Zoom partner based on specified filters. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:order:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"getAllOrders","parameters":[{"name":"invoice_owner_crm_account_number","in":"query","description":"This field filters orders by the CRM account number for the Invoice Owner.","required":false,"schema":{"type":"string","example":"A-3454374"}},{"name":"page_size","in":"query","description":"The number of records returned per page in the response.","required":false,"schema":{"maximum":100,"minimum":20,"type":"integer","example":50,"default":20}},{"name":"page_num","in":"query","description":"The page number for fetching the next page of the result set.","required":false,"schema":{"type":"string","example":"3"}},{"name":"date_filter_option","in":"query","description":"The date type to filter on. Supported values are \"effectiveDate\", \"createdDate\" and \"updatedDate\". The default is effectiveDate.","required":false,"schema":{"type":"string","example":"effectiveDate","default":"effectiveDate","enum":["effectiveDate","createdDate","updatedDate"]}},{"name":"from","in":"query","description":"This field indicates the start date to filter the result. The result will only contain the orders with the date of date_filter_option later than or equal to this date. The range cannot be more than 3 years.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2022-02-10"}},{"name":"to","in":"query","description":"The end date to filter the result. The result will only contain the orders with the date of date_filter_option earlier than or equal to this date. The range cannot be more than 3 years.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2024-02-10"}},{"name":"order_type","in":"query","description":"This field filters results by order type. Supported values are 'trial' and 'sale'.","required":false,"schema":{"type":"string","example":"sale","default":"sale","enum":["trial","sale"]}},{"name":"order_reference_id","in":"query","description":"This field filters results based on order reference ID.","required":false,"schema":{"type":"string","example":"OR-125613343"}},{"name":"order_number","in":"query","description":"This field filters results based on order number.","required":false,"schema":{"type":"string","example":"O-3429342"}},{"name":"po_number","in":"query","description":"This field filters results based on purchase order number.","required":false,"schema":{"type":"string","example":"PO-1381273"}},{"name":"deal_reg_number","in":"query","description":"This field filters results based on deal registration number.","required":false,"schema":{"type":"string","example":"DR-132833"}},{"name":"end_customer_name","in":"query","description":"This field filters results based on end customer name. It should be a minimum of three characters. Characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"John"}},{"name":"end_customer_crm_account_number","in":"query","description":"Filters results based on end customer CRM account number. Must be a minimum of three characters. ","required":false,"schema":{"type":"string","example":"A-3454334"}},{"name":"end_customer_zoom_account_number","in":"query","description":"Filters results based on a subscription number. Must be a minimum of three characters.","required":false,"schema":{"maxLength":10,"minLength":3,"type":"string","example":"4435343789"}},{"name":"sub_reseller_name","in":"query","description":"Filters results based on the sub-reseller name. Must be a minimum of three characters. Characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"John"}},{"name":"sub_reseller_crm_account_number","in":"query","description":"Filters results based on sub-reseller CRM account number. Must be a minimum of three characters.","required":false,"schema":{"type":"string","example":"A-348742"}},{"name":"invoice_owner_name","in":"query","description":"This field filters orders by the Invoice Owner name.","required":false,"schema":{"type":"string","example":"John"}},{"name":"status","in":"query","description":"This field filters the results by order status.","required":false,"schema":{"type":"string","example":"submitted","enum":["draft","failedToSubmit","completed","canceled","submitted","failed"]}},{"name":"subscription_number","in":"query","description":"Filters results based on a subscription number. Must be a minimum of three characters.","required":false,"schema":{"maxLength":15,"minLength":3,"type":"string","example":"A-348742"}},{"name":"transaction_type","in":"query","description":"This field filters results based on the transaction type for the order. Possible values are New or Amend.","required":false,"schema":{"type":"string","example":"New","enum":["New","Amend"]}},{"name":"sort","in":"query","description":"This field sorts the result by any one of the supported fields - `orderNumber`, `orderReferenceId`, `zoomAccountNumber`, `dealRegistrationNumber`, `poNumber`, `subResellerName`, `status`, `effectiveDate`, or `updatedDate`. The default is `updatedDate`.","required":false,"schema":{"type":"string","example":"orderNumber.asc","default":"updatedDate.asc","enum":["orderNumber.asc","orderNumber.desc","orderReferenceId.asc","orderReferenceId.desc ","zoomAccountNumber.asc ","dealRegistrationNumber.asc","dealRegistrationNumber.desc","poNumber.asc","poNumber.desc","subResellerName.asc","subResellerName.desc","status.asc","status.desc","effectiveDate.asc","effectiveDate.desc","updatedDate.asc","updatedDate.desc"]}}],"responses":{"200":{"description":"Orders returned successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBhdfioejir54945ui34rndfvdsf"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"page_count":{"type":"integer","description":"The total number of pages in the result set.","example":20},"order_list":{"maxItems":100,"type":"array","description":"The orders list.","items":{"type":"object","properties":{"order_reference_id":{"type":"string","description":"The reference ID for a draft order.","example":"OR-125613343"},"order_number":{"type":"string","description":"The order number of the order.","example":"O-3429342"},"status":{"type":"string","description":"The status of the order. Supported values are \"draft\", \"failedToSubmit\", \"completed\", \"canceled\", \"submitted\", \"failed\".","example":"submitted","enum":["draft","failedToSubmit","completed","canceled","submitted","failed"]},"order_type":{"type":"string","description":"The type of order.","example":"sale","enum":["trial","sale"]},"transaction_type":{"type":"string","description":"The transaction type for the order. Possible values are New or Amend.","example":"New","enum":["New","Amend"]},"invoice_owner_crm_account_number":{"type":"string","description":"The CRM account number for the Invoice Owner.","example":"A-3454374"},"invoice_owner_name":{"type":"string","description":"The name of the Invoice Owner account.","example":"ABC Distributors"},"end_customer_account_name":{"type":"string","description":"The end customer's account name.","example":"dfreABC Pvt. Ltd."},"end_customer_account_number":{"maxLength":10,"type":"string","description":"The end customer's Zoom account number.","example":"3842618277"},"end_customer_crm_account_number":{"maxLength":10,"type":"string","description":"The end customer's CRM account number.","example":"A-3454334"},"sub_reseller_name":{"type":"string","description":"The sub-reseller's name if the order was placed by a distributor on their behalf.","example":"John"},"sub_reseller_crm_account_number":{"type":"string","description":"The sub-reseller's CRM account number if the order was placed by a distributor on their behalf.","example":"A-348742"},"creation_date":{"type":"string","description":"The date when this order was created.","format":"YYYY-MM-DD","example":"2024-07-01"},"effective_date":{"type":"string","description":"The date when this order was activated. Also the contract's effective date.","format":"YYYY-MM-DD","example":"2024-07-01"},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"The money value.","example":100000},"currency":{"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"The net order value."},"tcv":{"type":"object","properties":{"amount":{"type":"number","description":"The money value for total contract value.","example":100000},"currency":{"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"The net order value."},"tcb":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary value for the total contract billed.","example":100000},"currency":{"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"The net order value."},"updated_date":{"type":"string","description":"The date when this order was last updated.","format":"YYYY-MM-DD","example":"2024-07-01"},"trade_screening":{"type":"boolean","description":"Flag to indicate whether the subscription cleared trade screening check or not.","example":false},"deal_reg_number":{"type":"string","description":"The registration number of the deal registered by partner or reseller.","example":"DELREG-1002-L1"},"po_number":{"type":"string","description":"The purchase order's number.","example":"PO-10021-A"}},"description":"The list of orders."}}},"description":"The list of orders."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5623` <br>\n Invalid order type. <br>\n**Error Code:** `5689` <br>\n Invalid order status. <br>\n**Error Code:** `5506` <br>\n Invalid sort values. It must be one of: orderNumber.asc, orderNumber.desc, orderReferenceId.asc, orderReferenceId.desc , zoomAccountNumber.asc , dealRegistrationNumber.asc, dealRegistrationNumber.desc, poNumber.asc, poNumber.desc, subResellerName.asc, subResellerName.desc, status.asc, status.desc, effectiveDate.asc, effectiveDate.desc, updatedDate.asc, or updatedDate.desc <br>\n**Error Code:** `5000` <br>\n Invalid character & or | in the name filter. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition that prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:order:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:order:admin"]}}},"/commerce/orders/{orderReferenceId}":{"get":{"tags":["Order"],"summary":"Get order details by order reference ID","description":"Gets order details by order reference ID. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:order:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"getOrderDetails","parameters":[{"name":"orderReferenceId","in":"path","description":"Order reference ID.","required":true,"schema":{"type":"string","example":"O-0001"}}],"responses":{"200":{"description":"Order returned successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBsjfhieur9847rt94rjtcxlfk"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"header":{"required":["order_date"],"type":"object","properties":{"order_reference_id":{"type":"string","description":"Reference ID for an order.","example":"OR-3248714941"},"order_type":{"type":"string","description":"Type of order - sale or trial.","example":"sale","default":"sale"},"transaction_type":{"type":"string","description":"The transaction type for the order. Possible values are New or Amend.","example":"New","enum":["New","Amend"]},"order_description":{"maxLength":500,"type":"string","description":"The order's description.","example":"New Contact Center subscription for ABC Pvt. Ltd."},"status":{"type":"string","description":"The order's status. Supported values are `draft`, `failedToSubmit`, `completed`, `canceled`, `submitted`, `failed`.","example":"submitted","enum":["draft","failedToSubmit","completed","canceled","submitted","failed"]},"order_number":{"type":"string","description":"The billing system order number when the order is successfully submitted or completed.","example":"PAR-OR-1012312"},"deal_reg_number":{"type":"string","description":"Registration Number of the deal registered by partner/reseller","example":"DELREG-1002-L1"},"order_date":{"type":"string","description":"Order date in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"po_number":{"type":"string","description":"Purchase order number.","example":"PO-10021-A"},"trade_screening":{"type":"boolean","description":"The flag to indicate whether the subcription cleared trade screening check or not.","example":false},"order_metrics":{"type":"object","properties":{"tcv":{"type":"number","description":"Total contract value. This is the total amount that has been booked over the duration of the charge.","format":"double","example":120000},"tcb":{"type":"number","description":"Total contracted billing. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge.","format":"double","example":120000},"mrr":{"type":"number","description":"Monthly recurring revenue.","format":"double","example":10000},"total_discount_pct":{"type":"number","description":"Total discount applied, in percentage.","format":"percentage","example":0.1},"total_net_amount":{"type":"number","description":"Total net amount, the sum of all the offers in this order.","example":123.46}},"description":"Order metrics like tcv, mrr, or tcb."},"additional_attributes":{"maxItems":10,"type":"array","description":"The order level attributes.","items":{"type":"object","properties":{"name":{"maxLength":20,"type":"string","description":"The attribute name.","example":"Customer segment."},"value":{"maxLength":500,"type":"string","description":"The attribute's value.","example":"Healthcare"}},"description":"The additional attribute details."}},"trial_id":{"type":"string","description":"Trial's unique identifier if the order was trial order.","example":"Z-021462495"}},"description":"Order header details."},"create_subscription":{"maxItems":1,"type":"array","description":"New subscription order details.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"Subscription number of the subscription, which is created or updated. Will be blank if subscription creation is not complete.","example":"A-1232632"},"end_customer_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom Account Number for the customer, partner, or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM Account Number for the customer, partner, or reseller.","example":"A-1234"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The address type.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"City name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"Postal or ZIP code or number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"State or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The country's ISO code.","example":"US"}},"description":"Address details."}},"description":"Account details."},"invoice_owner_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom Account Number for the customer, partner, or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM Account Number for the customer, partner, or reseller.","example":"A-1234"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The address type.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"City name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"Postal or ZIP code or number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"State or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The country's ISO code.","example":"US"}},"description":"Address details."}},"description":"Account details."},"sub_reseller":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom Account Number for the customer, partner, or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM Account Number for the customer, partner, or reseller.","example":"A-1232"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The address type.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street addressl","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city namel","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"Postal or zip code/numberl","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The country's ISO code.","example":"US"}},"description":"Address details."}},"description":"Account details."},"sold_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"Unique CRM Number for the contact.","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the sold to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the sold to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email ID.","example":"jchill@example.com"}},"description":"Sold to contact details."},"bill_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"Unique CRM Number for the contact.","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the bill to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the bill to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email ID.","example":"jchill@example.com"}},"description":"Bill to contact details."},"initial_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The subscription term's type. Supported values are TERMED and EVERGREEN. If the subscription is TERMED, then `period` and `period_type` fields are also required.","example":"TERMED","enum":["TERMED","EVERGREEN"]},"period_type":{"type":"string","description":"Unit of time that the term is measured in. Only applicable if the value of the term_type field is TERMED. Supported values are `Month` or `Year`.","example":"Month","enum":["Month","Year"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"Start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"}},"description":"Subscription initial, renewal or current term."},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"Type of the subcription term. Supported values are TERMED and EVERGREEN. If the subscription is TERMED, then the `period` and `period_type` fields are also required.","example":"TERMED","enum":["TERMED","EVERGREEN"]},"period_type":{"type":"string","description":"Unit of time that the term is measured in. Only applicable if the value of the term_type field is TERMED. Supported values are `Month` or `Year`.","example":"Month","enum":["Month","Year"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"Start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"}},"description":"Subscription initial, renewal or current term."},"agreement_dates":{"type":"object","properties":{"contract_effective_date":{"type":"string","description":"Date when the contract will be effective from. It is a required field to provide in the order when order action type is `createSubscription`, in YYYY-MM-DD format and if `order_date` is different from contract effective date.","format":"YYYY-MM-DD","example":"2022-10-25"},"service_activation_date":{"type":"string","description":"Date when the service will be activated from, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"customer_acceptance_date":{"type":"string","description":"Date when the order was approved by the customer. This is a required field to provide in the order when the order action type is `addOffer`, `createSubscription`, `addOn`, `upgrade`, `upsell`, and `renewSubscription`, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"}},"description":"Subscription agreement dates."},"sold_to_crm_contact_number":{"type":"string","description":"CRM contact number for the sold to contact.","example":"C-34267"},"end_customer_language":{"type":"string","description":"The language used to set communication and invoice profile for the end customer.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"payment_term":{"type":"string","description":"Payment term for this subscription. If null, will be defaulted to the payment term associated with the account.","example":"Net30","enum":["Due upon Receipt","Net30","Net45","Net60"]},"service_start_date":{"type":"string","description":"Service start date. Equal to or before `paid_period_start_date`.","format":"YYYY-MM-DD","example":"2022-10-25"},"paid_period_start_date":{"type":"string","description":"Subscription paid period start date. Required if the subscription has free periods.","format":"YYYY-MM-DD","example":"2022-10-25"},"free_months_included":{"type":"boolean","description":"True if the order created a free period subscription.","example":false},"free_months_reason_code":{"type":"string","description":"Reason for free period in the subscription. Required if the subscription has free period.","example":"Billing at Later Date for Other Reason","enum":["Customer's Desired Billing/Start Date","Billing at Later Date for Other Reason","Align to Customer's Renewal Date"]},"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of the each term. Defaults to true. Only applicable for \"createSubscription\" order action if the initial term type is TERMED.","example":true,"default":true},"currency":{"maxLength":3,"type":"string","description":"Subscription currency in 3-letter ISO currency code","example":"CAD"},"deal_reg_number":{"type":"string","description":"Registration Number of the deal registered by partner or reseller","example":"DELREG-1002-L1"},"po_number":{"type":"string","description":"Purchase order number.","example":"PO-10021-A"},"subscription_metrics":{"type":"object","properties":{"subscription_number":{"type":"string","description":"Subscription number of the subscription.","example":"A2324323"},"tcv":{"type":"number","description":"Total contract value. This is the total amount that has been booked over the duration of the charge.","format":"double","example":120000},"tcb":{"type":"number","description":"Total contracted billing. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge.","format":"double","example":120000},"mrr":{"type":"number","description":"Monthly recurring revenue.","format":"double","example":10000},"total_discount_pct":{"type":"number","description":"Total discount applied, in percentage.","format":"percentage","example":10}},"description":"Subscription metrics like tcv, mrr, or tcb."},"offers":{"maxItems":10,"type":"array","description":"Subscription lines for new subscription.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer or plan ID.","example":"Off-34213"},"offer_name":{"type":"string","description":"Offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU.","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID.","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name.","example":"Zoom Workplace Pro Annual"},"quantity":{"type":"integer","description":"Number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"Charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"Charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount, or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount, or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount, or gross amount."},"discounts":{"type":"array","description":"Applicable discounts","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount.","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either `percent_value` or `amount_value` is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"discount in amount. Either `percent_value` or `amount_value` is required.","format":"double","example":10},"apply_to":{"type":"string","description":"How the discount will be applied. One time or recurring.","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"]},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is `subscription` and the value of the `apply_to` field is `RECURRING`, the discount applies to all recurring charges in the same subscription.","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"True if the plan has a usage or overage based charge.","example":true}},"description":"Order subscription lines."}},"add_ons":{"maxItems":10,"type":"array","description":"add-ons for new subscription.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer or plan ID.","example":"OFF-4556"},"offer_name":{"type":"string","description":"Offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU.","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID.","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name.","example":"Zoom Workplace Pro Annual"},"quantity":{"type":"integer","description":"Number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"Charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount, or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount, or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount, or gross amount."},"discounts":{"type":"array","description":"Applicable discounts.","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount.","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either `percent_value` or `amount_value` is required, but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either `percent_value` or `amount_value` is required.","format":"double","example":10},"apply_to":{"type":"string","description":"How the discount will be applied. One time or recurring.","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"]},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is `subscription` and the value of the `apply_to` field is `RECURRING`, the discount applies to all recurring charges in the same subscription.","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"True if the plan has a usage or overage based charge.","example":true}},"description":"Order subscription lines."}},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if 'requires_professional_services' is set to 'Yes, Zoom will do the deployment.","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if 'is_zoom_pso_org_engaged' is set to 'Yes and I have a PSO Engagement Request ID.","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"Name of the deployment partner.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details. "}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment."},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if \"requires_professional_services\" is true.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Order subcription details for a new subscription creation."}},"amend_subscriptions":{"maxItems":5,"type":"array","description":"Amendment order details.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"Subscription number of the subscription, which is created or updated. Will be blank if subscription creation is not complete.","example":"A-4534587"},"end_customer_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom Account Number for the customer or partner/reseller","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM Account Number for the customer or partner/reseller","example":"A-1234"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"type of address - billTo, shipTo, soldTo","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"city name","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"postal or zip code/number","example":"95114"},"state":{"maxLength":20,"type":"string","description":"state or province","example":"PA"},"country":{"maxLength":3,"type":"string","description":"ISO code for the country","example":"US"}},"description":"Address details"}},"description":"Account details."},"invoice_owner_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom Account Number for the customer or partner/reseller","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM Account Number for the customer or partner/reseller","example":"A-1234"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"type of address - billTo, shipTo, soldTo","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"city name","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"postal or zip code/number","example":"95114"},"state":{"maxLength":20,"type":"string","description":"state or province","example":"PA"},"country":{"maxLength":3,"type":"string","description":"ISO code for the country","example":"US"}},"description":"Address details"}},"description":"Account details."},"sub_reseller":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom Account Number for the customer or partner/reseller","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM Account Number for the customer or partner/reseller","example":"A-1234"},"account_name":{"type":"string","description":"The account name","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"type of address - billTo, shipTo, soldTo","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"city name","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"postal or zip code/number","example":"95114"},"state":{"maxLength":20,"type":"string","description":"state or province","example":"PA"},"country":{"maxLength":3,"type":"string","description":"ISO code for the country","example":"US"}},"description":"Address details"}},"description":"Account details."},"sold_to_contact":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"Unique CRM Number for the contact","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the sold to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the sold to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email id.","example":"abc@test.com"}},"description":"Sold to contact details"},"bill_to_contact":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"Unique CRM Number for the contact","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the bill to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the bill to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email id.","example":"abc@test.com"}},"description":"Bill to contact details"},"currency":{"maxLength":3,"type":"string","description":"Subscription currency in 3-letter ISO currency code","example":"CAD"},"deal_reg_number":{"type":"string","description":"Registration Number of the deal registered by partner/reseller","example":"DELREG-1002-L1"},"po_number":{"type":"string","description":"Purchase order number","example":"PO-10021-A"},"subscription_metrics":{"type":"object","properties":{"subscription_number":{"type":"string","description":"Subscription number of the subscription","example":"A4324242"},"tcv":{"type":"number","description":"Total contract value. This is the total amount that has been booked over the duration of the charge.","format":"double","example":120000},"tcb":{"type":"number","description":"Total contracted billing. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge.","format":"double","example":120000},"mrr":{"type":"number","description":"Monthly recurring revenue","format":"double","example":10000},"total_discount_pct":{"type":"number","description":"Total discount applied (in percentage))","format":"percentage","example":10}},"description":"subscription metrics like tcv, mrr, tcb ."},"add_offers":{"maxItems":5,"type":"array","description":"subscription lines for amendment of an existing subscription","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"offer or plan ID","example":"OFF-4556"},"offer_name":{"type":"string","description":"offer/plan name","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name","example":"Zoom Workplace Pro Annual"},"quantity":{"type":"integer","description":"number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"charge model of this charge","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"charge type of this charge","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"discounts":{"type":"array","description":"Applicable discounts","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"type of discount. supported values are \"DealReg\", \"Partner\", \"Exception\"","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"discount in percentage. Either percent_value or amount_value is required but both should not be provided","format":"percent","example":0.1},"amount_value":{"type":"number","description":"discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\"","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"]},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\"","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"true if the plan has a usage or overage based charge","example":true}},"description":"Order subscription lines."}},"add_add_ons":{"maxItems":5,"type":"array","description":"subscription lines for amendment of an existing subscription","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"offer or plan ID","example":"OFF-4556"},"offer_name":{"type":"string","description":"offer/plan name","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name","example":"Zoom Workplace Pro Annual"},"quantity":{"type":"integer","description":"number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"charge model of this charge","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"charge type of this charge","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"discounts":{"type":"array","description":"Applicable discounts","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"type of discount. supported values are \"DealReg\", \"Partner\", \"Exception\"","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"discount in percentage. Either percent_value or amount_value is required but both should not be provided","format":"percent","example":0.1},"amount_value":{"type":"number","description":"discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\"","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"]},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\"","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"true if the plan has a usage or overage based charge","example":true}},"description":"Order subscription lines."}},"upgrade_offers":{"maxItems":5,"type":"array","description":"subscription lines for amendment of an existing subscription","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"offer or plan ID","example":"OFF-4556"},"offer_name":{"type":"string","description":"offer/plan name","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name","example":"Zoom Workplace Pro Annual"},"old_offer_price_list_id":{"type":"string","description":"Old Offer price list ID in case of upgrade or cancel/replace order","example":"PRL-3412"},"old_partner_sku_code":{"type":"string","description":"Unique SKU code for partners for old offer price list in case of upgrade or cancel/replace order.","example":"PAR1-PRO-BASE-NH1Y"},"old_subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"charge model of this charge","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"charge type of this charge","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"discounts":{"type":"array","description":"Applicable discounts","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"type of discount. supported values are \"DealReg\", \"Partner\", \"Exception\"","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"discount in percentage. Either percent_value or amount_value is required but both should not be provided","format":"percent","example":0.1},"amount_value":{"type":"number","description":"discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\"","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"]},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\"","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"true if the plan has a usage or overage based charge","example":true}},"description":"Order subscription lines."}},"remove_offers":{"maxItems":5,"type":"array","description":"subscription lines for amendment of an existing subscription","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"offer or plan ID","example":"OFF-4556"},"offer_name":{"type":"string","description":"offer/plan name","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name","example":"Zoom Workplace Pro Annual"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"remove_reason":{"type":"string","description":"The reason for cancellation.","example":"Downsell"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"charge model of this charge","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"charge type of this charge","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"discounts":{"type":"array","description":"Applicable discounts","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"type of discount. supported values are \"DealReg\", \"Partner\", \"Exception\"","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"discount in percentage. Either percent_value or amount_value is required but both should not be provided","format":"percent","example":0.1},"amount_value":{"type":"number","description":"discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\"","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"]},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\"","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"true if the plan has a usage or overage based charge","example":true}},"description":"Order subscription lines."}},"update_offers":{"maxItems":5,"type":"array","description":"subscription lines for amendment of an existing subscription. update terms and quantity of an offer or add-on","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"offer or plan ID","example":"OFF-4556"},"offer_name":{"type":"string","description":"offer/plan name","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"offer_price_list_name":{"type":"string","description":"Offer price list name","example":"Zoom Workplace Pro Annual"},"quantity":{"type":"integer","description":"number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"charge model of this charge","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"charge type of this charge","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"discounts":{"type":"array","description":"Applicable discounts","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"type of discount. supported values are \"DealReg\", \"Partner\", \"Exception\"","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"discount in percentage. Either percent_value or amount_value is required but both should not be provided","format":"percent","example":0.1},"amount_value":{"type":"number","description":"discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\"","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"]},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\"","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"true if the plan has a usage or overage based charge","example":true}},"description":"Order subscription lines."}},"cancel_subscription":{"type":"object","properties":{"cancel_by":{"type":"string","description":"Supported values - \"EndOfCurrentTerm\", \"EndOfLastInvoicePeriod\", \"SpecificDate\".","example":"EndOfCurrentTerm","enum":["EndOfCurrentTerm","EndOfLastInvoicePeriod","SpecificDate"]},"cancel_on":{"type":"string","description":"Must be provided if cancel_by is SpecificDate","format":"YYYY-MM-DD","example":"2022-10-25"},"cancel_reason":{"maxLength":250,"type":"string","description":"Reason for cancellation","example":"Customer no longer uses this."}},"description":"Order cancellation details for a cancel subscription action."},"renew_subscription":{"type":"object","properties":{"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"type of the subcription term. Supported values are TERMED and EVERGREEN. If the subscription is TERMED, then the `period` and `period_type` fields are also required.","example":"TERMED","enum":["TERMED","EVERGREEN"]},"period_type":{"type":"string","description":"Unit of time that the term is measured in. Only applicable if the value of the term_type field is TERMED. Supported values are `Month` or `Year`.","example":"Month","enum":["Month","Year"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The term's start date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"The term's end date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"}},"description":"Subscription initial, renewal, or current term."}},"description":"Order renewal details for a renew subscription action."},"update_subscription":{"type":"object","properties":{"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of the each term. Only applicable if the initial term type is TERMED. If auto_renew is true, providing renewal_term is required.","example":true},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The subscription term's type. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The term's duration in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The term's start date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The term's end date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's renewal term. Required for paid subscriptions, where `order_type = sale`."},"sold_to_crm_contact_number":{"type":"string","description":"CRM contact number for the sold to contact.","example":"C-232442"},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if 'requires_professional_services' is set to 'Yes, Zoom will do the deployment`.","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if 'is_zoom_pso_org_engaged' is set to 'Yes and I have a PSO Engagement Request ID`.","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment."},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if `requires_professional_services` is true.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Update subscription attributes."},"update_trial_subscription":{"type":"object","properties":{"extend_trial_offers":{"maxItems":10,"type":"array","description":"Offers requiring trial period extension. ","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer or plan ID.","example":"OFF-4556"},"offer_name":{"type":"string","description":"Offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU.","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"The offer's price list ID.","example":"PRL-3683272383"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name.","example":"Zoom Workplace Pro Annual"},"start_date":{"type":"string","description":"The subscription line's start date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"The subscription line's end date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"}}}}},"description":"Update trial subscription attributes."}},"description":"Order subscription details for an amendment."}},"errors":{"maxItems":50,"type":"array","description":"Array of messages in case of validation or processing errors.","items":{"type":"object","properties":{"error_code":{"type":"string","description":"Error code.","example":"5012"},"error_description":{"type":"string","description":"Error description.","example":"Invalid Partner/Reseller Identifier supplied."}},"description":"Error details."}},"warnings":{"maxItems":50,"type":"array","description":"The array of messages in case of validation or processing warnings","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"The error code.","example":"5604"},"error_description":{"type":"string","description":"The error description.","example":"No pricebook exists with given offer_price_list_id."}},"description":"The error code and message."}}},"description":"Order details."}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5009` <br>\n No records found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:order:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:order:admin"]}}},"/commerce/file":{"post":{"tags":["Platform"],"summary":"Upload an attachment pdf file in context of a deal registration or quote","description":"\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:file:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"uploadFile","parameters":[{"name":"description","in":"query","description":"Description for the attachment.","required":false,"schema":{"type":"string","example":"Client approval for a quote."}},{"name":"associated_object_type","in":"query","description":"Context object type - Quote, Deal etc. Pass \"Quote\" in this field with the attached is for a quote.","required":true,"schema":{"type":"string","example":"Quote","enum":["Quote","Deal"]}},{"name":"associated_reference_id","in":"query","description":"Unique reference id for the associated object. If the \"associated_object_type\" is \"Quote\", pass quote_reference_id in this field.","required":true,"schema":{"type":"string","example":"DR_17253"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"Attachment file. Only PDF format supported. ","format":"binary","example":"Vm0wd2QyUXlVWGxWV0d4V1YwZDRWMVl3WkRSV01WbDNXa1JTVjAxV2JETlhhMUpUVjBaS2RHVkdXbFppVkZaeVZtMTRTMk15VGtsalJtaG9UVmhDVVZkV1pEUlRNazE0V2toR1VtSkdXbGhaYTJoRFZWWmtWMXBFVWxSTmF6RTBWMnRvUjFWdFNrZFhiR2hhWWtaV00xcFZXbUZrUjA1R1drWndWMDFFUlRGV1ZFb3dWakZhV0ZOcmFHaFNlbXhXVm1wT1QwMHhjRlpYYlVacVZtdGFNRlZ0ZUZOVWJVWTJVbFJHVjFaRmIzZFdha1poVjBaT2NtRkhhRk5sYlhoWFZtMHdlR0l4U2tkWGJHUllZbFZhY2xWcVJtRlRSbGw1VFZSU1ZrMXJjRWxhU0hCSFZqSkZlVlZZWkZwbGEzQklXWHBHVDJSV1ZuUmhSazVzWWxob1dGWnRNSGRsUjBsNFUydGtXR0pIVWxsWmJHaFRWMFpTVjJGRlRsTmlSbkJaV2xWYVQxWlhTbFpYVkVwV1lrWktSRlpxUVhoa1ZsWjFWMnhhYUdFeGNGbFhhMVpoVkRKT2MyTkZaR2hTTW5oVVZGY3hiMkl4V1hoYVJFSmFWbXhzTTFSVmFHOWhiRXB6WTBac1dtSkdXbWhaTW5oWFkxWkdWVkpzVGs1WFJVcElWbXBLTkZReFdsaFRhMlJxVW14d1dGbHNhRk5OTVZweFUydDBWMVpyY0ZwWGExcDNZa2RGZWxGcmJGaFhTRUpJVmtSS1UxWXhXblZVYkdocFZqTm9WVlpHWTNoaU1sSnpWMjVTVGxkSFVsWlVWM1J6VGxaV2RHUkhkRmhTTUhCSlZsZDRjMWR0U2toaFJsSlhUVVp3VkZacVNrZFNiRkp6Vkcxc1UySnJTbUZXTW5oWFdWWlJlRmRzYUZSaVJuQlpWbXRXZDFZeGJISlhhM1JVVW14d2VGVXlkR0ZpUmxwelYyeHdXR0V4Y0ROWmEyUkdaV3hHY21KR1pGZE5NRXBKVm10U1MxVXhXWGhXYmxaV1lsaENWRmxyVm5kV1ZscDBaVWM1VWsxWFVucFdNV2h2VjBkS1JrNVdVbFZXYlZFd1ZqRmFWMlJIVWtoa1JtUk9WakZLU2xkV1ZtRmpNV1IwVTJ0a1dHSlhhR0ZVVmxwM1pXeHJlVTFWWkZOaVJrcDZWa2N4YzFVeVNuSlRiVVpYVFc1b1dGbHFTa1psUm1SWldrVTFWMVpzY0ZWWFYzUnJWVEZzVjFWc1dsaGliVkp6V1d0YWQyVkdWblJOVldSVlRXdHdSMVl5ZUhkWGJGcFhZMGRvV21FeVVrZGFWV1JQVWxaa2MxcEhiRmhTVlhCS1ZtMTBVMU14VlhoWFdHaFlZbXhhVmxsclpHOWpSbHB4VkcwNVYxWnRVbGhXVjNNMVZXc3hXRlZyYUZkTmFsWlVWa2Q0WVZKc1RuTmhSbFpYWWxaRmQxWnFRbUZaVm1SSVZXdG9hMUp0YUZSVVZXaERVMnhhYzFwRVVtcE5WMUl3VlRKMGIyRkdTbk5UYkdoVlZsWndNMVpyV21GalZrcDFXa1pPVGxacmNEVldSM2hoVkRKR1YxTnVVbEJXUlRWWVZGYzFiMWRHYkZoamVrWllVbXR3ZVZkcldtOWhWMFkyVm01b1YxWkZTbkpVYTFwclVqRldjMXBHYUdoTk1VcFZWbGN4TkdReVZrZFdiR1JvVW5wc2IxUldXbmRsYkZsNVkwVmtWMDFFUmpGWlZXaExWakZhUmxkcmVGZE5WbkJJV1RJeFMxSXhjRWhpUm1oVFZsaENTMVp0TVRCVk1VbDVVbGhvV0ZkSGVGWlpWRVozWVVaV2NWTnRPVmRTYkVwWlZHeGpOVll4V25OalJXaFlWa1UxZGxsV1ZYaFhSbFoxWTBaa1RsWXlhREpXYWtKclV6RmtWMVp1U2xCV2JIQndWbXRXVm1ReFduRlJiVVphVm1zMVNWWlhkRzloTVVwMFZXNUNWMkpIYUVSVWJYaGhWbFpPVlZKc1ZrNVdia0YzVmxjd01WTXhXa2hUYkdob1VtMW9WbFpzV25kTk1YQllaVWhLYkZZeFdrcFhhMXBQVkd4YWNtSXpaRmhpUmxwb1dWUktSMVl4VGxsalJuQk9UVzFvV1ZaR1l6RmlNV1JIVjI1R1UySkZjSE5WYlRGVFYyeGtjbFpVUmxoU2EzQmFWVmQ0YzFkR1duUlZhbHBWVm14d2VsWnFSbGRqTVdSellVZHNhVlpyY0ZwV2JHTjRUa2RSZVZaclpGZGliRXBQVm14a1UxZEdVbFpWYTJSc1ZteEtlbFp0TURWV01ERldZbnBLVm1KWVVuWldha1poVW14a2NtVkdaR2hoTTBKUlZsY3hORmxYVFhoalJXaHBVbXMxVDFac1dscGxiRnAwWlVkR1ZrMVZiRFJaYTFwclYwZEtjbU5GT1ZkaVdHZ3pWakJhYzFkWFRrZGFSbVJUWWtad05WWnRNVEJaVmxGNFZteFdUbEpIY3prPQ=="}}}}}},"responses":{"201":{"description":"File uploaded successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"f43u8ry832weijdhijawhDIOQWJDO"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"document_reference_id":{"type":"string","description":"Unique reference id for the uploaded file.","example":"DOC-1234"}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `7101` <br>\n Only PDF files are supported. <br>\n**Error Code:** `7102` <br>\n Associated object type is required. <br>\n**Error Code:** `7103` <br>\n Associated object reference id is required. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n **Error Code:** `7100` <br>\n Unable to upload file. Please try again later. <br>\n"}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:write:file:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:write:file:admin"]}}},"/commerce/files/{associatedReferenceId}/details":{"get":{"tags":["Platform"],"summary":"Gets details of all files associated with a quote or deal registration","description":"\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:file:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"allFileDetails","parameters":[{"name":"associatedReferenceId","in":"path","description":"Unique reference ID for the associated object. If the associated object is a \"Quote\", pass quote_reference_id in this field.","required":true,"schema":{"type":"string","example":"QU_17253"}}],"responses":{"200":{"description":"All files retrieved successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"f43u8ry832weijdhijawhDIOQWJDO"}}},"content":{"application/json":{"schema":{"maxItems":10,"type":"array","description":"Uploaded file details.","items":{"type":"object","properties":{"associated_object_type":{"type":"string","description":"Context object type - Quote, Deal etc.","example":"Quote","enum":["Quote","Deal"]},"associated_reference_id":{"type":"string","description":"Unique reference ID for the associated object. If the \"associated_object_type\" is \"Quote\", this will be quote_reference_id.","example":"QU-2323"},"description":{"type":"string","description":"Description for the attachment.","example":"Client approval for a quote."},"uploaded_on":{"type":"string","description":"Date when the document was uploaded.","format":"YYYY-MM-DD","example":"2023-10-03"},"document_reference_id":{"type":"string","description":"Unique reference ID for the uploaded file.","example":"DOC-1234"},"document_name":{"type":"string","description":"The file name.","example":"endcustomer_acceptance_12032024.pdf"},"document_type":{"type":"string","description":"Type of document.","example":"Purchase Order"}}}}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Insufficient permissions. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  Incorrect associated reference ID. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:file:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:file:admin"]}}},"/commerce/files/{documentReferenceId}":{"get":{"tags":["Platform"],"summary":"Download a file associated with a quote or deal registration.","description":"Download a file associated with a quote or deal registration.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:file:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"downloadFile.","parameters":[{"name":"documentReferenceId","in":"path","description":"Document reference id for the file to be downloaded.","required":true,"schema":{"type":"string","example":"DOC-3233"}}],"responses":{"200":{"description":"File retrieved successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"f43u8ry832weijdhijawhDIOQWJDO"}}},"content":{"application/pdf":{"schema":{"type":"string","format":"binary","example":"VmpJeGQxVnRWblJWYkZab1UwZDRjMVpyWkd0T2JGSllUbGQwYVZJd1dsbFpNR1F3WVVaSmVXVklhRmhXYldoeVdXcEdTMUp0U2tkUmJGcFhZbFpLVFZaWGRGWk9Sa0pTVUZRd1BRPT0="}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n **Error Code:** `6104` <br>\n Unable to download the file. Please try again later. <br>\n"}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:file:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:file:admin"]}}},"/commerce/catalog":{"post":{"tags":["Product Catalog"],"summary":"Gets Zoom Product Catalog for a Zoom Partner","description":"Returns the Zoom product catalog for a Zoom Partner. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:product_catalog:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"getOffers","requestBody":{"description":"This field provides filter options.","content":{"application/json":{"schema":{"required":["filter_options"],"type":"object","properties":{"filter_options":{"maxItems":10,"type":"array","description":"This field filters the results based on criteria. Multiple filter criteria can be provided.","items":{"required":["filter_by","filter_value"],"type":"object","properties":{"filter_by":{"type":"string","description":"Filters by `offerType`, `billingPeriod`, `currency`, `country`, `offerIds`, `partnerSkuCodes`, `priceListIds`, 'quoteEligible' and 'sector'. By default, the API will filter by 'offerType=plan', 'currency=USD'.","example":"billingPeriod","enum":["offerType","billingPeriod","currency","country","offerIds","partnerSkuCodes","priceListIds"]},"filter_value":{"type":"string","description":"The filter values are separated by commas. For offerType, supported values are - plan, standalone, configurable, isv, addon. For billingPeriod, supported values are - Month, Quarter, Annual, Semi-Annual, Two Years, Three Years, Week, Subscription Term. For sector, supported values are - Commercial, USDOD and GOV.","example":"Annual"},"operand":{"type":"string","description":"Supported values: `in` and `notIn`. Default is `in`.","example":"in","enum":["in","notIn"]}},"description":"This field filters options through the Zoom product catalog."}},"eligibility_criteria":{"type":"object","properties":{"only_trial_eligible":{"type":"boolean","description":"If true, the API returns only trial-eligible offers or add-ons. The default is false.","example":false},"only_base_plans":{"type":"boolean","description":"If `only_base_plans` = true, the API returns only base plan offers. Only one of these criteria: `only_base_plans` or `upgrade_offer_id` should be specified in the request.","example":false},"upgrade_offer_id":{"type":"string","description":"If this criterion is selected, the API returns only applicable upgrade offers in the response. Only one of these criteria: `only_base_plans` or `upgrade_offer_id` should be specified in the request.","example":"OFR-002"}},"description":"The eligibility criteria for searching through the Zoom product catalog."}},"description":"The offer details."}}}},"responses":{"200":{"description":"Retrieved all currently available offers.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBdbfuyer63ry4urhu3ery82e"}}},"content":{"application/json":{"schema":{"required":["offers"],"type":"object","properties":{"offers":{"maxItems":60,"type":"array","description":"The list of Zoom offers available for a Zoom partner.","items":{"required":["offer_id","offer_name"],"type":"object","properties":{"offer_id":{"type":"string","description":"The unique identifier for the Zoom offer or plan. Offer can be a hard bundle, standalone Zoom Product, dynamic bundle, add-on or an ISV.","example":"OFR-0000012"},"offer_name":{"type":"string","description":"The plan name of the Zoom offer or plan. Offer can be a hard bundle, standalone Zoom Product, dynamic bundle or an ISV.","example":"Zoom One Pro"},"offer_desc":{"type":"string","description":"The short description for the plan.","example":"Zoom One Professional Bundle"},"offer_type":{"type":"string","description":"The type of offering. Supported options are plan, standalone, addon, configurable, and ISV.","example":"plan","enum":["plan","standalone","configurable","isv","addon"]},"z_product_category":{"type":"string","description":"The Zoom product category. Supported values are Add-on Product, Add On Services, Base Product, Others, Professional Service, Standalone Product.","example":"Base Product","enum":["Add-on Product","Add On Services","Base Product","Others","Professional Service","Standalone Product"]},"sku":{"type":"string","description":"The Zoom offer SKU.","example":"SKU-00000118"},"status":{"type":"string","description":"Whether the offer is active or not. Supported values: Active, Limited, Inactive, or Expired.","example":"Limited","enum":["Active","Limited","In-active","Expired"]},"start_date":{"type":"string","description":"The offer availability start date.","format":"YYYY-MM-DD","example":"2020-10-01"},"end_date":{"type":"string","description":"The offer availability end date.","format":"YYYY-MM-DD","example":"2023-10-25"},"offer_products":{"maxItems":10,"type":"array","description":"The products associated with an offer.","items":{"type":"object","properties":{"product_name":{"type":"string","description":"The Zoom product's name.","example":"Meetings"},"product_id":{"type":"string","description":"The unique identifier for the product.","example":"PR-1323"},"product_family_id":{"type":"string","description":"The Zoom product family ID.","example":"dfewur3erfdd"},"product_family_name":{"type":"string","description":"The Zoom product family name.","example":"Core Communication"},"product_group_id":{"type":"string","description":"The Zoom product group ID.","example":"dfewur3erfdd"},"product_group_name":{"type":"string","description":"The Zoom product group name.","example":"Communication"},"product_type":{"type":"string","description":"The supported values are base and add-on.","example":"base","enum":["base","add-on'"]},"sku":{"type":"string","description":"The SKU for the product.","example":"SKU-10000120"},"product_features":{"maxItems":10,"type":"array","description":"The product features.","items":{"type":"object","properties":{"feature_id":{"type":"string","description":"The feature or attribute of the product.","example":"Number of participants"},"name":{"type":"string","description":"The feature or attribute of the product.","example":"Maximum number of participants supported"},"value_type":{"type":"string","description":"The value data type. Supported data types: Integer, Enum, String, Boolean, or Object.","example":"Integer","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The feature or attribute value.","example":"100"},"uom":{"type":"string","description":"The unit of measure.","example":"count"}},"description":"The details of the product features."}},"price_list":{"maxItems":50,"type":"array","description":"The offer price list or rate plans.","items":{"type":"object","properties":{"price_list_id":{"type":"string","description":"The unique identifier for the price plan.","example":"PRL-23823"},"price_list_name":{"type":"string","description":"The name of the price plan.","example":"Zoom Workplace Pro Annual"},"prices":{"maxItems":50,"type":"array","description":"The offer price list or rate plan charges.","items":{"type":"object","properties":{"price_list_charge_id":{"type":"string","description":"The unique identifier for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"charge_type":{"type":"string","description":"The supported values for the charge type are OneTime, Recurring, and Usage.","example":"Recurring","enum":["OneTime","Recurring","Usage"]},"charge_model":{"type":"string","description":"The supported values for the charge model are Flat Fee Pricing, Tiered Pricing, Volume Pricing, Per Unit Pricing, Overage Pricing.","example":"Volume Pricing","enum":["Flat Fee Pricing","Tiered Pricing","Volume Pricing","Per Unit Pricing","Overage Pricing"]},"name":{"type":"string","description":"The name for the charge.","example":"Flat fee charge"},"uom":{"type":"string","description":"The unit of measure for the charge.","example":"host"},"amount":{"type":"number","description":"The list price per UOM. It should not be null if charge model is not tiered or volume.","example":9.99},"currency":{"type":"string","description":"The ISO currency code for this charge.","example":"USD"},"region":{"type":"string","description":"The geographic region for this charge.","example":"LATAM","enum":["LATAM","APAC"]},"country":{"type":"string","description":"The ISO country code for this charge.","example":"US"},"min_unit_quantity":{"type":"integer","description":"The minimum quantity for this charge.","example":10},"status":{"type":"string","description":"The status of the charge.","example":"Active","enum":["Active","In-active","Expired"]},"start_date":{"type":"string","description":"The effective start date for the price.","format":"YYYY-MM-DD","example":"2023-10-25"},"end_date":{"type":"string","description":"The effective end date for the price.","format":"YYYY-MM-DD","example":"2023-10-25"},"price_tiers":{"maxItems":50,"type":"array","description":"The price list charge tier details for a volume or tiered price list charge.","items":{"type":"object","properties":{"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"lower":{"type":"integer","description":"The lower limit of the tier.","example":1},"upper":{"type":"integer","description":"The upper limit of the tier.","example":10},"price":{"type":"number","description":"The tier price.","format":"double","example":81},"apply_rule":{"type":"string","description":"This field applies a rule of either flat-fee or per-unit.","example":"per-unit"}}}}},"description":"The offer price list charge details."}},"start_date":{"type":"string","description":"The start date when this price plan can be used.","format":"YYYY-MM-DD","example":"2023-10-25"},"end_date":{"type":"string","description":"The end date until when this price plan is active.","format":"YYYY-MM-DD","example":"2030-10-02"},"billing_period":{"type":"string","description":"The billing period for this price list: Month, Annual, Quarter, and so on.","example":"Month","enum":["Month","Quarter","Annual","Semi-Annual","Two Years","Three Years","Week","Subscription Term"]},"status":{"type":"string","description":"Whether the price list is active or not. Supported values: Active, Limited, Inactive, or Expired.","example":"Limited","enum":["Active","Limited","In-active","Expired"]},"eccn_value":{"type":"string","description":"The ECCN value for the offer.","example":"5D992"}},"description":"The offer price list or rate plan details."}}},"description":"The Zoom product's details."}},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's attributes.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"uom":{"type":"string","description":"The unit of measure.","example":"count"},"value_type":{"type":"string","description":"The attribute value type. Supported data types: Integer, Enum, String, Boolean, Object.","example":"Integer","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"10"}},"description":"The offer attribute details."}},"pricebook":{"maxItems":50,"type":"array","description":"The price book details.","items":{"type":"object","properties":{"price_list_id":{"type":"string","description":"The unique identifier for the price plan.","example":"PRL-23823"},"price_list_name":{"type":"string","description":"The name of the price plan.","example":"Zoom Workplace Pro Annual"},"prices":{"maxItems":50,"type":"array","description":"The offer price list or rate plan charges.","items":{"type":"object","properties":{"price_list_charge_id":{"type":"string","description":"The unique identifier for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"charge_type":{"type":"string","description":"The supported values for the charge type are OneTime, Recurring, and Usage.","example":"Recurring","enum":["OneTime","Recurring","Usage"]},"charge_model":{"type":"string","description":"The supported values for the charge model are Flat Fee Pricing, Tiered Pricing, Volume Pricing, Per Unit Pricing, Overage Pricing.","example":"Volume Pricing","enum":["Flat Fee Pricing","Tiered Pricing","Volume Pricing","Per Unit Pricing","Overage Pricing"]},"name":{"type":"string","description":"The name for the charge.","example":"Flat fee charge"},"uom":{"type":"string","description":"The unit of measure for the charge.","example":"host"},"amount":{"type":"number","description":"The list price per UOM. It should not be null if charge model is not tiered or volume.","example":9.99},"currency":{"type":"string","description":"The ISO currency code for this charge.","example":"USD"},"region":{"type":"string","description":"The geographic region for this charge.","example":"LATAM","enum":["LATAM","APAC"]},"country":{"type":"string","description":"The ISO country code for this charge.","example":"US"},"min_unit_quantity":{"type":"integer","description":"The minimum quantity for this charge.","example":10},"status":{"type":"string","description":"The status of the charge.","example":"Active","enum":["Active","In-active","Expired"]},"start_date":{"type":"string","description":"The effective start date for the price.","format":"YYYY-MM-DD","example":"2023-10-25"},"end_date":{"type":"string","description":"The effective end date for the price.","format":"YYYY-MM-DD","example":"2023-10-25"},"is_channel_discount_applicable":{"type":"boolean","description":"True if 'z_product_class' is 1 , 2 or 3 and the class discount applies to this charge.","example":true},"price_tiers":{"maxItems":50,"type":"array","description":"The price list charge tier details for a volume or tiered price list charge.","items":{"type":"object","properties":{"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"lower":{"type":"integer","description":"The lower limit of the tier.","example":1},"upper":{"type":"integer","description":"The upper limit of the tier.","example":10},"price":{"type":"number","description":"The tier price.","format":"double","example":81},"apply_rule":{"type":"string","description":"Applies the rule of either flat-fee or per-unit.","example":"per-unit"}}}}},"description":"The offer price list charge details."}},"start_date":{"type":"string","description":"The start date when this price plan can be used.","format":"YYYY-MM-DD","example":"2023-10-25"},"end_date":{"type":"string","description":"The end date until when this price plan is active.","format":"YYYY-MM-DD","example":"2030-10-02"},"billing_period":{"type":"string","description":"The billing period for this price list: Month, Annual, Quarter, and so on.","example":"Month","enum":["Month","Quarter","Annual","Semi-Annual","Two Years","Three Years","Week","Subscription Term"]},"status":{"type":"string","description":"Whether the price list is active or not. Supported values: Active, Limited, Inactive, or Expired.","example":"Limited","enum":["Active","Limited","In-active","Expired"]},"eccn_value":{"type":"string","description":"The ECCN value for the offer.","example":"5D992"},"z_product_class":{"type":"string","description":"The Zoom product class for this price list.","example":"1","enum":["1","2","3","4"]},"pricebook_attributes":{"maxItems":10,"type":"array","description":"The price book attributes.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Pricebook eligible for Order"},"value_type":{"type":"string","description":"The attribute value type. Supported data types: Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"true"}},"description":"The price book attribute details."}}},"description":"The offer price list or rate plan details."}}},"description":"The offer's details."}}},"description":"The Zoom offer's details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details.\n\n **Error Code:** `5408` <br>\n Invalid filter_by value. Valid values are: offerIds, offerType, billingPeriod, currency, country, priceListIds, partnerSkuCodes. <br>\n**Error Code:** `5411` <br>\n Invalid filter_value. <br>\n**Error Code:** `5401` <br>\n No offer present for given filters. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:product_catalog:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:product_catalog:admin"]}}},"/commerce/catalog/{offerId}":{"get":{"tags":["Product Catalog"],"summary":"Gets the details for a Zoom product or offer.","description":"Returns the details for a Zoom product or offer. Each offer is identified by a unique ID. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:product_catalog:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"getOfferDetail","parameters":[{"name":"offerId","in":"path","description":"The identifier of the offer.","required":true,"schema":{"type":"string","example":"OFR-00123"}}],"responses":{"200":{"description":"The Zoom product or offer details returned successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"required":["offer_id","offer_name"],"type":"object","properties":{"offer_id":{"type":"string","description":"The unique identifier for the Zoom offer or plan. Offer can be a hard bundle, standalone Zoom Product, dynamic bundle, add-on, or an ISV.","example":"OFR-0000012"},"offer_name":{"type":"string","description":"The plan name of the Zoom offer or plan. Offer can be a hard bundle, standalone Zoom Product, dynamic bundle, or an ISV.","example":"Zoom One Pro"},"offer_desc":{"type":"string","description":"The short description for the plan.","example":"Zoom One Professional Bundle"},"offer_type":{"type":"string","description":"The type of offering. Supported options are plan, standalone, add-on, configurable, or ISV.","example":"plan","enum":["plan","standalone","configurable","isv","addon"]},"z_product_category":{"type":"string","description":"The Zoom product category. Supported values are Add-on Product, Add On Services, Base Product, Others, Professional Service, Standalone Product.","example":"Base Product","enum":["Add-on Product","Add On Services","Base Product","Others","Professional Service","Standalone Product"]},"sku":{"type":"string","description":"The Zoom offer SKU.","example":"SKU-00000118"},"status":{"type":"string","description":"Whether the offer is active or not. Supported values: Active, Limited, Inactive, or Expired.","example":"Limited","enum":["Active","Limited","In-active","Expired"]},"start_date":{"type":"string","description":"The offer availability of the start date.","format":"YYYY-MM-DD","example":"2020-10-23"},"end_date":{"type":"string","description":"The offer availability of the end date.","format":"YYYY-MM-DD","example":"2023-10-25"},"offer_products":{"maxItems":10,"type":"array","description":"The products associated with an offer.","items":{"type":"object","properties":{"product_name":{"type":"string","description":"The Zoom product name.","example":"Meetings"},"product_id":{"type":"string","description":"The unique identifier for the product.","example":"PR-1231"},"product_family_id":{"type":"string","description":"The Zoom product family ID.","example":"dfewur3erfdd"},"product_family_name":{"type":"string","description":"The Zoom product family name.","example":"Core Communication"},"product_group_id":{"type":"string","description":"The Zoom product group ID.","example":"dfewur3erfdd"},"product_group_name":{"type":"string","description":"The Zoom product group name.","example":"Communication"},"product_type":{"type":"string","description":"Supported values: base, and add-on.","example":"base","enum":["base","add-on'"]},"sku":{"type":"string","description":"The SKU for the product.","example":"SKU-10000120"},"product_features":{"maxItems":10,"type":"array","description":"The product features.","items":{"type":"object","properties":{"feature_id":{"type":"string","description":"The feature or attribute of the product.","example":"Number of participants"},"name":{"type":"string","description":"The feature or attribute of the product.","example":"Maximum number of participants supported"},"value_type":{"type":"string","description":"Value data type. Supported data types: Integer, Enum, String, Boolean, and Object.","example":"Integer","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The feature or attribute value.","example":"100"},"uom":{"type":"string","description":"The unit of measure.","example":"count"}},"description":"The product's feature details."}},"price_list":{"maxItems":20,"type":"array","description":"The offer price list or rate plans.","items":{"type":"object","properties":{"price_list_id":{"type":"string","description":"The unique identifier for the price plan.","example":"PRL-122"},"price_list_name":{"type":"string","description":"The name of the price plan.","example":"Zoom Workplace Pro Annual"},"prices":{"maxItems":50,"type":"array","description":"The offer price list or rate plan charges.","items":{"type":"object","properties":{"price_list_charge_id":{"type":"string","description":"The unique identifier for the charge.","example":"PRLC-1231"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"charge_type":{"type":"string","description":"The supported values for the charge type are OneTime, Recurring, and Usage.","example":"Recurring","enum":["OneTime","Recurring","Usage"]},"charge_model":{"type":"string","description":"The supported values for the charge model are Flat Fee Pricing, Tiered Pricing, Volume Pricing, Per Unit Pricing, Overage Pricing.","example":"Volume Pricing","enum":["Flat Fee Pricing","Tiered Pricing","Volume Pricing","Per Unit Pricing","Overage Pricing"]},"name":{"type":"string","description":"The name for the charge.","example":"Flat fee charge"},"uom":{"type":"string","description":"The unit of measure for the charge.","example":"host"},"amount":{"type":"number","description":"The list price per UOM. It should not be null if charge model is not tiered or volume.","example":9.99},"currency":{"type":"string","description":"The ISO currency code for this charge.","example":"USD"},"region":{"type":"string","description":"The geographic region for this charge.","example":"LATAM","enum":["LATAM","APAC"]},"country":{"type":"string","description":"The ISO country code for this charge.","example":"US"},"min_unit_quantity":{"type":"integer","description":"The minimum quantity for this charge.","example":10},"status":{"type":"string","description":"The status of the charge.","example":"Active","enum":["Active","In-active","Expired"]},"start_date":{"type":"string","description":"The effective start date for the price.","format":"YYYY-MM-DD","example":"2023-10-25"},"end_date":{"type":"string","description":"The effective end date for the price.","format":"YYYY-MM-DD","example":"2023-10-25"},"price_tiers":{"maxItems":50,"type":"array","description":"The price list's charge tier details for a volume or tiered price list charge.","items":{"type":"object","properties":{"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"lower":{"type":"integer","description":"The lower limit of the tier.","example":1},"upper":{"type":"integer","description":"The upper limit of the tier.","example":10},"price":{"type":"number","description":"The tier price.","format":"double","example":81},"apply_rule":{"type":"string","description":"The apply rule: flat-fee or per-unit.","example":"per-unit"}}}}},"description":"The details of the offer price list charge."}},"start_date":{"type":"string","description":"The start date when this price plan can be used.","format":"YYYY-MM-DD","example":"2023-10-25"},"end_date":{"type":"string","description":"The end date until when this price plan is active.","format":"YYYY-MM-DD","example":"2030-10-02"},"billing_period":{"type":"string","description":"The billing period for this price list: Month, Annual, Quarter, and so on.","example":"Month","enum":["Month","Quarter","Annual","Semi-Annual","Two Years","Three Years","Week","Subscription Term"]},"status":{"type":"string","description":"Whether the price list is active or not. Supported values: Active, Limited, Inactive, or Expired.","example":"Limited","enum":["Active","Limited","In-active","Expired"]},"eccn_value":{"type":"string","description":"The ECCN value for the offer.","example":"5D992"}},"description":"The offer price list or rate plan details."}}},"description":"The Zoom product's details."}},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer attributes.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"uom":{"type":"string","description":"The unit of measure.","example":"count"},"value_type":{"type":"string","description":"The attribute value type. Supported data types: Integer, Enum, String, Boolean, or Object.","example":"Integer","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute's details."}},"pricebook":{"maxItems":20,"type":"array","description":"The price book details.","items":{"type":"object","properties":{"price_list_id":{"type":"string","description":"The unique identifier for the price plan.","example":"PRL-122"},"price_list_name":{"type":"string","description":"The name of the price plan.","example":"Zoom Workplace Pro Annual"},"prices":{"maxItems":50,"type":"array","description":"The offer price list or rate plan charges.","items":{"type":"object","properties":{"price_list_charge_id":{"type":"string","description":"The unique identifier for the charge.","example":"PRLC-1231"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"charge_type":{"type":"string","description":"The supported values for the charge type are OneTime, Recurring, and Usage.","example":"Recurring","enum":["OneTime","Recurring","Usage"]},"charge_model":{"type":"string","description":"The supported values for the charge model are Flat Fee Pricing, Tiered Pricing, Volume Pricing, Per Unit Pricing, Overage Pricing.","example":"Volume Pricing","enum":["Flat Fee Pricing","Tiered Pricing","Volume Pricing","Per Unit Pricing","Overage Pricing"]},"name":{"type":"string","description":"The name for the charge.","example":"Flat fee charge"},"uom":{"type":"string","description":"The unit of measure for the charge.","example":"host"},"amount":{"type":"number","description":"The list price per UOM. It should not be null if charge model is not tiered or volume.","example":9.99},"currency":{"type":"string","description":"The ISO currency code for this charge.","example":"USD"},"country":{"type":"string","description":"The ISO country code for this charge.","example":"US"},"min_unit_quantity":{"type":"integer","description":"The minimum quantity for this charge.","example":10},"status":{"type":"string","description":"The status of the charge.","example":"Active","enum":["Active","In-active","Expired"]},"start_date":{"type":"string","description":"The effective start date for the price.","format":"YYYY-MM-DD","example":"2023-10-25"},"end_date":{"type":"string","description":"The effective end date for the price.","format":"YYYY-MM-DD","example":"2023-10-25"},"is_channel_discount_applicable":{"type":"boolean","description":"True if 'z_product_class' is 1 , 2 or 3 and the class discount applies to this charge.","example":true},"price_tiers":{"maxItems":50,"type":"array","description":"The price list's charge tier details for a volume or tiered price list charge.","items":{"type":"object","properties":{"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"lower":{"type":"integer","description":"The lower limit of the tier.","example":1},"upper":{"type":"integer","description":"The upper limit of the tier.","example":10},"price":{"type":"number","description":"The tier price.","format":"double","example":81},"apply_rule":{"type":"string","description":"The apply rule for this field: flat-fee or per-unit.","example":"per-unit"}}}}},"description":"The offer price list's charge details."}},"start_date":{"type":"string","description":"The start date when this price plan can be used.","format":"YYYY-MM-DD","example":"2023-10-25"},"end_date":{"type":"string","description":"The end date until when this price plan is active.","format":"YYYY-MM-DD","example":"2030-10-02"},"billing_period":{"type":"string","description":"The billing period for this price list: Month, Annual, Quarter, and so on.","example":"Month","enum":["Month","Quarter","Annual","Semi-Annual","Two Years","Three Years","Week","Subscription Term"]},"status":{"type":"string","description":"Whether the price list is active or not. Supported values: Active, Limited, Inactive, or Expired.","example":"Limited","enum":["Active","Limited","In-active","Expired"]},"eccn_value":{"type":"string","description":"The ECCN value for the offer.","example":"5D992"},"z_product_class":{"type":"string","description":"The Zoom product class for this price list.","example":"1","enum":["1","2","3","4"]},"pricebook_attributes":{"maxItems":10,"type":"array","description":"The pricebook attributes.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Pricebook eligible for Order"},"value_type":{"type":"string","description":"The attribute value type. Supported data types: Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"true"}},"description":"The pricebook attribute details."}}},"description":"The offer price list's rate plan details."}}},"description":"The offer's details."}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5009` <br>\n No records found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:product_catalog:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:product_catalog:admin"]}}},"/commerce/catalogvalidator":{"post":{"tags":["Product Catalog"],"summary":"Validate offer compatibility and dependencies","description":"Validates offers against dependency rules, quantity constraints, and eligibility criteria. \n\nEach violation provides a recommendation on how to fix the violation.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:product_catalog:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"validateOffers","requestBody":{"description":"Validator request.","content":{"application/json":{"schema":{"required":["validation_request"],"type":"object","properties":{"validation_request":{"required":["transaction_type"],"type":"object","properties":{"transaction_type":{"type":"string","description":"The type of transaction being validated.","example":"ORDER","enum":["ORDER","QUOTE","ESTIMATOR","TRIAL"]},"offers":{"type":"array","description":"The base plan offers to validate.","items":{"required":["price_list_id"],"type":"object","properties":{"price_list_id":{"type":"string","description":"The offer price list ID (e.g., PRL-1718109929895).","example":"PRL-1718109929895"},"quantity":{"minimum":1,"type":"integer","description":"The quantity of the offer.","example":1,"default":1}}}},"add_ons":{"type":"array","description":"The add-on offers to validate.","items":{"required":["price_list_id"],"type":"object","properties":{"price_list_id":{"type":"string","description":"The offer price list ID (e.g., PRL-1718109929895).","example":"PRL-1718109929895"},"quantity":{"minimum":1,"type":"integer","description":"The quantity of the offer.","example":1,"default":1}}}}}}}}}}},"responses":{"200":{"description":"Validator successfully executed.","content":{"application/json":{"schema":{"type":"object","properties":{"validation_response":{"required":["is_valid","violations"],"type":"object","properties":{"is_valid":{"type":"boolean","description":"True if validator response has no 'Stop' violations.","example":true},"violations":{"type":"array","description":"List of validation violations with recommended resolutions.","items":{"required":["affected_offers","reason","severity","violation_type"],"type":"object","properties":{"violation_type":{"type":"string","description":"Category of rule violation. \n\n - Quantity mismatch: wrong quantity. **Suggested action** - Adjust quantity) \n\n - Too many of same type: too many distinct offers. **Suggested action** - Choose one \n\n - Missing dependency: missing dependencies **Suggested action** - Add \n\n - Incompatible combination: incompatible offers **Suggested action** - Remove","enum":["Quantity mismatch","Too many of same type","Missing dependency","Incompatible combination","Generic"]},"severity":{"type":"string","description":"Severity level. \n\n - Stop: Blocks any order or quote execution for this offer combination.\n\n - Warnings: Advisory or recommended guidelines. \n\n - Info: Information. \n\nOrder or quote processing will not be blocked for Warning and Info severity types.","enum":["Stop","Warning","Info"]},"reason":{"required":["error_code","error_message"],"type":"object","properties":{"error_code":{"type":"string","description":"The error code.","example":"6311"},"error_message":{"type":"string","description":"The error message.","example":"Zoom Phone Pay As You Go must be accompanied by one of the following rate plans"}}},"affected_offers":{"type":"array","description":"Price list IDs from the request payload that caused this violation.","items":{"type":"string"}},"suggestions":{"type":"array","description":"Suggestions for resolving this violation. \n\nMay be null for informational violations.","nullable":true,"items":{"required":["action","offers"],"type":"object","properties":{"action":{"type":"string","description":"The suggested action. `Add`: Add missing or required offers. `Remove`: Remove incompatible offers. `Adjust quantity`: Change the quantity. `Choose one`: Select one offer from the list to keep.","enum":["Add","Remove","Adjust quantity","Choose one"]},"offers":{"type":"array","description":"The offers to add, remove, or choose from. Empty for `Adjust quantity`. Contains options for `Choose one`.","items":{"required":["price_list_id"],"type":"object","properties":{"price_list_id":{"type":"string","description":"The offer price list ID.","example":"PRL-1741014098274"},"name":{"type":"string","description":"The price list name. Blank if unavailable.","nullable":true,"example":"Zoom Workplace Pro Plus US/Canada Monthly"}}}},"suggested_quantity":{"type":"integer","description":"The recommended quantity. Only applicable for `Adjust quantity` actions.","nullable":true,"example":1},"mandatory":{"type":"boolean","description":"Whether the recommendation is required to be fulfilled.","nullable":true,"example":false,"default":false},"product_type":{"type":"string","description":"The recommended offer type.","nullable":true,"example":"base","enum":["base","usage"]}}}}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  Invalid input parameters. \n\n **Error Code:** `5424` <br>\n Transaction type is required. <br>\n**Error Code:** `5425` <br>\n Invalid transaction type. <br>\n**Error Code:** `5426` <br>\n At least one offer or add-on is required. <br>\n**Error Code:** `5427` <br>\n Price list ID is required. <br>\n**Error Code:** `5429` <br>\n Duplicate price list ID: {0}. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Unauthorized - Invalid or missing authentication token \n\n "},"403":{"description":"**HTTP Status Code:** `403` <br>\n Forbidden  Forbidden - Insufficient permissions. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:product_catalog:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:product_catalog:admin"]}}},"/commerce/pricebooks":{"get":{"tags":["Product Catalog"],"summary":"Gets the pricebook in a downloadable file","description":"Returns the pricebook in a CSV or Excel format including list price and discounted price based on the partner type. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:product_catalog:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"downloadPricebook","parameters":[{"name":"currency","in":"query","description":"The ISO currency code for the currency of the pricebook. By default all supported currencies are returned.","required":false,"schema":{"maxLength":3,"type":"string","example":"USD"}},{"name":"file_type","in":"query","description":"The file format.","required":false,"schema":{"type":"string","example":"csv","enum":["csv","excel"]}}],"responses":{"200":{"description":"The downloadable CSV or Excel file.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string"}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5402` <br>\n Currency should be a valid ISO currency code <br>\n**Error Code:** `5403` <br>\n File type should be one of: CSV, XLS. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:product_catalog:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:product_catalog:admin"]}}},"/commerce/quote":{"post":{"tags":["Quote"],"summary":"Create a subscription quote for a Zoom Partner","description":"Create a subscription quote for a Zoom partner's end customers.\n**Note** Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:quote:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"createQuote","parameters":[{"name":"invoice-owner-crm-account-number","in":"header","description":"The CRM account number for the invoice owner if it is one of the sibling accounts.","required":false,"schema":{"type":"string","example":"A-3454374"}}],"requestBody":{"description":"This setting creates a quote for a Zoom partner.","content":{"application/json":{"schema":{"required":["header"],"type":"object","properties":{"header":{"required":["quote_date"],"type":"object","properties":{"quote_type":{"type":"string","description":"The type of quote. Supported values are `trial` and `sale`.","example":"sale","default":"sale","enum":["trial","sale"]},"quote_description":{"maxLength":500,"type":"string","description":"A description of the quote.","example":"New ZCC subscription for ABC Pvt. Ltd."},"deal_reg_number":{"type":"string","description":"The registration number of the deal registered by partner or reseller.","example":"DELREG-1002-L1"},"quote_date":{"type":"string","description":"The quote date in `YYYY-MM-DD` format.","format":"YYYY-MM-DD","example":"2023-10-03"},"quote_expiry_date":{"type":"string","description":"The date when the quote will expire. If not provided, the quote will expire in 30 days from the date of creation. Maximum allowed expiry date is 180 days.","format":"YYYY-MM-DD","example":"2023-11-02"},"negotiation_note":{"maxLength":1000,"type":"string","description":"A note for negotiation deal for the quote.","example":"Additional discount for a new large deal."},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this quote.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}}},"description":"The quote header's details."},"create_subscriptions":{"maxItems":1,"type":"array","description":"The quote details for creating a new subscription.","items":{"required":["currency","initial_term","sold_to_crm_contact_number"],"type":"object","properties":{"end_customer_account_number":{"maxLength":10,"type":"string","description":"The end customer's Zoom account number.","example":"5333445346"},"end_customer_crm_account_number":{"type":"string","description":"The CRM account number for the end customer.","example":"A-3454334"},"sold_to_crm_contact_number":{"type":"string","description":"The CRM contact's number for the 'sold to contact'.","example":"C-232442"},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer. Will be defaulted to a language based on end customer's country if left blank.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"initial_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"}},"description":"The subscription's initial, renewal, or current term."},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The term's duration, in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The term's start date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The term's end date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's initial, renewal, or current term."},"sub_reseller":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The sub-reseller's CRM account number.","example":"A-45r33"},"account_name":{"type":"string","description":"The sub-reseller's name.","example":"Novam Corp."}},"description":"The sub-reseller's account number."},"service_start_date":{"type":"string","description":"The service start date. It should be equal to or before `paid_period_start_date`.","format":"YYYY-MM-DD","example":"2024-03-20"},"paid_period_start_date":{"type":"string","description":"The subscription paid period start date. Required if the subscription has a free period.","format":"YYYY-MM-DD","example":"2024-03-20"},"free_months_reason_code":{"type":"string","description":"The reason for requesting free period in the subscription. Required if the subscription has a free period.","example":"Customer's Desired Billing/Start Date","enum":["Customer's Desired Billing/Start Date","Billing at Later Date for Other Reason","Align to Customer's Renewal Date"]},"currency":{"maxLength":3,"type":"string","description":"Subscription currency in a three-letter ISO currency code.","example":"CAD"},"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of each term. Defaults to true. Only applicable for `createSubscription` quote action if the initial term type is TERMED.","example":true,"default":true},"add_offers":{"maxItems":10,"type":"array","description":"New offers to be added to a subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription's end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Recording storage capacity in GB"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute's details."}},"discounts":{"maxItems":30,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"Discount details."}}},"description":"The subscription plan details."}},"add_add_ons":{"maxItems":10,"type":"array","description":"The new add-ons to be added to a subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription's end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":30,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"Discount details."}}},"description":"The subscription plan details."}},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this subscription.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if 'requires_professional_services' is set to 'Yes, Zoom will do the deployment.'","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if 'is_zoom_pso_org_engaged' is set to 'Yes and I have a PSO Engagement Request ID.'","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details. Required with 'deployment_partner_name'."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment.'"},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if `requires_professional_services` is `true`.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Creates a new subscription quote."}},"amend_subscriptions":{"maxItems":1,"type":"array","description":"The quote details for amending an existing subscription.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"The subscription number of the subscription being updated. Required for paid subscription amendments. This field is ignored for trial quotes.","example":"A-31231322"},"end_customer_account_number":{"type":"string","description":"The end customer Zoom account number. Required for amend trial quote. This field is ignored for paid subscription amendments.","example":"1232412317"},"add_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be added in the subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge that this discount applies to.","example":"PRLC-3223"}},"description":"Discount details."}}},"description":"The subscription plan details."}},"add_add_ons":{"maxItems":5,"type":"array","description":"The offer details for add-ons to be added in the subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer's price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"Discount details."}}},"description":"The subscription plan details."}},"upgrade_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be upgraded in the subscription.","items":{"required":["start_date"],"type":"object","properties":{"new_offer_price_list_id":{"type":"string","description":"The new offer price list ID.","example":"Off-2323"},"new_partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"old_offer_price_list_id":{"type":"string","description":"The existing offer price list ID.","example":"Off-2564"},"old_partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"old_subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"Discount details."}}},"description":"Cancels and replaces the subscription plan amendment."}},"remove_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be removed from the subscription.","items":{"required":["end_date","offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID for the offer to be removed from the subscription.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"end_date":{"type":"string","description":"The date when the offer will be removed. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"remove_reason":{"type":"string","description":"The reason for cancellation.","example":"Downsell"}},"description":"Remove subscription plan."}},"update_offers":{"maxItems":5,"type":"array","description":"Update terms and quantity of an offer or add-on.","items":{"required":["offer_price_list_id","start_date"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"Offer price list ID for the offer to be updated.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"Number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Change start date. Should be between today and subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"Offer specific attributes like number of hosts, participant capacity, etc.","items":{"type":"object","properties":{"name":{"type":"string","description":"Attribute name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"Attribute value.","example":"10"}},"description":"Offer attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either `percent_value` or `amount_value` is required, but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either `percent_value` or `amount_value` is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"Discount details."}}},"description":"Subscription update details."}},"cancel_subscription":{"required":["cancel_by","cancel_reason"],"type":"object","properties":{"cancel_by":{"type":"string","description":"When the subscription will be cancelled. Required for paid subscriptions. Currently only 'EndOfCurrentTerm' is supported.","example":"EndOfCurrentTerm","enum":["EndOfCurrentTerm","EndOfLastInvoicePeriod","SpecificDate"]},"cancel_on":{"type":"string","description":"Must be provided if `cancel_by` is `SpecificDate`.","format":"YYYY-MM-DD","example":"2023-10-03"},"cancel_reason":{"maxLength":250,"type":"string","description":"Reason for cancellation.","example":"Downsell"}},"description":"Cancellation details."},"renew_subscription":{"type":"object","properties":{"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The term's duration, in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The term's start date, in `YYYY-MM-DD` format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The term's end date, in `YYYY-MM-DD` format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"Subscription initial, renewal or current term."},"discounts":{"maxItems":30,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge that this discount applies to.","example":"PRLC-3223"},"subscription_price_list_id":{"type":"string","description":"Unique identifier for subscription line where the discount was applied.","example":"SRP1234"}},"description":"Discount details."}}},"description":"Renewal details."},"update_subscription":{"type":"object","properties":{"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of each term. Only applicable if the initial term type is TERMED. If auto_renew is true, providing renewal_term is required.","example":true},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The term's duration, in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The term's start date, in `YYYY-MM-DD` format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The term's end date, in `YYYY-MM-DD` format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's renewal term. Required for paid subscriptions when `order_type` = `sale`."},"sold_to_crm_contact_number":{"type":"string","description":"CRM contact number for the sold to contact.","example":"C-232442"},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if the subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if 'requires_professional_services' is set to 'Yes, Zoom will do the deployment'.","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if 'is_zoom_pso_org_engaged' is set to 'Yes and I have a PSO Engagement Request ID'.","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details. Required with 'deployment_partner_name'."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment.'"},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if `requires_professional_services` is true.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Update subscription attributes."},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this subscription.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}}},"description":"Amend quote request details."}}},"description":"The quote request details."}}}},"responses":{"201":{"description":"Quote created successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"3brejfbhweury38ry83riu3bewh"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of the quote.","example":"submitted","enum":["failedToSubmit","submitted"]},"quote_reference_id":{"type":"string","description":"Reference ID for a quote.","example":"QO-3248714941"},"quote_date":{"type":"string","description":"The date when quote should be placed in the billing system.","format":"YYYY-MM-DD","example":"2023-10-03"},"errors":{"maxItems":20,"type":"array","description":"Array of messages in case of validation errors.","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"Error code.","example":"5604"},"error_description":{"type":"string","description":"Error description.","example":"No pricebook exists with given offer_price_list_id."}},"description":"Error code and message."}}},"description":"The quote details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5135` <br>\n Invalid sub reseller account number. <br>\n**Error Code:** `5136` <br>\n Invalid end customer account number. <br>\n**Error Code:** `5142` <br>\n Invalid end customer CRM account number. <br>\n**Error Code:** `5601` <br>\n Cancel_on is required when cancel_by is SpecificDate. <br>\n**Error Code:** `5604` <br>\n No pricebook exists with given offer_price_list_id. <br>\n**Error Code:** `5660` <br>\n No pricebook exists with given partner SKU code. <br>\n**Error Code:** `5605` <br>\n Request body can not be blank. <br>\n**Error Code:** `5606` <br>\n Quote header can not be null. <br>\n**Error Code:** `5607` <br>\n Quote date cannot be blank. <br>\n**Error Code:** `5608` <br>\n Invalid quote date format. Expected format is `YYYY-MM-DD`. <br>\n**Error Code:** `5609` <br>\n Quote date can not be of past. <br>\n**Error Code:** `5611` <br>\n Invalid quantity. <br>\n**Error Code:** `5610` <br>\n Invalid PO Number. <br>\n**Error Code:** `5623` <br>\n Invalid quote type. <br>\n**Error Code:** `5616` <br>\n For amendment quote, subscription number cannot be blank. <br>\n**Error Code:** `5617` <br>\n Sub reseller crm_account_number cannot be blank. <br>\n**Error Code:** `5618` <br>\n Sub reseller account_name cannot be blank. <br>\n**Error Code:** `5619` <br>\n Start date cannot be blank. <br>\n**Error Code:** `5002` <br>\n Invalid cancel on date format. Expected format is `YYYY-MM-DD`. <br>\n**Error Code:** `5678` <br>\n Invalid subscription number. <br>\n**Error Code:** `5625` <br>\n Start date should be in valid date format (`YYYY-MM-DD`) and greater than or equal to today. <br>\n**Error Code:** `5627` <br>\n Initial Term Type must be one of these: TERMED, or EVERGREEN. <br>\n**Error Code:** `5629` <br>\n Initial term periodType is mandatory for termType TERMED and must be one of these: Month, or Year. <br>\n**Error Code:** `5630` <br>\n Initial term termPeriod is mandatory for termType TERMED and must be between 1 to 60 months. <br>\n**Error Code:** `5633` <br>\n For cancel subscription, remove reason cannot be blank. <br>\n**Error Code:** `5634` <br>\n For cancel subscription, remove reason must be at most 255 characters. <br>\n**Error Code:** `5635` <br>\n For cancel subscription, cancel reason cannot be blank. <br>\n**Error Code:** `5636` <br>\n For cancel subscription, cancel reason must be at most 255 characters. <br>\n**Error Code:** `5639` <br>\n Currency must be in a valid ISO currency code. <br>\n**Error Code:** `5009` <br>\n Value is not a whole number. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition that prevented it from fulfilling the request. \n\n **Error Code:** `5632` <br>\n Unable to process the quote. <br>\n"}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:write:quote:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:write:quote:admin"]}}},"/commerce/quote/preview":{"post":{"tags":["Quote"],"summary":"Preview delta quote metrics and subscriptions in a quote ","description":"Previews the delta quote metrics and subscriptions in a quote. The API can be used to validate the quote and get metrics like TCV, applicable discounts, and net MRR before submitting the quote for actual creation and provisioning. This operation is only a quote preview and no quote is submitted for approval and fulfillment. To submit the quote, use the quote API. <br><b>Note:</b> Please check the base URL for sandbox and production environments in the Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:quote:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`\n\n**Not supported in Gov cluster** ","operationId":"createQuotePreview","parameters":[{"name":"invoice-owner-crm-account-number","in":"header","description":"The CRM account number for the invoice owner if it is one of the sibling accounts.","required":false,"schema":{"type":"string","example":"A-3454374"}}],"requestBody":{"description":"This setting creates a quote preview for a Zoom partner.","content":{"application/json":{"schema":{"required":["header"],"type":"object","properties":{"header":{"required":["quote_date"],"type":"object","properties":{"quote_type":{"type":"string","description":"The type of quote. Supported values are 'trial' and 'sale'.","example":"sale","default":"sale","enum":["trial","sale"]},"quote_description":{"maxLength":500,"type":"string","description":"A description of the quote.","example":"New ZCC subscription for ABC Pvt. Ltd."},"deal_reg_number":{"type":"string","description":"The registration number of the deal registered by a partner or reseller.","example":"DELREG-1002-L1"},"quote_date":{"type":"string","description":"The quote date in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"quote_expiry_date":{"type":"string","description":"The date when the quote will expire. If not provided, the quote will expire in 30 days from the date of creation. Maximum allowed expiry date is 180 days.","format":"YYYY-MM-DD","example":"2023-11-02"},"po_number":{"type":"string","description":"The purchase order number.","example":"PO-10021-A"},"negotiation_note":{"maxLength":1000,"type":"string","description":"A note for a negotiation deal for the quote.","example":"Additional discount for a new large deal."},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this quote.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}}},"description":"The quote header's details."},"create_subscriptions":{"maxItems":1,"type":"array","description":"The quote details for creating a new subscription.","items":{"required":["currency","initial_term","sold_to_crm_contact_number"],"type":"object","properties":{"end_customer_account_number":{"maxLength":10,"type":"string","description":"The end customer's Zoom account number.","example":"5333445346"},"end_customer_crm_account_number":{"type":"string","description":"The CRM account number for the end customer.","example":"A-3454334"},"sold_to_crm_contact_number":{"type":"string","description":"The CRM contact's number for the 'sold to contact'.","example":"C-232442"},"end_customer_language":{"type":"string","description":"The language to use to set the communication and invoice profile for the end customer. This will default to a language based on the end customer's country if left blank.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"initial_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then the 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"}},"description":"The subscription's initial, renewal, or current term."},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then the 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's initial, renewal, or current term."},"sub_reseller":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The sub-reseller's CRM account number.","example":"A-45r33"},"account_name":{"type":"string","description":"The sub-reseller's name.","example":"Novam Corp."}},"description":"The sub-reseller's account number."},"service_start_date":{"type":"string","description":"The service start date. It should be equal to or before `paid_period_start_date`.","format":"YYYY-MM-DD","example":"2024-03-20"},"paid_period_start_date":{"type":"string","description":"The subscription paid period start date. Required if the subscription has a free period.","format":"YYYY-MM-DD","example":"2024-03-20"},"free_months_reason_code":{"type":"string","description":"The reason for requesting a free period in the subscription. Required if the subscription has a free period.","example":"Customer's Desired Billing/Start Date","enum":["Customer's Desired Billing/Start Date","Billing at Later Date for Other Reason","Align to Customer's Renewal Date"]},"currency":{"maxLength":3,"type":"string","description":"The subscription currency in a three-letter ISO currency code.","example":"CAD"},"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of each term. Defaults to true. Only applicable for \"createSubscription\" quote action if the initial term type is TERMED.","example":true,"default":true},"add_offers":{"maxItems":10,"type":"array","description":"New offers to be added to a subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription's end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Recording storage capacity in GB"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute's details."}},"discounts":{"maxItems":30,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value is supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"The subscription plan details."}},"add_add_ons":{"maxItems":10,"type":"array","description":"The new add-ons to be added to a subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription's end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":30,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value is supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"The subscription plan details."}},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this subscription.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if the subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if 'requires_professional_services' is set to 'Yes, Zoom will do the deployment.'","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if 'is_zoom_pso_org_engaged' is set to 'Yes and I have a PSO Engagement Request ID.'","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"The deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details. Required with 'deployment_partner_name'."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment.'"},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services. This should be provided if \"requires_professional_services\" is true.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Creates a new subscription quote."}},"amend_subscriptions":{"maxItems":1,"type":"array","description":"The quote details for amending an existing subscription.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"The subscription number of the subscription being updated. Required for paid subscription amendments. This field is ignored for trial quotes.","example":"A-31231322"},"end_customer_account_number":{"type":"string","description":"The end customer Zoom account number. Required for amend trial quote. This field is ignored for paid subscription amendments.","example":"1232412317"},"add_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be added in the subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value is supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"The subscription plan details."}},"add_add_ons":{"maxItems":5,"type":"array","description":"The offer details for add-ons to be added in the subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value is supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"The subscription plan details."}},"upgrade_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be upgraded in the subscription.","items":{"required":["start_date"],"type":"object","properties":{"new_offer_price_list_id":{"type":"string","description":"The new offer price list ID.","example":"Off-2323"},"new_partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"old_offer_price_list_id":{"type":"string","description":"The existing offer price list ID.","example":"Off-2564"},"old_partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"old_subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value is supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"Cancels and replaces the subscription plan amendment."}},"remove_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be removed from the subscription.","items":{"required":["end_date","offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID for the offer to be removed from the subscription.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"end_date":{"type":"string","description":"The date when the offer will be removed. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"remove_reason":{"type":"string","description":"The reason for cancellation.","example":"Downsell"}},"description":"Remove subscription plan."}},"update_offers":{"maxItems":5,"type":"array","description":"Updated terms and quantity of an offer or add-on.","items":{"required":["offer_price_list_id","start_date"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID for the offer to be updated.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"The number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"The change start date. Should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer specific attributes like the number of hosts and participant capacity.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute value.","example":"10"}},"description":"The offer attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value is supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"The subscription update details."}},"cancel_subscription":{"required":["cancel_by","cancel_reason"],"type":"object","properties":{"cancel_by":{"type":"string","description":"When the subscription will be cancelled. Required for paid subscriptions. Currently only 'EndOfCurrentTerm' is supported.","example":"EndOfCurrentTerm","enum":["EndOfCurrentTerm","EndOfLastInvoicePeriod","SpecificDate"]},"cancel_on":{"type":"string","description":"Must be provided if cancel_by is SpecificDate.","format":"YYYY-MM-DD","example":"2023-10-03"},"cancel_reason":{"maxLength":250,"type":"string","description":"The reason for cancellation.","example":"Downsell"}},"description":"The cancellation details."},"renew_subscription":{"type":"object","properties":{"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then the 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's initial, renewal, or current term."},"discounts":{"maxItems":30,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value is supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"},"subscription_price_list_id":{"type":"string","description":"Unique identifier for the subscription line where the discount was applied.","example":"SRP1234"}},"description":"The discount details."}}},"description":"The renewal details."},"update_subscription":{"type":"object","properties":{"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of each term. Only applicable if the initial term type is TERMED. If `auto_renew` is `true`, providing `renewal_term` is required.","example":true},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then the 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's renewal term. Required for paid subscriptions (order_type = sale)."},"sold_to_crm_contact_number":{"type":"string","description":"The CRM contact number for the sold to contact.","example":"C-232442"},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if the subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if 'requires_professional_services' is set to 'Yes, Zoom will do the deployment'.","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if 'is_zoom_pso_org_engaged' is set to 'Yes and I have a PSO Engagement Request ID'.","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"The deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details. Required with 'deployment_partner_name'."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment.'"},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services. This should be provided if \"requires_professional_services\" is true.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Update subscription attributes."},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this subscription.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}}},"description":"Amend quote request details."}}},"description":"The quote request details."}}}},"responses":{"201":{"description":"Quote created successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBfjir8t94et54ietje4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"The preview status of the quote.","example":"submitted","enum":["failedToSubmit","submitted"]},"quote_reference_id":{"type":"string","description":"The reference ID for a quote.","example":"OR-3248714941"},"quote_date":{"type":"string","description":"The date when the quote should be placed in the billing system.","format":"MM-DD-YYYY","example":"07-01-2024"},"quote_metrics":{"type":"object","properties":{"tcv":{"type":"number","description":"The total contract value. This is the total amount that has been booked over the duration of the charge.","format":"double","example":100000},"tcb":{"type":"number","description":"The total contracted billing. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge.","format":"double","example":100000},"mrr":{"type":"number","description":"The monthly recurring revenue.","format":"double","example":1000},"total_discount_pct":{"type":"number","description":"The total discount applied (in percentage).","format":"percentage","example":0.1}},"description":"The quote metrics, such as TCV, MRR, or TCB."},"subscription_preview":{"maxItems":1,"type":"array","description":"The subscription metrics preview.","items":{"type":"object","properties":{"subscription_number":{"type":"object","description":"The subscription number of the subscription.","example":"A-31231322"},"paid_period_start_date":{"type":"string","description":"The subscription paid period start date. This is set (overridden) by the system if the deal registration is associated with a strategic program.","format":"YYYY-MM-DD","example":"2024-03-20"},"tcv":{"type":"number","description":"The total contract value. This is the total amount that has been booked over the duration of the charge.","format":"double","example":100000},"tcb":{"type":"number","description":"The total contracted billing. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge.","format":"double","example":100000},"mrr":{"type":"number","description":"The monthly recurring revenue.","format":"double","example":1000},"total_discount_pct":{"type":"number","description":"The total discount applied (in percentage).","format":"percentage","example":0.1}},"description":"The subscription metrics, such as TCV, MRR, or TCB."}},"subscription_item_metrics":{"maxItems":30,"type":"array","description":"The array of subscription line items.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"The offer or plan ID.","example":"PR-2323"},"offer_name":{"type":"string","description":"The offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"The offer SKU.","example":"SKU-00000118"},"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"offer_price_list_name":{"type":"string","description":"The offer price list name.","example":"Zoom Workplace Pro Annual"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"The charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"The charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"The money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"Represents the sale price, list price, net amount, or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"The money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"Represents the sale price, list price, net amount, or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"The money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"Represents the sale price, list price, net amount, or gross amount."},"discounts":{"maxItems":5,"type":"array","description":"Applicable discounts.","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Supported values are \"DealReg\", \"Partner\", \"Exception\".","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"Specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\", and \"ONETIMERECURRINGUSAGE\".","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"]},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount is applied.","example":"PRLC-3223"},"discount_level":{"type":"string","description":"The application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\", \"subscription\", and \"account\".","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"The name of the strategic program if it's a strategic program discount.","example":"VLA program"}},"description":"The discount details."}}}}},"mrr":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"Represents the sale price, list price, net amount, or gross amount."}},"description":"The subscription's line metrics."}},"errors":{"maxItems":20,"type":"array","description":"The array of messages in case of validation or processing errors.","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"The error code.","example":"5604"},"error_description":{"type":"string","description":"The error description.","example":"No pricebook exists with given offer_price_list_id."}},"description":"The error code and message."}},"warnings":{"maxItems":20,"type":"array","description":"The array of messages in case of validation or processing warnings.","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"The error code.","example":"5604"},"error_description":{"type":"string","description":"The error description.","example":"No pricebook exists with given offer_price_list_id."}},"description":"The error code and message."}}},"description":"The quote's preview response."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n **Error Code:** `6103` <br>\n Unable to preview quote. Please try again later. <br>\n"}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:write:quote:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:write:quote:admin"]}}},"/commerce/quotes":{"get":{"tags":["Quote"],"summary":"Gets all quotes for a Zoom partner","description":"Returns all quotes for a Zoom partner based on specified filters. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api). \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:quote:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"getAllQuotes","parameters":[{"name":"page_size","in":"query","description":"The number of records returned per page in the response.","required":false,"schema":{"maximum":100,"minimum":20,"type":"integer","example":50,"default":20}},{"name":"page_num","in":"query","description":"The page number for fetching the next page of the result set.","required":false,"schema":{"type":"string","example":"3"}},{"name":"date_filter_option","in":"query","description":"The date type to filter on. Default is effectiveDate.","required":false,"schema":{"type":"string","example":"effectiveDate","default":"effectiveDate","enum":["effectiveDate","createdDate","updatedDate"]}},{"name":"from","in":"query","description":"This field indicates the from date to filter the result. The result will only contain the quotes with the date of date_filter_option later than or equal to this date. The range can not be more than 3 years.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2022-02-10"}},{"name":"to","in":"query","description":"To date to filter the result. The result will only contain the quotes with the date of date_filter_option earlier than or equal to this date. The range can not be more than 3 years.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2024-02-10"}},{"name":"quote_type","in":"query","description":"This field filters results by `quote_type`. Supported values are 'trial', 'sale'.","required":false,"schema":{"type":"string","example":"sale","default":"sale","enum":["trial","sale"]}},{"name":"quote_reference_id","in":"query","description":"This field filters results based on quote reference ID. It should be minimum of three characters.","required":false,"schema":{"type":"string","example":"OR-125613343"}},{"name":"quote_number","in":"query","description":"This field filter results based on quote number. It should be minimum of three characters.","required":false,"schema":{"type":"string","example":"O-3429342"}},{"name":"po_number","in":"query","description":"This field filters results based on purchase order number.","required":false,"schema":{"type":"string","example":"PO-1381273"}},{"name":"deal_reg_number","in":"query","description":"This field filters results based on deal registration number.","required":false,"schema":{"type":"string","example":"DR-132833"}},{"name":"end_customer_name","in":"query","description":"This field filters results based on End customer name. It should be minimum of 3 characters. Characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"John"}},{"name":"end_customer_crm_account_number","in":"query","description":"This field filters results based on End customer CRM account number. It should be minimum of 3 characters.","required":false,"schema":{"type":"string","example":"A-3454334"}},{"name":"end_customer_zoom_account_number","in":"query","description":"This field filters results based on a subscription number. It should be a minimum of 3 characters.","required":false,"schema":{"maxLength":10,"minLength":3,"type":"string","example":"4435343789"}},{"name":"sub_reseller_name","in":"query","description":"This field filters results based on a subscription number. It should be a minimum of 3 characters. Characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"John"}},{"name":"sub_reseller_crm_account_number","in":"query","description":"This field filters results based on sub-reseller CRM account number. It should be a minimum of 3 characters.","required":false,"schema":{"type":"string","example":"A-348742"}},{"name":"invoice_owner_crm_account_number","in":"query","description":"This field filters orders by the CRM account number for the Invoice Owner.","required":false,"schema":{"type":"string","example":"A-3454374"}},{"name":"status","in":"query","description":"This field filters the results by quote status.","required":false,"schema":{"type":"string","example":"submitted","enum":["failedToSubmit","completed","canceled","submitted","failed","approved","rejected","returned","provisioning"]}},{"name":"subscription_number","in":"query","description":"This field filters results based on a subscription number. It should be a minimum of 3 characters.","required":false,"schema":{"maxLength":15,"minLength":3,"type":"string","example":"A-348742"}},{"name":"transaction_type","in":"query","description":"This field filters results based on the transaction type for the quote. Possible values are New or Amend.","required":false,"schema":{"type":"string","example":"New","enum":["New","Amend"]}},{"name":"sort","in":"query","description":"This field sorts the result by any one of the supported fields. Default is `updatedDate`.","required":false,"schema":{"type":"string","example":"quoteNumber.asc","default":"updatedDate.asc","enum":["quoteNumber.asc","quoteNumber.desc","quoteReferenceId.asc","quoteReferenceId.desc ","zoomAccountNumber.asc ","dealRegistrationNumber.asc","dealRegistrationNumber.desc","poNumber.asc","poNumber.desc","subResellerName.asc","subResellerName.desc","status.asc","status.desc","effectiveDate.asc","effectiveDate.desc","updatedDate.asc","updatedDate.desc"]}}],"responses":{"200":{"description":"Quotes returned successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"page_count":{"type":"integer","description":"The total number of pages in the result set.","example":20},"quote_list":{"maxItems":100,"type":"array","description":"The quotes list.","items":{"type":"object","properties":{"quote_reference_id":{"type":"string","description":"The reference ID for a draft quote.","example":"OR-125613343"},"quote_number":{"type":"string","description":"The quote number of the quote.","example":"O-3429342"},"status":{"type":"string","description":"The status of the quote.","example":"submitted","enum":["failedToSubmit","completed","canceled","submitted","failed","approved","rejected","returned","provisioning"]},"quote_type":{"type":"string","description":"Type of quote","example":"sale","enum":["trial","sale"]},"transaction_type":{"type":"string","description":"The transaction type for the order. Possible values are New or Amend.","example":"New","enum":["New","Amend"]},"end_customer_account_name":{"type":"string","description":"The end customer's account name.","example":"dfreABC Pvt. Ltd."},"end_customer_account_number":{"maxLength":10,"type":"string","description":"The end customer's Zoom account number.","example":"3842618277"},"end_customer_crm_account_number":{"maxLength":10,"type":"string","description":"The end customer's CRM account number.","example":"A-3454334"},"sub_reseller_name":{"type":"string","description":"The sub-reseller's name if the quote was placed by a distributor on their behalf.","example":"John"},"sub_reseller_crm_account_number":{"type":"string","description":"The sub-reseller's CRM account number if the quote was placed by a distributor on their behalf.","example":"A-348742"},"invoice_owner_name":{"type":"string","description":"The sub-reseller's name if the quote was placed by a distributor on their behalf.","example":"John"},"invoice_owner_crm_account_number":{"type":"string","description":"The invoice owner's CRM account number if the quote was placed by a distributor on their behalf.","example":"A-348742"},"creation_date":{"type":"string","description":"The date when this quote was created.","format":"YYYY-MM-DD","example":"2024-07-01"},"effective_date":{"type":"string","description":"The date when this quote was activated. Also the contract's effective date.","format":"YYYY-MM-DD","example":"2024-07-01"},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"The money value.","example":100000},"currency":{"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"The net quote value."},"updated_date":{"type":"string","description":"The date when this quote was last updated.","format":"YYYY-MM-DD","example":"2024-07-01"},"trade_screening":{"type":"boolean","description":"The flag to indicate whether the subcription cleared trade screening check or not.","example":false},"deal_reg_number":{"type":"string","description":"The registration number of the deal registered by partner or reseller.","example":"DELREG-1002-L1"},"po_number":{"type":"string","description":"The purchase order's number.","example":"PO-10021-A"}},"description":"The list of quotes."}}},"description":"The list of quotes."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `6200` <br>\n Invalid quote type. <br>\n**Error Code:** `6201` <br>\n Invalid quote status. <br>\n**Error Code:** `6202` <br>\n Invalid sort value. <br>\n**Error Code:** `6203` <br>\n Invalid filter type. <br>\n**Error Code:** `5000` <br>\n Invalid character & or | in the name filter. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition that prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:quote:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:quote:admin"]}}},"/commerce/quotes/{quoteReferenceId}":{"get":{"tags":["Quote"],"summary":"Get quote details by quote reference ID","description":"Get quote details by quote reference ID. \n**Note** Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:quote:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"getQuoteDetails","parameters":[{"name":"quoteReferenceId","in":"path","description":"Quote reference ID.","required":true,"schema":{"type":"string","example":"QU-3248714941"}}],"responses":{"200":{"description":"Quote returned successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"hfuer734873rh3ekjj3idn"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"header":{"required":["quote_date"],"type":"object","properties":{"quote_reference_id":{"type":"string","description":"Reference ID for a quote.","example":"QU-3248714941"},"quote_type":{"type":"string","description":"Type of quote - sale or trial.","example":"sale","default":"sale","enum":["trial","sale"]},"transaction_type":{"type":"string","description":"The transaction type for the quote. Possible values are New or Amend.","example":"New","enum":["New","Amend"]},"quote_description":{"maxLength":500,"type":"string","description":"The description for the quote.","example":"New ZCC subscription for ABC Pvt. Ltd."},"status":{"type":"string","description":"The status of the quote.","example":"submitted","enum":["failedToSubmit","completed","canceled","submitted","failed","approved","rejected","returned","provisioning","recalled"]},"quote_number":{"type":"string","description":"The billing system quote number when the quote is successfully submitted or completed.","example":"Q-1012312"},"deal_reg_number":{"type":"string","description":"Registration number of the deal registered by partner or reseller.","example":"DELREG-1002-L1"},"quote_date":{"type":"string","description":"Quote date in `YYYY-MM-DD` format.","format":"YYYY-MM-DD","example":"2022-10-25"},"quote_expiry_date":{"type":"string","description":"The date when quote will expire. If not provided, the quote will expire in 30 days from the date of creation. Max allowed expiry date is 180 days.","format":"YYYY-MM-DD","example":"2023-11-02"},"po_number":{"type":"string","description":"Purchase order number.","example":"PO-10021-A"},"trade_screening":{"type":"boolean","description":"The flag to indicate whether the subscription cleared trade screening check or not.","example":false},"quote_metrics":{"type":"object","properties":{"tcv":{"type":"number","description":"Total contract value. This is the total amount that has been booked over the duration of the charge.","format":"double","example":120000},"tcb":{"type":"number","description":"Total contracted billing. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge.","format":"double","example":120000},"mrr":{"type":"number","description":"Monthly recurring revenue.","format":"double","example":10000},"total_discount_pct":{"type":"number","description":"Total discount applied (in percentage).","format":"percentage","example":0.1}},"description":"Quote metrics like total contract value (tcv), monthly recurring revenue (mrr), total contracted billing (tcb)."},"negotiations":{"maxItems":20,"type":"array","description":"Negotiation activities.","items":{"type":"object","properties":{"partner_note":{"type":"string","description":"Note or comment added by the partner.","example":"Need additional information for approving exception discount"},"zoom_note":{"type":"string","description":"Note or comment added by Zoom team.","example":"Exception discount not matching promo code."},"action_by":{"type":"string","description":"Note or comment added by Partner or Zoom team.","example":"Zoom COPS","enum":["Partner","Zoom COPS"]},"as_of_date":{"type":"string","description":"When the note was added.","example":"2022-10-25T12:10:234Z"},"status":{"type":"string","description":"What action, if any, was taken on the quote.","example":"Rejected","enum":["Submitted","Rejected","Approved","Provisioned"]},"quote_number":{"type":"string","description":"Quote number associated with this action.","example":"Q-1012312"}}}},"documents":{"maxItems":10,"type":"array","description":"Documents uploaded for this quote provisioning.","items":{"type":"object","properties":{"document_reference_id":{"type":"string","description":"Unique reference ID for the uploaded file.","example":"DOC-1234"},"document_note":{"maxLength":1000,"type":"string","description":"Note associated with the document.","example":"Latest purchase order."},"document_type":{"type":"string","description":"Type of document.","example":"Purchase Order","enum":["Purchase Order","Customer Acceptance","Other","Quote"]}}}},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this quote.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, or Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}}},"description":"Quote header details."},"create_subscriptions":{"maxItems":1,"type":"array","description":"New subscription quote details.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"Subscription number of the subscription, which is created or updated. Will be blank if subscription creation is not complete.","example":"A-1232632"},"end_customer_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom account number for the customer or partner/reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM account number for the customer or partner/reseller.","example":"A-1234"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"Type of address - billTo, shipTo, soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address line 1.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address line 2.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address line 3.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"City name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"Postal or zip code/number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"State or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"ISO code for the country.","example":"US"}},"description":"Address details."}},"description":"Account details."},"invoice_owner_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom account number for the customer or partner/reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM account number for the customer or partner/reseller.","example":"A-1234"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"Type of address - billTo, shipTo, soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address line 1.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address line 2.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address line 3.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"City name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"Postal or zip code/number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"State or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"ISO code for the country.","example":"US"}},"description":"Address details."}},"description":"Account details."},"sub_reseller":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom account number for the customer or partner/reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM account number for the customer or partner/reseller.","example":"A-1232"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"Type of address - billTo, shipTo, soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address line 1.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address line 2.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address line 3.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"City name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"Postal or zip code/number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"State or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"ISO code for the country.","example":"US"}},"description":"Address details."}},"description":"Account details."},"sold_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"Unique CRM Number for the contact.","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the sold to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the sold to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email address.","example":"abc@test.com"}},"description":"Sold to contact details."},"bill_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"Unique CRM Number for the contact.","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the bill to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the bill to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email address.","example":"abc@example.com"}},"description":"Bill to contact details."},"initial_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The subscription term's type. Supported values are TERMED and EVERGREEN. If the subscription is TERMED, then `period` and `period_type` fields are also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The term's duration in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The term's start date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"The term's end date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"}},"description":"Subscription initial, renewal or current term."},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The subscription term's type. Supported values are TERMED and EVERGREEN. If the subscription is TERMED, then `period` and `period_type` fields are also required.","example":"TERMED","enum":["TERMED","EVERGREEN"]},"term_period":{"type":"integer","description":"The term's duration in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The term's start date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"The term's end date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"}},"description":"Subscription initial, renewal or current term."},"agreement_dates":{"type":"object","properties":{"contract_effective_date":{"type":"string","description":"The date when the contract will be effective from. It is a required field to provide in the quote when quote action type is `createSubscription`, in YYYY-MM-DD format and if `quote_date` is different from contract effective date.","format":"YYYY-MM-DD","example":"2022-10-25"},"service_activation_date":{"type":"string","description":"The date when the service will be activated from, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"customer_acceptance_date":{"type":"string","description":"The date when the quote was approved by the customer. It is a required field to provide in the quote when quote action type is `addOffer`, `createSubscription`, `addOn`, `upgrade`, `upsell`, `renewSubscription`, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"}},"description":"Subscription agreement dates."},"sold_to_crm_contact_number":{"type":"string","description":"CRM contact number for the sold to contact.","example":"C-34267"},"end_customer_language":{"type":"string","description":"The language to be used to set the communication and invoice profile for the end customer.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"payment_term":{"type":"string","description":"The payment term for this subscription. Supported values are - Due upon Receipt, Net30, Net45 and Net60. If null, will be defaulted to the payment term associated with the account.","example":"Net30","enum":["Due upon Receipt","Net30","Net45","Net60"]},"service_start_date":{"type":"string","description":"Service start date. Equal to or before paid_period_start_date.","format":"YYYY-MM-DD","example":"2022-10-25"},"paid_period_start_date":{"type":"string","description":"Subscription paid period start date. Required if the subscription has free periods.","format":"YYYY-MM-DD","example":"2022-10-25"},"free_months_included":{"type":"boolean","description":"True if the quote created a free period subscription.","example":false},"free_months_reason_code":{"type":"string","description":"Reason for free period in the subscription. Required if the subscription has free period.","example":"Billing at Later Date for Other Reason","enum":["Customer's Desired Billing/Start Date","Billing at Later Date for Other Reason","Align to Customer's Renewal Date"]},"auto_renew":{"type":"boolean","description":"Specifies whether the subscription automatically renews at the end of the each term. Defaults to true. Only applicable for \"createSubscription\" quote action if the initial term type is TERMED.","example":true,"default":true},"currency":{"maxLength":3,"type":"string","description":"Subscription currency in 3-letter ISO currency code.","example":"CAD"},"deal_reg_number":{"type":"string","description":"Registration number of the deal registered by partner/reseller.","example":"DELREG-1002-L1"},"po_number":{"type":"string","description":"Purchase order number.","example":"PO-10021-A"},"subscription_metrics":{"type":"object","properties":{"subscription_number":{"type":"string","description":"Subscription number of the subscription.","example":"A2324323"},"tcv":{"type":"number","description":"Total contract value. This is the total amount that has been booked over the duration of the charge.","format":"double","example":120000},"tcb":{"type":"number","description":"Total contracted billing. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge.","format":"double","example":120000},"mrr":{"type":"number","description":"Monthly recurring revenue.","format":"double","example":10000},"total_discount_pct":{"type":"number","description":"Total discount applied (in percentage).","format":"percentage","example":10}},"description":"Subscription metrics like total contract value (tcv), monthly recurring revenue (mrr), total contracted billing (tcb)."},"offers":{"maxItems":10,"type":"array","description":"Subscription lines for new subscription.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer or plan ID.","example":"Off-34213"},"offer_name":{"type":"string","description":"Offer/plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU.","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID.","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name.","example":"Zoom Workplace Pro Annual"},"quantity":{"type":"integer","description":"Number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"Charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"Charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"total_discount":{"type":"number","description":"Total discount applied on the charge.","format":"double","example":20},"discounts":{"type":"array","description":"Applicable discounts.","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount.","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"Specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\".","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE"]},"apply_to_charge":{"type":"string","description":"The charge ID for the charge that this discount applies to.","example":"PRLC-3223"},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\".","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"True if the plan has a usage or overage based charge.","example":true}},"description":"Quote subscription lines."}},"add_ons":{"maxItems":10,"type":"array","description":"The add-ons for new subscription.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"The offer or plan ID.","example":"OFF-4556"},"offer_name":{"type":"string","description":"The offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"The offer SKU.","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"The offer price list name.","example":"Zoom Workplace Pro Annual"},"quantity":{"type":"integer","description":"The number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"The charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"The charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"total_discount":{"type":"number","description":"Total discount applied on the charge.","format":"double","example":20},"discounts":{"type":"array","description":"Applicable discounts.","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Supported values are \"DealReg\", \"Partner\", \"Exception\".","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"Specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\".","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE"]},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount is applied.","example":"PRLC-3223"},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\".","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"True if the plan has a usage or overage based charge.","example":true}},"description":"Quote subscription lines."}},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this subscription.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if `requires_professional_services` is set to `Yes, Zoom will do the deployment`.","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if `is_zoom_pso_org_engaged` is set to `Yes and I have a PSO Engagement Request ID`.","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment."},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if `requires_professional_services` is `true`.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Quote subscription details for a new subscription creation."}},"amend_subscriptions":{"maxItems":5,"type":"array","description":"Amendment quote details.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"Subscription number of the subscription, which is created or updated. Will be blank if subscription creation is not complete.","example":"A-4534587"},"end_customer_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom account number for the customer, partner, or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM account number for the customer, partner, or reseller.","example":"A-1234"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The address type.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address line 1.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address line 2.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address line 3.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"City name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"Postal or zip code or number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"State or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The country's ISO code.","example":"US"}},"description":"Address details."}},"description":"Account details."},"invoice_owner_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom account number for the customer, partner, or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM account number for the customer, partner, or reseller.","example":"A-1234"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The address type.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address line 1.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address line 2.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address line 3.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"City name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"Postal or zip code or number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"State or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The country's ISO code.","example":"US"}},"description":"Address details."}},"description":"Account details."},"sub_reseller":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"Unique Zoom account number for the customer, partner, or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"Unique CRM account number for the customer, partner, or reseller.","example":"A-1234"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The address type.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"Street address line 1.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"Street address line 2.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"Street address line 3.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"City name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"Postal or zip code or number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"State or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The country's ISO code.","example":"US"}},"description":"Address details."}},"description":"Account details."},"sold_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"The contact's unique CRM number.","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the sold to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the sold to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email address.","example":"Abc@example.com"}},"description":"Sold to contact details."},"bill_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"The contact's unique CRM number.","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the bill to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the bill to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email address.","example":"Abc@example.com"}},"description":"Bill to contact details."},"currency":{"maxLength":3,"type":"string","description":"Subscription currency in 3-letter ISO currency code.","example":"CAD"},"deal_reg_number":{"type":"string","description":"Registration number of the deal registered by partner/reseller.","example":"DELREG-1002-L1"},"po_number":{"type":"string","description":"Purchase order number.","example":"PO-10021-A"},"subscription_metrics":{"type":"object","properties":{"subscription_number":{"type":"string","description":"Subscription number of the subscription.","example":"A4324242"},"tcv":{"type":"number","description":"Total contract value. This is the total amount that has been booked over the duration of the charge.","format":"double","example":120000},"tcb":{"type":"number","description":"Total contracted billing. This is the forecast value at the time of booking for the total amount that will be billed over the duration of the charge.","format":"double","example":120000},"mrr":{"type":"number","description":"Monthly recurring revenue.","format":"double","example":10000},"total_discount_pct":{"type":"number","description":"Total discount applied (in percentage).","format":"percentage","example":10}},"description":"Subscription metrics like total contract value (tcv), monthly recurring revenue (mrr), total contracted billing (tcb)."},"add_offers":{"maxItems":5,"type":"array","description":"Subscription lines for amendment of an existing subscription.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer or plan ID.","example":"OFF-4556"},"offer_name":{"type":"string","description":"Offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU.","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID.","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name.","example":"Zoom Workplace Pro Annual"},"quantity":{"type":"integer","description":"Number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"Charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"Charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"total_discount":{"type":"number","description":"Total discount applied on the charge.","format":"double","example":20},"discounts":{"type":"array","description":"Applicable discounts.","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Supported values are \"DealReg\", \"Partner\", \"Exception\".","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"Specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\".","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE"]},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount is applied.","example":"PRLC-3223"},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\".","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"True if the plan has a usage or overage based charge.","example":true}},"description":"Quote subscription lines."}},"add_add_ons":{"maxItems":5,"type":"array","description":"Subscription lines for amendment of an existing subscription.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer or plan ID.","example":"OFF-4556"},"offer_name":{"type":"string","description":"Offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU.","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID.","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name.","example":"Zoom Workplace Pro Annual"},"quantity":{"type":"integer","description":"number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"Charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"Charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"total_discount":{"type":"number","description":"Total discount applied on the charge.","format":"double","example":20},"discounts":{"type":"array","description":"Applicable discounts.","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Supported values are \"DealReg\", \"Partner\", \"Exception\".","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"Specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\".","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE"]},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount is applied.","example":"PRLC-3223"},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\".","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"True if the plan has a usage or overage based charge.","example":true}},"description":"Quote subscription lines."}},"upgrade_offers":{"maxItems":5,"type":"array","description":"Subscription lines for amendment of an existing subscription.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer or plan ID.","example":"OFF-4556"},"offer_name":{"type":"string","description":"Offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU.","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID.","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name.","example":"Zoom Workplace Pro Annual"},"old_offer_price_list_id":{"type":"string","description":"Old Offer price list ID in case of upgrade or cancel/replace quote.","example":"PRL-3412"},"old_partner_sku_code":{"type":"string","description":"Unique SKU code for partners for old offer price list in case of upgrade or cancel/replace quote.","example":"PAR1-PRO-BASE-NH1Y"},"old_subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"Number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"Charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"Charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"total_discount":{"type":"number","description":"Total discount applied on the charge.","format":"double","example":20},"discounts":{"type":"array","description":"Applicable discounts.","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Supported values are \"DealReg\", \"Partner\", \"Exception\".","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"Specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\".","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE"]},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount is applied.","example":"PRLC-3223"},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\".","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"True if the plan has a usage or overage based charge.","example":true}},"description":"Quote subscription lines."}},"remove_offers":{"maxItems":5,"type":"array","description":"Subscription lines for amendment of an existing subscription.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer or plan ID.","example":"OFF-4556"},"offer_name":{"type":"string","description":"Offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU.","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID.","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name.","example":"Zoom Workplace Pro Annual"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"Number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"Charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"Charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"total_discount":{"type":"number","description":"Total discount applied on the charge.","format":"double","example":20},"discounts":{"type":"array","description":"Applicable discounts.","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. Supported values are \"DealReg\", \"Partner\", \"Exception\".","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"Specifies how the discount will be applied. One time or recurring.","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE"]},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount is applied.","example":"PRLC-3223"},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\".","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"True if the plan has a usage or overage based charge.","example":true},"remove_reason":{"type":"string","description":"The reason for cancellation.","example":"Downsell"}},"description":"Quote subscription lines."}},"update_offers":{"maxItems":5,"type":"array","description":"Subscription lines for amendment of an existing subscription. update terms and quantity of an offer or add-on.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"Offer or plan ID.","example":"OFF-4556"},"offer_name":{"type":"string","description":"Offer or plan name.","example":"Zoom Workplace Pro"},"sku":{"type":"string","description":"Offer SKU.","example":"SKU-10000120"},"offer_price_list_id":{"type":"string","description":"Offer price list ID.","example":"PRL-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"offer_price_list_name":{"type":"string","description":"Offer price list name","example":"Zoom Workplace Pro Annual"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"Number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"Start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"Charge model of this charge.","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"Charge type of this charge.","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"Money value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency.","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount."},"total_discount":{"type":"number","description":"Total discount applied on the charge.","format":"double","example":20},"discounts":{"type":"array","description":"Applicable discounts.","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"Type of discount. supported values are \"DealReg\", \"Partner\", \"Exception\".","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"Discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"Discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"Specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\".","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE"]},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount is applied.","example":"PRLC-3223"},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\".","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"}},"description":"Discount details."}}}}},"usage_based_charge":{"type":"boolean","description":"True if the plan has a usage or overage based charge.","example":true}},"description":"Quote subscription lines."}},"cancel_subscription":{"type":"object","properties":{"cancel_by":{"type":"string","description":"Supported values - \"EndOfCurrentTerm\", \"EndOfLastInvoicePeriod\", \"SpecificDate\".","example":"EndOfCurrentTerm","enum":["EndOfCurrentTerm","EndOfLastInvoicePeriod","SpecificDate"]},"cancel_on":{"type":"string","description":"Must be provided if cancel_by is SpecificDate.","format":"YYYY-MM-DD","example":"2022-10-25"},"cancel_reason":{"maxLength":250,"type":"string","description":"Reason for cancellation.","example":"Customer no longer uses this."}},"description":"Quote cancellation details for a cancel subscription action."},"renew_subscription":{"type":"object","properties":{"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"type of the subcription term. Supported values are TERMED and EVERGREEN. If the subscription is TERMED, then period and period_type fields are also required.","example":"TERMED","enum":["TERMED","EVERGREEN"]},"period_type":{"type":"string","description":"Unit of time that the term is measured in. Only applicable if the value of the term_type field is TERMED. Supported values are \"Month\" or \"Year\".","example":"Month","enum":["Month","Year"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"Start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"},"end_date":{"type":"string","description":"End date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2022-10-25"}},"description":"Subscription initial, renewal or current term."},"discounts":{"maxItems":1,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only one value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge that this discount applies to.","example":"PRLC-3223"},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\".","example":"subscription","enum":["priceplan","subscription","account"]},"discount_program":{"type":"string","description":"Name of the strategic program if its strategic program discount.","example":"VLA program"},"subscription_price_list_id":{"type":"string","description":"Unique identifier for the subscription line where the discount was applied.","example":"SRP1234"}},"description":"Discount details."}}},"description":"docum renewal details for a renew subscription action."},"update_subscription":{"type":"object","properties":{"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of the each term. Only applicable if the initial term type is TERMED. If `auto_renew` is `true`, providing `renewal_term` is required.","example":true},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The subscription term's type. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The term duration, in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The term's start date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The term's end date, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's renewal term. Required for paid subscriptions where `order_type` = `sale`."},"sold_to_crm_contact_number":{"type":"string","description":"CRM contact number for the sold to contact.","example":"C-232442"},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if `requires_professional_services` is set to `Yes, Zoom will do the deployment`.","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if `is_zoom_pso_org_engaged` is set to `Yes and I have a PSO Engagement Request ID`.","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment."},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if `requires_professional_services` is `true`.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Update subscription attributes."},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this subscription.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}}},"description":"Quote subscription details for an amendment."}},"errors":{"type":"array","description":"Array of messages in case of validation or processing errors.","items":{"type":"object","properties":{"error_code":{"type":"string","description":"Error code.","example":"5012"},"error_description":{"type":"string","description":"Error description.","example":"Invalid Partner or Reseller Identifier supplied."}},"description":"Error details."}},"warnings":{"type":"array","description":"Array of messages in case of validation or processing warnings","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"Error code.","example":"5604"},"error_description":{"type":"string","description":"Error description.","example":"No pricebook exists with given `offer_price_list_id`."}},"description":"Error code and message"}}},"description":"Quote details."}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5009` <br>\n No records found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition that prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:quote:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:quote:admin"]}},"patch":{"tags":["Quote"],"summary":"Update a subscription quote for a Zoom Partner","description":"Update a subscription quote for a Zoom partner's end customers. Approved quotes cannot be updated.<br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:quote:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"updateQuote","parameters":[{"name":"quoteReferenceId","in":"path","description":"The quote's unique reference ID.","required":true,"schema":{"type":"string","example":"Q-57384"}}],"requestBody":{"description":"Update a quote for a Zoom partner.","content":{"application/json":{"schema":{"required":["header"],"type":"object","properties":{"header":{"required":["quote_date"],"type":"object","properties":{"quote_description":{"maxLength":500,"type":"string","description":"A description of the quote.","example":"New ZCC subscription for ABC Pvt. Ltd."},"quote_date":{"type":"string","description":"The quote date in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"quote_expiry_date":{"type":"string","description":"The date when the quote will expire. If not provided, the quote will expire in 30 days from the date of creation. Maximum allowed expiry date is 180 days.","format":"YYYY-MM-DD","example":"2023-11-02"},"negotiation_note":{"maxLength":1000,"type":"string","description":"A note for negotiation deal for the quote.","example":"Quote updated as per approval comment."},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this quote.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}}},"description":"The quote header's details."},"create_subscriptions":{"maxItems":1,"type":"array","description":"The quote details for creating a new subscription.","items":{"type":"object","properties":{"initial_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"}},"description":"The subscription's initial, renewal, or current term."},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, 60.","example":12,"enum":[12,24,26,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's initial, renewal, or current term."},"service_start_date":{"type":"string","description":"The service start date. It should be equal to or before `paid_period_start_date`.","format":"YYYY-MM-DD","example":"2024-03-20"},"paid_period_start_date":{"type":"string","description":"The subscription paid period start date. Required if the subscription has a free period.","format":"YYYY-MM-DD","example":"2024-03-20"},"free_months_reason_code":{"type":"string","description":"The reason for requesting free period in the subscription. Required if the subscription has a free period.","example":"Customer's Desired Billing/Start Date","enum":["Customer's Desired Billing/Start Date","Billing at Later Date for Other Reason","Align to Customer's Renewal Date"]},"currency":{"maxLength":3,"type":"string","description":"Subscription currency in a three-letter ISO currency code.","example":"CAD"},"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of each term. Defaults to true. Only applicable for \"createSubscription\" quote action if the initial term type is TERMED.","example":true,"default":true},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"add_offers":{"maxItems":10,"type":"array","description":"New offers to be added to a subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription's end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Recording storage capacity in GB"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer attribute's details."}},"discounts":{"maxItems":30,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"The subscription plan details."}},"add_add_ons":{"maxItems":10,"type":"array","description":"The new add-ons to be added to a subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription's end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":30,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"The subscription plan details."}},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this subscription.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if 'requires_professional_services' is set to 'Yes, Zoom will do the deployment.'","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if 'is_zoom_pso_org_engaged' is set to 'Yes and I have a PSO Engagement Request ID.'","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details. Required with 'deployment_partner_name'."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment.'"},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if \"requires_professional_services\" is true.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Creates a new subscription quote."}},"amend_subscriptions":{"maxItems":1,"type":"array","description":"The quote details for amending an existing subscription.","items":{"type":"object","properties":{"add_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be added in the subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"The subscription plan details."}},"add_add_ons":{"maxItems":5,"type":"array","description":"The offer details for add-ons to be added in the subscription.","items":{"required":["offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer's price list ID.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"The subscription plan details."}},"upgrade_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be upgraded in the subscription.","items":{"required":["start_date"],"type":"object","properties":{"new_offer_price_list_id":{"type":"string","description":"The new offer price list ID.","example":"Off-2323"},"new_partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-ENT-BASE-NH1Y"},"old_offer_price_list_id":{"type":"string","description":"The existing offer price list ID.","example":"Off-2564"},"old_partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"old_subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The change start date. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer's specific attributes, such as the number of hosts, participant capacity, and so on.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"The offer's attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"Cancels and replaces the subscription plan amendment."}},"remove_offers":{"maxItems":5,"type":"array","description":"The offer details for offers to be removed from the subscription.","items":{"required":["end_date","offer_price_list_id"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"The offer price list ID for the offer to be removed from the subscription.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"The unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"end_date":{"type":"string","description":"The date when the offer will be removed. It should be between today and the subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"remove_reason":{"type":"string","description":"The reason for cancellation.","example":"Downsell"}},"description":"Remove subscription plan."}},"update_offers":{"maxItems":5,"type":"array","description":"Update terms and quantity of an offer or add-on.","items":{"required":["offer_price_list_id","start_date"],"type":"object","properties":{"offer_price_list_id":{"type":"string","description":"Offer price list ID for the offer to be updated.","example":"Off-2323"},"partner_sku_code":{"type":"string","description":"Unique SKU code for partners.","example":"PAR1-PRO-BASE-NH1Y"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"The number of licenses. Should be between minimum and maximum allowed for the plan.","example":100},"start_date":{"type":"string","description":"The change start date. Should be between today and subscription end date.","format":"YYYY-MM-DD","example":"2023-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"Offer's specific attributes such as the number of hosts and participant capacity.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Min licenses for purchase"},"value":{"type":"string","description":"The attribute's value.","example":"10"}},"description":"Offer attribute details."}},"discounts":{"maxItems":15,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"The discount details."}}},"description":"Subscription update details."}},"cancel_subscription":{"required":["cancel_by","cancel_reason"],"type":"object","properties":{"cancel_by":{"type":"string","description":"When the subscription will be cancelled. Required for paid subscriptions. Currently only 'EndOfCurrentTerm' is supported.","example":"EndOfCurrentTerm","enum":["EndOfCurrentTerm","EndOfLastInvoicePeriod","SpecificDate"]},"cancel_on":{"type":"string","description":"Must be provided if cancel_by is SpecificDate.","format":"YYYY-MM-DD","example":"2023-10-03"},"cancel_reason":{"maxLength":250,"type":"string","description":"The reason for cancellation.","example":"Downsell"}},"description":"The cancellation details."},"renew_subscription":{"type":"object","properties":{"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"Start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"End date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"Subscription initial, renewal or current term."},"discounts":{"maxItems":30,"type":"array","description":"Additional discounts requested for this offer.","items":{"required":["apply_to_charge","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"The type of discount. Currently only 1 value supported.","example":"Exception","enum":["Exception"]},"percent_value":{"type":"number","description":"The discount in percentage. Either percent_value or amount_value is required but both should not be provided.","format":"percent","example":0.1},"amount_value":{"type":"number","description":"The discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to_charge":{"type":"string","description":"The charge ID for the charge to which this discount will be applied.","example":"PRLC-3223"}},"description":"Discount details."}}},"description":"The renewal details."},"update_subscription":{"type":"object","properties":{"sold_to_crm_contact_number":{"type":"string","description":"CRM contact number for the sold to contact.","example":"C-232442"},"auto_renew":{"type":"boolean","description":"Whether the subscription automatically renews at the end of each term. Only applicable if the initial term type is TERMED. If auto_renew is true, providing renewal_term is required.","example":true},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subscription term. If the subscription is TERMED, then 'term_period' field is also required.","example":"TERMED","enum":["TERMED"]},"term_period":{"type":"integer","description":"The duration of the term in months. Only applicable if the value of the `term_type` field is TERMED. Allowed values are 12, 24, 36, 48, or 60.","example":12,"enum":[12,24,36,48,60]},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-03-20"}},"description":"The subscription's renewal term. Required for paid subscriptions (order_type = sale)."},"end_customer_language":{"type":"string","description":"The language to be used to set communication and invoice profile for the end customer.","example":"es-ES;","enum":["es-ES;","de-DE;","fr-FR;","ja-JP;","en-US;"]},"professional_services":{"required":["requires_professional_services"],"type":"object","properties":{"requires_professional_services":{"type":"string","description":"Set professional services requirements for this subscription. Required if subscription contains ZCX offer.","example":"Yes, Zoom will do the deployment","enum":["Yes, my organization will do the deployment","Yes, Zoom will do the deployment","Yes, a different organization will do the deployment","No, the platform is already deployed","No, the customer doesn't want deployment","No, other reason"]},"is_zoom_pso_org_engaged":{"type":"string","description":"Required if 'requires_professional_services' is set to 'Yes, Zoom will do the deployment.'","example":"Yes and I have a PSO Engagement Request ID","enum":["Yes and I have a PSO Engagement Request ID","Yes, but I need an Engagement Request to be created","No, I need to start now"]},"pso_engagement_request_id":{"type":"string","description":"Required if 'is_zoom_pso_org_engaged' is set to 'Yes and I have a PSO Engagement Request ID.'","example":"SRE-351262"},"deployment_partner":{"type":"object","properties":{"deployment_partner_name":{"type":"string","description":"The deployment partner's name. Required if 'deployment_partner_crm_account_number' is blank.","example":"ABC LLC"},"deployment_partner_crm_account_number":{"type":"string","description":"Deployment partner CRM number. Required if 'deployment_partner_name' is blank.","example":"A-1234241"},"deployment_partner_address":{"required":["city","country","line_1","postal_code","state"],"type":"object","properties":{"line_1":{"maxLength":255,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code number.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details. Required with 'deployment_partner_name'."}},"description":"Required if 'requires_professional_services' is set to 'Yes, a different organization will do the deployment.'"},"professional_services_description":{"type":"string","description":"A description of the partner-led professional or managed services should be provided if \"requires_professional_services\" is true.","example":"false"}},"description":"Set professional services requirements. Required for Zoom Contact Center (ZCX) deals."}},"description":"Update subscription attributes."},"additional_attributes":{"maxItems":10,"type":"array","description":"Any additional attributes that need to be tracked for this subscription.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute's name.","example":"Tracking number"},"value_type":{"type":"string","description":"The attribute value type. Supported data types - Integer, Enum, String, Boolean, Object.","example":"Boolean","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"TR28483"}},"description":"The attribute details."}}},"description":"Amend quote request details."}}},"description":"Quote request details."}}}},"responses":{"200":{"description":"Quote updated successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBkjgriertgu5986459ti4"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status of the quote.","example":"submitted","enum":["failedToSubmit","submitted"]},"quote_reference_id":{"type":"string","description":"Reference ID for a quote.","example":"QO-3248714941"},"quote_date":{"type":"string","description":"The date when the quote should be placed in the billing system.","format":"YYYY-MM-DD","example":"2023-10-03"},"errors":{"maxItems":20,"type":"array","description":"Array of messages in case of validation errors.","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"Error code.","example":"5604"},"error_description":{"type":"string","description":"Error description.","example":"No pricebook exists with given offer_price_list_id."}},"description":"Error code and message."}},"warnings":{"maxItems":20,"type":"array","description":"Array of messages in case of validation or processing warnings.","items":{"required":["error_code","error_description"],"type":"object","properties":{"error_code":{"type":"string","description":"Error code.","example":"5604"},"error_description":{"type":"string","description":"Error description.","example":"No pricebook exists with given offer_price_list_id."}},"description":"Error code and message."}}},"description":"The quote details."}}}},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n **Error Code:** `6103` <br>\n Unable to update quote. Please try again later. <br>\n"}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:write:quote:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:write:quote:admin"]}}},"/commerce/quotes/{quoteReferenceId}/fulfillment":{"patch":{"tags":["Quote"],"summary":"Submits a subscription quote for provisioning","description":"Submits a subscription quote for provisioning. Only approved quotes can be submitted for fulfillment. <br><b>Note:</b> Check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:write:quote:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"provisionQuote","parameters":[{"name":"quoteReferenceId","in":"path","description":"Unique reference ID for the quote.","required":true,"schema":{"type":"string","example":"QU-57384"}}],"requestBody":{"description":"This setting submits a quote for a Zoom partner.","content":{"application/json":{"schema":{"required":["documents","po_number"],"type":"object","properties":{"po_number":{"type":"string","description":"The purchase order number.","example":"PO-10021-A"},"comments":{"maxLength":1000,"type":"string","description":"Additional comments or notes to be added to the quote negotiation notes before provisioning.","example":"Submmitting for fulfillment after exception approval."},"documents":{"maxItems":10,"type":"array","description":"Array of document or attachment ids uploaded for the quote.","items":{"type":"object","properties":{"document_reference_id":{"type":"string","description":"Unique document number.","example":"D-1212"},"document_type":{"type":"string","description":"Type of document.","example":"Purchase Order","enum":["Purchase Order","Customer Acceptance","Other"]}}}}}}}}},"responses":{"204":{"description":"Quote successfully submitted for fulfillment.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string"}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `6200` <br>\n Purchase order number is required. <br>\n**Error Code:** `6201` <br>\n Document numbers exceed acceptable limit. <br>\n**Error Code:** `6202` <br>\n Purchase Order document is required <br>\n**Error Code:** `6203` <br>\n Customer acceptance document is required <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n **Error Code:** `6220` <br>\n Unable to submit quote for fulfillment. Please try again later. <br>\n"}},"security":[{"openapi_oauth":["zoom_commerce:write:admin","zoom_commerce:write:quote:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:write:admin"],"x-granular-scopes":["zoom_commerce:write:quote:admin"]}}},"/commerce/subscriptions":{"get":{"tags":["Subscription"],"summary":"Gets paid subscriptions for a Zoom partner.","description":"Returns paid subscriptions for a distributor or a reseller. The subscriptions list can be filtered by end customer account number, subscription status, subscription number, start and end dates. By default, the list of active subscriptions in the last month is retrieved. <br><b>Note:</b> Please check the base URL for sandbox and production environments under the Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:subscription:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"getAllSubscriptions","parameters":[{"name":"page_size","in":"query","description":"The maximum number of results returned in a page. The minimum value is 1 and the maximum is 99. The default is 10.","required":false,"schema":{"maximum":99,"minimum":1,"type":"integer","example":20}},{"name":"sort","in":"query","description":"This field specifies the sort order of the list. Sorting can be ascending or descending. The fields on which this list can be sorted: `subscriptionNumber`, `startDate`, `endDate`. By default, the list is sorted by the most recent subscription.","required":false,"schema":{"type":"string","example":"subscriptionNumber.asc","enum":["subscriptionNumber.asc","subscriptionNumber.desc","startDate.asc","endDate.asc","startDate.desc","endDate.desc"]}},{"name":"status","in":"query","description":"This field filters the list of subscriptions by status. By default, all active subscriptions are returned. Accepted values are: active, pending_activation, cancelled, expired.","required":false,"schema":{"type":"string","example":"active","enum":["active","pending_activation","cancelled","expired"]}},{"name":"start","in":"query","description":"This field filters the list of subscriptions by subscription start date on or after the date provided in YYYY-MM-DD format.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2023-07-01"}},{"name":"end","in":"query","description":"This field filters the list of subscriptions by subscription end date on or before the date provided in YYYY-MM-DD format.","required":false,"schema":{"type":"string","format":"YYYY-MM-DD","example":"2023-07-01"}},{"name":"duration","in":"query","description":"This field filters the list of subscriptions by duration. By default, subscriptions for the last month are retrieved. Accepted values are: lastMonth, last90Days, last1Year, custom. Either start/end dates or the duration should be provided.","required":false,"schema":{"type":"string","example":"lastMonth","enum":["lastMonth","last90Days","last1Year","custom"]}},{"name":"end_customer_name","in":"query","description":"This field filters results based on end customer name. It should be a minimum of three characters. Characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"John"}},{"name":"end_customer_crm_account_number","in":"query","description":"This field filters results based on end customer CRM account number. It should be a minimum of three characters.","required":false,"schema":{"type":"string","example":"A-3454334"}},{"name":"end_customer_zoom_account_number","in":"query","description":"This field filters results based on end customer Zoom account number. It should be a minimum of three characters.","required":false,"schema":{"maxLength":10,"minLength":3,"type":"string","example":"4435343789"}},{"name":"sub_reseller_name","in":"query","description":"This field filters results based on sub-reseller name. It should be a minimum of three characters. Characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"John"}},{"name":"sub_reseller_crm_account_number","in":"query","description":"This field filters results based on sub-reseller CRM account number. It should be a minimum of three characters.","required":false,"schema":{"type":"string","example":"A-348742"}},{"name":"subscription_number","in":"query","description":"This field filters the list of subscriptions by subscription number.","required":false,"schema":{"type":"string","example":"SM-12435"}},{"name":"invoice_owner_crm_account_number","in":"query","description":"This field filters subscriptions by the CRM account number for the invoice owner.","required":false,"schema":{"type":"string","example":"A-3454374"}},{"name":"next_page_token","in":"query","description":"The token for the next page in the record set if the result has more records than the number specified by the page size. The next page token paginates through large result sets. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.","required":false,"schema":{"type":"string","example":"3e327e223"}}],"responses":{"200":{"description":"Subscriptions retrieved successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"next_page_token":{"type":"string","description":"The next page token.","example":"nfirhf84574fkse"},"subscription_list":{"maxItems":99,"type":"array","description":"The list of subscriptions.","items":{"type":"object","properties":{"subscription_number":{"type":"string","description":"The subscription number.","example":"A-31231322"},"subscription_status":{"type":"string","description":"The status of the subscription.","example":"active","enum":["active","pending_activation","pending_acceptance","cancelled","suspended","expired"]},"subscription_owner":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The unique CRM account number.","example":"A0012"},"account_name":{"type":"string","description":"The account's name.","example":"John Galt"},"zoom_account_number":{"maxLength":10,"type":"string","description":"The Zoom account number (ZAN).","example":"3842618277"}},"description":"The account identifiers and the name."},"invoice_owner":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The unique CRM account number.","example":"A0012"},"account_name":{"type":"string","description":"The account's name.","example":"John Galt"},"zoom_account_number":{"maxLength":10,"type":"string","description":"The Zoom account number (ZAN).","example":"3842618277"}},"description":"The account identifiers and the name."},"start_date":{"type":"string","description":"The date when the subscription starts.","format":"YYYY-MM-DD","example":"2023-07-01"},"end_date":{"type":"string","description":"The date when the subscription ends.","format":"YYYY-MM-DD","example":"2024-07-01"},"order_number":{"type":"string","description":"The associated order number, if any.","example":"O-132323"},"sub_reseller_name":{"type":"string","description":"The sub-reseller's name.","example":"ABC Inc."},"sold_to_email":{"type":"string","description":"The email address of the sold-to contact.","example":"abc@test.com"},"mrr":{"type":"object","properties":{"gross_amount":{"type":"number","description":"The gross amount.","format":"double","example":120000},"net_amount":{"type":"number","description":"The net amount.","format":"double","example":120000},"currency":{"maxLength":3,"type":"string","description":"The ISO currency code.","example":"USD"}},"description":"The monthly recurring revenue (MRR) details."},"auto_renew":{"type":"boolean","description":"If true, the subscription automatically renews at the end of the current term.","example":true},"trade_screening":{"type":"boolean","description":"Whether the subscription cleared the trade screening check.","example":false}},"description":"The subscription details."}}},"description":"The subscription details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5313` <br>\n Invalid sort value. It must be one of: subscriptionNumber.asc, subscriptionNumber.desc, startDate.asc, endDate.asc, startDate.desc, or endDate.desc. <br>\n**Error Code:** `5320` <br>\n Invalid status value. It must be one of: active, pending_activation, cancelled, or expired. <br>\n**Error Code:** `5002` <br>\n Invalid date format. Expected format: YYYY-MM-DD. <br>\n**Error Code:** `5003` <br>\n Invalid duration. It must be one of: lastMonth, last90Days, last1Year, or custom. <br>\n**Error Code:** `5000` <br>\n Invalid character & or | in the name filter. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:subscription:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:subscription:admin"]}}},"/commerce/subscriptions/{subscriptionNumber}":{"get":{"tags":["Subscription"],"summary":"Gets subscription details for a given subscription number","description":"Returns the subscription details for a given subscription number. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:subscription:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`\n\n**Not supported in Gov cluster** ","operationId":"getSubscriptionDetails","parameters":[{"name":"subscriptionNumber","in":"path","description":"The subscription number.","required":true,"schema":{"type":"string","example":"SM-0001"}}],"responses":{"200":{"description":"The subscription retrieved successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBhgfdgu8956945tjoi"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"subscription_number":{"type":"string","description":"The subscription number.","example":"A-31231322"},"status":{"type":"string","description":"The status of the subscription. ","example":"active","enum":["draft","pending_activation","pending_acceptance","active","expired","cancelled","paused"]},"payment_term":{"type":"string","description":"The payment term for this subscription. Supported values: Due upon Receipt, Net30, Net45, and Net60. If null, it defaults to the payment term associated with the account.","example":"Net30","enum":["Due upon Receipt","Net30","Net45","Net60"]},"service_start_date":{"type":"string","description":"The service start date. Equal to or before the start date of the paid period.","format":"YYYY-MM-DD","example":"2023-10-03"},"paid_period_start_date":{"type":"string","description":"The subscription paid period start date.","format":"YYYY-MM-DD","example":"2023-10-03"},"free_months_included":{"type":"boolean","description":"True if the order created a free period subscription.","example":false,"default":false},"free_months_reason_code":{"type":"string","description":"The reason for free period in the subscription. Required if the subscription has free period.","example":"Standard Free Months","default":"Standard Free Months","enum":["Standard Free Months","Sales Promotion","Customer's Desired Billing/Start Date","Billing at later date for Other Reason","Align to Customer's Renewal Date","Competitor Buyout","None"]},"deal_reg_number":{"type":"string","description":"The registration number of the deal registered by partner or reseller.","example":"DELREG-1002-L1"},"po_number":{"type":"string","description":"The purchase order number.","example":"PO-10021-A"},"currency":{"maxLength":3,"type":"string","description":"The subscription currency in the 3-letter ISO currency code.","example":"CAD"},"end_customer_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number for the customer or partner or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"The unique CRM account number for the customer or partner or reseller.","example":"A-12323"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The type of address: billTo, shipTo, or soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country","example":"US"}},"description":"The address details."}},"description":"The account details."},"invoice_owner_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number for the customer or partner or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"The unique CRM account number for the customer or partner or reseller.","example":"A-12323"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The type of address: billTo, shipTo, or soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details."}},"description":"The account details."},"sub_reseller":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number for the customer or partner or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"The sub-reseller CRM account number.","example":"A-45r33"},"account_name":{"type":"string","description":"The sub-reseller name.","example":"Novam Corp."},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The type of address: billTo, shipTo, or soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details."}},"description":"The sub-reseller account number."},"agreement_dates":{"type":"object","properties":{"contract_effective_date":{"type":"string","description":"The date when the contract will be effective from. It is a required field to provide in the order when order action type is \"createSubscription\", in YYYY-MM-DD format and if order_date is different from contract effective date.","format":"YYYY-MM-DD","example":"2023-10-03"},"service_activation_date":{"type":"string","description":"The date when the service will be activated, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"customer_acceptance_date":{"type":"string","description":"The date when the order was approved by the customer. It is a required field to provide in the order when order action type is \"addOffer\", \"createSubscription\", \"addOn\", \"upgrade\", \"upsell\", \"renewSubscription\", in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"}},"description":"The subscription agreement dates."},"initial_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subcription term. Supported values are TERMED and EVERGREEN. If the subscription is TERMED, then period and period_type fields are also required.","example":"TERMED","enum":["TERMED","EVERGREEN"]},"period_type":{"type":"string","description":"The unit of time that the term is measured. Only applicable if the value of the term_type field is TERMED. Supported values are \"Month\" or \"Year\"","example":"Month","enum":["Month","Year"]},"term_period":{"type":"integer","description":"The duration of the term in months, years, depending on the value of the period_type field. Only applicable if the value of the term_type field is TERMED.","example":12},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-10-03"}},"description":"The subscription's initial renewal or current term."},"renewal_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subcription term. Supported values are TERMED and EVERGREEN. If the subscription is TERMED, then period and period_type fields are also required.","example":"TERMED","enum":["TERMED","EVERGREEN"]},"period_type":{"type":"string","description":"The unit of time that the term is measured. Only applicable if the value of the term_type field is TERMED. Supported values are \"Month\" or \"Year\"","example":"Month","enum":["Month","Year"]},"term_period":{"type":"integer","description":"The duration of the term in months, years, depending on the value of the `period_type` field. Only applicable if the value of the `term_type` field is TERMED.","example":12},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-10-03"}},"description":"The subscription's initial renewal or current term."},"current_term":{"required":["term_type"],"type":"object","properties":{"term_type":{"type":"string","description":"The type of the subcription term. Supported values are TERMED and EVERGREEN. If the subscription is TERMED, then period and `period_type` fields are also required.","example":"TERMED","enum":["TERMED","EVERGREEN"]},"period_type":{"type":"string","description":"The unit of time that the term is measured. Only applicable if the value of the term_type field is TERMED. Supported values are \"Month\" or \"Year\"","example":"Month","enum":["Month","Year"]},"term_period":{"type":"integer","description":"The duration of the term in months, years, depending on the value of the period_type field. Only applicable if the value of the term_type field is TERMED.","example":12},"start_date":{"type":"string","description":"The start date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the term, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-10-03"}},"description":"The subscription's initial renewal or current term."},"auto_renew":{"type":"boolean","description":"If true, the subscription automatically renews at the end of the current term.","example":true},"start_date":{"type":"string","description":"The start date of the subscription, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the subscription, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-10-03"},"invoice_separately":{"type":"boolean","description":"If true, the subscription is billed separately from other subscriptions. If false, the subscription is included with other subscriptions in the account invoice.","example":true},"contracted_mrr":{"type":"number","description":"The monthly recurring revenue of the subscription.","example":1000},"mrr":{"type":"object","properties":{"amount":{"type":"number","description":"The monetary value.","example":99.99},"currency":{"maxLength":3,"type":"string","description":"The ISO code for the currency.","example":"USD"}},"description":"This field represents the sale price, list price, net amount, or gross amount."},"bill_to":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number for the customer or partner or reseller","example":"3421746588"},"crm_account_number":{"type":"string","description":"The unique CRM account number for the customer or partner or reseller","example":"A-12323"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["city","country","line_1","state"],"type":"object","properties":{"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.r","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The details of the address."}},"description":"The details of the account."},"sold_to":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number for the customer or partner or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"The unique CRM account number for the customer or partner or reseller.","example":"A-12323"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["city","country","line_1","state"],"type":"object","properties":{"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The details of the address."}},"description":"The details of the account."},"sold_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"Unique CRM Number for the contact","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the sold to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the sold to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email id.","example":"abc@test.com"}},"description":"Sold to contact details"},"bill_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"Unique CRM Number for the contact.","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the bill to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the bill to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email id.","example":"abc@test.com"}},"description":"Bill to contact details"},"subscription_lines":{"maxItems":50,"type":"array","description":"The subscription lines or items.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"The offer or plan ID.","example":"PR-2323"},"offer_name":{"type":"string","description":"The offer or plan name.","example":"Zoom Workplace Pro"},"offer_type":{"type":"string","description":"The type of offering.","example":"plan","enum":["plan","standalone","configurable","isv","addon"]},"sku":{"type":"string","description":"The offer SKU.","example":"SKU-00000118"},"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"PRL-2323"},"offer_price_list_name":{"type":"string","description":"The offer price list name.","example":"Zoom Workplace Pro Annual"},"subscription_price_list_id":{"type":"string","description":"The unique ID for a pricelist in the subscription. Required if there are more than 1 lines in the subscription for this pricelist.","example":"fvnderfy89rui43jr23ej23"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-10-03"},"status":{"type":"string","description":"The status of the subscription line. ","example":"active","enum":["draft","pending_activation","pending_acceptance","active","expired","cancelled","paused","removed"]},"charges":{"maxItems":5,"type":"array","description":"All charges applied on the offer.","items":{"type":"object","properties":{"charge_model":{"type":"string","description":"charge model of this charge","example":"Volume Pricing","enum":["Flat Fee Pricing","Per Unit Pricing","Overage Pricing","Volume Pricing","Tiered Pricing"]},"charge_type":{"type":"string","description":"charge type of this charge","example":"OneTime","enum":["OneTime","Recurring","Usage"]},"charge_id":{"type":"string","description":"The charge ID for the charge.","example":"PRLC-3223"},"is_channel_discount_applicable":{"type":"boolean","description":"Whether the `z_product_class` for the offer price list is 1, 2, or 3 and the class discount applies to this charge.","example":true},"partner_sku_code":{"type":"string","description":"Unique SKU code for the charge.","example":"PAR1-ENT-BASE-NH1Y"},"sale_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_price":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"net_amount":{"type":"object","properties":{"amount":{"type":"number","description":"money value","example":99.99},"currency":{"maxLength":3,"type":"string","description":"ISO code for the currency","example":"USD"}},"description":"Represents sale price, list price, net amount or gross amount"},"discounts":{"maxItems":5,"type":"array","description":"Applicable discounts","items":{"required":["apply_to","discount_level","discount_type"],"type":"object","properties":{"discount_type":{"type":"string","description":"type of discount. supported values are \"DealReg\", \"Partner\", \"Exception\"","example":"DealReg","enum":["DealReg","Partner Standard","Exception"]},"percent_value":{"type":"number","description":"discount in percentage. Either percent_value or amount_value is required but both should not be provided","format":"percent","example":0.1},"amount_value":{"type":"number","description":"discount in amount. Either percent_value or amount_value is required.","format":"double","example":10},"apply_to":{"type":"string","description":"specifies how the discount will be applied. One time or recurring. Supported values are \"ONETIME\", \"RECURRING\", \"USAGE\", \"ONETIMERECURRING\", \"ONETIMEUSAGE\", \"RECURRINGUSAGE\" and \"ONETIMERECURRINGUSAGE\"","example":"RECURRING","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"]},"discount_level":{"type":"string","description":"Application scope of the discount. For example, if the value of this field is subscription and the value of the apply_to field is RECURRING, the discount applies to all recurring charges in the same subscription. Supported values are \"priceplan\" \"subscription\" \"account\"","example":"subscription","enum":["priceplan","subscription","account"]}},"description":"Discount details."}}}}},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer attributes.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name.","example":"Min licenses for purchase"},"uom":{"type":"string","description":"The unit of measure.","example":"count"},"value_type":{"type":"string","description":"The attribute value type. Supported data types: Integer, Enum, String, Boolean, or Object.","example":"Integer","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"10"}},"description":"The details of the offer attribute."}}},"description":"The subscription line or item details."}},"created_date":{"type":"string","description":"The creation date in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-10-03"},"updated_date":{"type":"string","description":"The updated date in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-10-03"}},"description":"The subscription's details."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5302` <br>\n Invalid subscription number. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Unauthorized access. Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5009` <br>\n No records found <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:subscription:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:subscription:admin"]}}},"/commerce/subscriptions/{subscriptionNumber}/versions":{"get":{"tags":["Subscription"],"summary":"Gets subscription changes/versions for a given subscription number.","description":"Returns the subscription changes or versions for a given subscription number. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section here - https://developers.zoom.us/docs/api\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:subscription:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`\n\n**Not supported in Gov cluster** ","operationId":"getSubscriptionVersions","parameters":[{"name":"subscriptionNumber","in":"path","description":"The subscription number.","required":true,"schema":{"type":"string","example":"SM-0001"}}],"responses":{"200":{"description":"Subscription changes/versions retrieved successfully. ","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBfhgirdgu95r8t955t"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"subscription_number":{"type":"string","description":"The subscription number of the subscription.","example":"A-31231322"},"status":{"type":"string","description":"This field indicates expired or active status.","example":"active","enum":["active","expired"]},"start_date":{"type":"string","description":"The subscription's start date.","format":"YYYY-MM-DD","example":"2023-01-07"},"end_date":{"type":"string","description":"The subscription's end date.","format":"YYYY-MM-DD","example":"2024-07-02"},"subscription_versions":{"maxItems":25,"type":"array","description":"The subscription updates.","items":{"type":"object","properties":{"sequence":{"type":"integer","description":"The action order.","example":1},"version":{"type":"integer","description":"The version ID.","example":1},"latest_version":{"type":"boolean","description":"Whether this version is the latest version or not.","example":true},"action":{"maxItems":10,"type":"array","description":"List of actions applied to the subscription in this version.","items":{"type":"string","description":"Action type: create, upsell, and downsell.","example":"create","enum":["create_subscription","terms","add_subscription_plan","update_subscription_plan","remove_subscription_plan","renew","cancel","owner_transfer","pause","resume","replace_subscription_plan"]}},"start_date":{"type":"string","description":"The subscription start date.","format":"YYYY-MM-DD","example":"2023-01-07"},"end_date":{"type":"string","description":"The subscription end date.","format":"YYYY-MM-DD","example":"2024-08-01"},"mrr":{"type":"number","description":"The MRR value for this version.","example":1000},"currency":{"maxLength":3,"type":"string","description":"The ISO code for MRR currency.","example":"USD"}},"description":"The subscription's updates."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n **Error Code:** `5302` <br>\n Invalid subscription number. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5009` <br>\n No records found <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:subscription:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:subscription:admin"]}}},"/commerce/trials":{"get":{"tags":["Subscription"],"summary":"Get trial subscriptions for a Zoom partner","description":"Returns trial subscriptions for a distributor or reseller. The subscriptions list can be filtered by end customer account number, subscription status, subscription number, and start and end dates. By default, the list of active subscriptions in the last month is retrieved. <br><b>Note:</b> Please check the base URL for sandbox and production environments under the Zoom Commerce section [here](https://developers.zoom.us/docs/api).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:subscription:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"getAllTrialSubscriptions","parameters":[{"name":"page_size","in":"query","description":"The maximum number of results returned per page. The minimum value is 1 and the maximum is 99. The default is 10.","required":false,"schema":{"maximum":99,"minimum":1,"type":"integer","example":20}},{"name":"end_customer_name","in":"query","description":"Filters results based on the end customer name. This must be a minimum of three characters. The characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"John"}},{"name":"end_customer_crm_account_number","in":"query","description":"Filters results based on the end customer CRM account number. This must be a minimum of three characters.","required":false,"schema":{"type":"string","example":"A-3454334"}},{"name":"end_customer_zoom_account_number","in":"query","description":"Filters results based on the end customer Zoom account number. This must be a minimum of three characters.","required":false,"schema":{"maxLength":10,"minLength":3,"type":"string","example":"4435343789"}},{"name":"sub_reseller_name","in":"query","description":"Filters results based on the sub-reseller name. This must be a minimum of three characters. The characters & and | are not allowed in this filter.","required":false,"schema":{"type":"string","example":"John"}},{"name":"sub_reseller_crm_account_number","in":"query","description":"Filters results based on the sub-reseller CRM account number. This must be a minimum of three characters.","required":false,"schema":{"type":"string","example":"A-348742"}},{"name":"invoice_owner_crm_account_number","in":"query","description":"Filters subscriptions by the CRM account number for the invoice owner.","required":false,"schema":{"type":"string","example":"A-3454374"}},{"name":"trial_id","in":"query","description":"Filters subscriptions by the trial identifier.","required":false,"schema":{"type":"string","example":"Z-021462495"}},{"name":"page_number","in":"query","description":"The page number to fetch the next page of the result set.","required":false,"schema":{"type":"integer","example":2}}],"responses":{"200":{"description":"Trials retrieved successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom-specific identifier for tracing the API call.","schema":{"type":"string","example":"WEB32y8478dshfidfy83r"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"page_count":{"type":"integer","description":"The total number of pages in the result set.","example":20},"trial_list":{"maxItems":99,"type":"array","description":"The list of trials.","items":{"type":"object","properties":{"trial_id":{"type":"string","description":"The trial subscription's unique identifier.","example":"Z-021462495"},"subscription_owner":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The unique CRM account number.","example":"A0012"},"account_name":{"type":"string","description":"The account name.","example":"John Galt"},"zoom_account_number":{"maxLength":10,"type":"string","description":"The Zoom account number (ZAN).","example":"3842618277"}},"description":"The account identifiers and name."},"invoice_owner":{"type":"object","properties":{"crm_account_number":{"type":"string","description":"The unique CRM account number.","example":"A0012"},"account_name":{"type":"string","description":"The account name.","example":"John Galt"},"zoom_account_number":{"maxLength":10,"type":"string","description":"The Zoom account number (ZAN).","example":"3842618277"}},"description":"The account identifiers and name."},"sub_reseller_name":{"type":"string","description":"The sub-reseller's name.","example":"ABC Inc."}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See Details \n\n **Error Code:** `5000` <br>\n Invalid character & or | in the name filter. <br>\n"},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Authorization information is missing or invalid. \n\n "},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:subscription:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:subscription:admin"]}}},"/commerce/trials/{trialReferenceId}":{"get":{"tags":["Subscription"],"summary":"Get trial details for an end customer by their Zoom account number or the trial ID","description":"Returns the trial details for an end customer. <br><b>Note:</b> Please check the base URL for sandbox and production environments under Zoom Commerce section [here](https://developers.zoom.us/docs/api/).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `zoom_commerce:read:subscription:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"getTrialDetails","parameters":[{"name":"trialReferenceId","in":"path","description":"Zoom account number of the end customer or the trial ID .","required":true,"schema":{"type":"string","example":"2313283333"}}],"responses":{"200":{"description":"Trial details retrieved successfully.","headers":{"x-zm-trackingid":{"description":"A Zoom custom identifier for tracing the API call.","schema":{"type":"string","example":"WEBnvfudrhf84r5734rkf"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"trial_id":{"type":"string","description":"This trial's unique identifier.","example":"Z-021462495"},"end_customer_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number for the customer or partner or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"The unique CRM account number for the customer or partner or reseller.","example":"A-12323"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The type of address: billTo, shipTo, or soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country","example":"US"}},"description":"The address details."}},"description":"The account details."},"invoice_owner_account":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number for the customer or partner or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"The unique CRM account number for the customer or partner or reseller.","example":"A-12323"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The type of address: billTo, shipTo, or soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details."}},"description":"The account details."},"sub_reseller":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number for the customer or partner or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"The sub-reseller CRM account number.","example":"A-45r33"},"account_name":{"type":"string","description":"The sub-reseller name.","example":"Novam Corp."},"address":{"required":["address_type","city","country","line_1","state"],"type":"object","properties":{"address_type":{"type":"string","description":"The type of address: billTo, shipTo, or soldTo.","example":"billTo","enum":["billTo","shipTo","soldTo"]},"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The address details."}},"description":"The sub-reseller account number."},"bill_to":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number for the customer or partner or reseller","example":"3421746588"},"crm_account_number":{"type":"string","description":"The unique CRM account number for the customer or partner or reseller","example":"A-12323"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["city","country","line_1","state"],"type":"object","properties":{"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The details of the address."}},"description":"The details of the account."},"sold_to":{"type":"object","properties":{"zoom_account_number":{"maxLength":10,"type":"string","description":"The unique Zoom account number for the customer or partner or reseller.","example":"3421746588"},"crm_account_number":{"type":"string","description":"The unique CRM account number for the customer or partner or reseller.","example":"A-12323"},"account_name":{"type":"string","description":"The account name.","example":"John Doe LLC"},"address":{"required":["city","country","line_1","state"],"type":"object","properties":{"line_1":{"maxLength":200,"type":"string","description":"The street address.","example":"55 Almaden Blvd"},"line_2":{"maxLength":200,"type":"string","description":"The street address.","example":"Suite 10"},"line_3":{"maxLength":200,"type":"string","description":"The street address.","example":"Tower A"},"city":{"maxLength":50,"type":"string","description":"The city name.","example":"San Jose"},"postal_code":{"maxLength":10,"type":"string","description":"The postal number or zip code.","example":"95114"},"state":{"maxLength":20,"type":"string","description":"The state or province.","example":"PA"},"country":{"maxLength":3,"type":"string","description":"The ISO code for the country.","example":"US"}},"description":"The details of the address."}},"description":"The details of the account."},"sold_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"Unique CRM Number for the contact","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the sold to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the sold to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email ID.","example":"abc@test.com"}},"description":"Sold to contact details."},"bill_to_contact":{"type":"object","properties":{"crm_contact_number":{"type":"string","description":"Unique CRM Number for the contact.","example":"A-1232"},"first_name":{"type":"string","description":"The first name of the bill to contact.","example":"John"},"last_name":{"type":"string","description":"The last name of the bill to contact.","example":"Doe"},"email":{"type":"string","description":"The contact's email ID.","example":"abc@test.com"}},"description":"Bill to contact details."},"trial_lines":{"maxItems":10,"type":"array","description":"The trial offers.","items":{"type":"object","properties":{"offer_id":{"type":"string","description":"The offer or plan ID.","example":"PR-2323"},"offer_name":{"type":"string","description":"The offer or plan name.","example":"Zoom Workplace Pro"},"offer_type":{"type":"string","description":"The type of offering.","example":"plan","enum":["plan","standalone","configurable","isv","addon"]},"sku":{"type":"string","description":"The offer SKU.","example":"SKU-00000118"},"offer_price_list_id":{"type":"string","description":"The offer price list ID.","example":"PRL-2323"},"offer_price_list_name":{"type":"string","description":"The offer price list name.","example":"Zoom Workplace Pro Annual"},"quantity":{"type":"integer","description":"The number of licenses.","example":100},"start_date":{"type":"string","description":"The start date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2023-10-03"},"end_date":{"type":"string","description":"The end date of the subscription line, in YYYY-MM-DD format.","format":"YYYY-MM-DD","example":"2024-10-03"},"offer_attributes":{"maxItems":10,"type":"array","description":"The offer attributes.","items":{"type":"object","properties":{"name":{"type":"string","description":"The attribute name.","example":"Min licenses for purchase"},"uom":{"type":"string","description":"The unit of measure.","example":"count"},"value_type":{"type":"string","description":"The attribute value type. Supported data types: Integer, Enum, String, Boolean, or Object.","example":"Integer","enum":["Integer","Enum","String","Boolean","Object"]},"value":{"type":"string","description":"The attribute value.","example":"10"}},"description":"The details of the offer attribute."}}},"description":"The trial item details."}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  See details. \n\n "},"401":{"description":"**HTTP Status Code:** `401` <br>\n Unauthorized  Unauthorized access. Authorization information is missing or invalid. \n\n "},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `5009` <br>\n No records found. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "},"500":{"description":"**HTTP Status Code:** `500` <br>\n Internal Server Error  The server encountered an unexpected condition which prevented it from fulfilling the request. \n\n "}},"security":[{"openapi_oauth":["zoom_commerce:read:admin","zoom_commerce:read:subscription:admin"],"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["zoom_commerce:read:admin"],"x-granular-scopes":["zoom_commerce:read:subscription:admin"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"type":"apiKey","name":"Authorization","in":"header"},"openapi_oauth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/","tokenUrl":"","refreshUrl":"","scopes":{"zoom_commerce:write:admin":"zoom_commerce:write:admin","zoom_commerce:write:sub_account:admin":"zoom_commerce:write:sub_account:admin","zoom_commerce:update:account:admin":"zoom_commerce:update:account:admin","zoom_commerce:read:admin":"zoom_commerce:read:admin","zoom_commerce:read:account:admin":"zoom_commerce:read:account:admin","zoom_commerce:read:billing_documents:admin":"zoom_commerce:read:billing_documents:admin","zoom_commerce:read:deal_registration:admin":"zoom_commerce:read:deal_registration:admin","zoom_commerce:write:deal_registration:admin":"zoom_commerce:write:deal_registration:admin","zoom_commerce:write:order:admin":"zoom_commerce:write:order:admin","zoom_commerce:read:order:admin":"zoom_commerce:read:order:admin","zoom_commerce:write:file:admin":"zoom_commerce:write:file:admin","zoom_commerce:read:file:admin":"zoom_commerce:read:file:admin","zoom_commerce:read:product_catalog:admin":"zoom_commerce:read:product_catalog:admin","zoom_commerce:write:quote:admin":"zoom_commerce:write:quote:admin","zoom_commerce:read:quote:admin":"zoom_commerce:read:quote:admin","zoom_commerce:read:subscription:admin":"zoom_commerce:read:subscription:admin"}}}}}}}