{
    "componentChunkName": "component---src-templates-post-js",
    "path": "/en/v1/product/product-plans/",
    "result": {"data":{"markdownRemark":{"htmlAst":{"type":"element","tagName":"div","properties":{},"children":[{"type":"element","tagName":"h2","properties":{"id":"get-product-plans","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#get-product-plans","ariaLabel":"get product plans permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Get Product Plans"}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"The endpoint to get subscription product plans in the Hotmart API returns detailed information such as plan code, name, description, value, periodicity, currency, payment mode, trial period, indication if subscription recovery is enabled, and if plan switching is enabled."}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"This data can be used to create pricing management solutions, integrate with sales platforms, and analytics tools for monitoring plan performance. The endpoint is designed to ensure flexibility and accuracy in managing and displaying prices in external systems."}]},{"type":"element","tagName":"h3","properties":{"id":"request-parameters","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#request-parameters","ariaLabel":"request parameters permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Request parameters"}]},{"type":"element","tagName":"row","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{},"children":[{"type":"element","tagName":"h4","properties":{"id":"path","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#path","ariaLabel":"path permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Path"}]},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"element","tagName":"parameter","properties":{"title":"ucode","type":"string"},"children":[]},{"type":"text","value":"\nUnique identifier (ID) of the product sold in UUID (Universally Unique Identifier) format."}]},{"type":"text","value":"\n"}]},{"type":"element","tagName":"h4","properties":{"id":"query","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#query","ariaLabel":"query permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Query"}]},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"max_results","type":"integer"},"children":[]},{"type":"text","value":"\nThe maximum number of items per page that can be returned."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"page_token","type":"string"},"children":[]},{"type":"text","value":"\nThe cursor used in pagination. It's a reference to the part of the list you want to go to. For example: if your query returns 50 items and the total number of items is 95, adding the "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"page_token"}]},{"type":"text","value":" parameter to the query with the value of the "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"next_page_token"}]},{"type":"text","value":" attribute will give you access to the remaining 45 items. In the next query, by changing "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"page_token"}]},{"type":"text","value":" to the value of "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"prev_page_token"}]},{"type":"text","value":", you will again have access to the previous 50 items."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"sample-code-loader","properties":{"src":"product-plans-request"},"children":[]}]}]},{"type":"element","tagName":"hr","properties":{},"children":[]},{"type":"element","tagName":"h3","properties":{"id":"return","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#return","ariaLabel":"return permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","height":"16","version":"1.1","viewBox":"0 0 16 16","width":"16"},"children":[{"type":"element","tagName":"path","properties":{"fillRule":"evenodd","d":"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"},"children":[]}]}]},{"type":"text","value":"Return"}]},{"type":"element","tagName":"row","properties":{},"children":[{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"items","type":"array containing objects"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"collapse","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"code","type":"string"},"children":[]},{"type":"text","value":"\nThe plan code is an identifier for the subscription plan."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"name","type":"string"},"children":[]},{"type":"text","value":"\nIndicates the name of the subscription plan."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"description","type":"string"},"children":[]},{"type":"text","value":"\nThis field will be filled with the text registered in the plan description."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"value","type":"double"},"children":[]},{"type":"text","value":"\nPlan value."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"periodicity","type":"string"},"children":[]},{"type":"text","value":"\nDuration of subscription plan recurrences. These are: "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"SINGLE_INSTALLMENT"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"WEEKLY"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"MONTHLY"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BIMONTHLY"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"QUARTERLY"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ANNUAL"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BIANNUAL"}]}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"max_installments","type":"int"},"children":[]},{"type":"text","value":"\nMaximum number of installments."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"currency_code","type":"string"},"children":[]},{"type":"text","value":"\nCurrency related to the fee values, in the international three-letter standard. For example: "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BRL"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"USD"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"EUR"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"MXN"}]},{"type":"text","value":", and more."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"payment_mode","type":"string"},"children":[]},{"type":"text","value":"\nPurchase payment mode. Possible values for this field are: "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"PAGAMENTO_UNICO"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ASSINATURA"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"MULTIPLOS_PAGAMENTOS"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"PAGAMENTO_VISTA"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"NOT_DEFINED"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"INVOICE"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"SMART_INSTALLMENT"}]},{"type":"text","value":", "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"BILLET_INSTALLMENT"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"trial_period","type":"integer"},"children":[]},{"type":"text","value":"\nTrial period in days."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"is_subscription_recovery_enabled","type":"integer"},"children":[]},{"type":"text","value":"\nIndicates if the subscription recovery tool is enabled."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"is_switch_plan_enabled","type":"integer"},"children":[]},{"type":"text","value":"\nIndicates if plan switching is enabled."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"page_info","type":"object"},"children":[]},{"type":"text","value":"\nPagination information, with the potential data below:"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"collapse","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"next_page_token","type":"string"},"children":[]},{"type":"text","value":"\nHere's a reference for the next page in the list. It's worth noting that when we request the last page, in the "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"page_info"}]},{"type":"text","value":" attribute will not return the "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"next_page_token"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"prev_page_token","type":"string"},"children":[]},{"type":"text","value":"\nHere's a reference for the previous page in the list. It's worth noting that when we request the first page, in the "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"page_info"}]},{"type":"text","value":" attribute will not return the "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"prev_page_token"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"parameter","properties":{"title":"results_per_page","type":"integer"},"children":[]},{"type":"text","value":"\nContains the number of items on the current page. If you wish, you can send a maximum number of items you want to receive on each page, like the query param "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"max_results"}]},{"type":"text","value":".\n"},{"type":"element","tagName":"br","properties":{},"children":[]},{"type":"element","tagName":"br","properties":{},"children":[]},{"type":"text","value":"\nEach endpoint will have a default "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"results_per_page"}]},{"type":"text","value":" and a maximum value of items that can be returned per page. So if you enter a "},{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"max_results"}]},{"type":"text","value":" greater than the one defined, only the maximum number of results will be returned to you."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"element","tagName":"sample-code-loader","properties":{"src":"product-plans-response"},"children":[]}]}]},{"type":"element","tagName":"sandbox","properties":{},"children":[{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"To test this endpoint in the Sandbox, you need to change the base URL to "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"https://sandbox.hotmart.com"}]},{"type":"text","value":" and use the Sandbox environment credential."}]},{"type":"element","tagName":"p","properties":{"className":["half-width-content"]},"children":[{"type":"text","value":"Since all data in the Sandbox is dummy data, below is a table of possible values that can be used to test each parameter of the request. When you replace the parameter with the value, you'll get the scenario described in the table. That way, you'll know what to expect, and if something different happens, you'll know that there's an issue with your implementation."}]},{"type":"element","tagName":"row","properties":{},"children":[{"type":"text","value":"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"},{"type":"element","tagName":"table","properties":{},"children":[{"type":"element","tagName":"thead","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Test scenario"}]},{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"HTTP response code"}]},{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Parameter name"}]},{"type":"element","tagName":"th","properties":{},"children":[{"type":"text","value":"Values ​​for the parameter"}]}]}]},{"type":"element","tagName":"tbody","properties":{},"children":[{"type":"element","tagName":"tr","properties":{},"children":[{"type":"element","tagName":"td","properties":{},"children":[{"type":"text","value":"Success"}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"strong","properties":{},"children":[{"type":"text","value":"200"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"ucode"}]}]},{"type":"element","tagName":"td","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"3f9e2d5a-4cb8-4f13-9d2e-8b7c4a0f1e92"}]}]}]}]}]}]}]}]},"frontmatter":{"description":"Get detailed information about subscription product plans, including pricing, periodicity, payment options, and installment settings.","title":"Get Product Plans","tags":["product","plans"],"category":"Product","categoryDescription":"Get detailed information about subscription product plans, including pricing, periodicity, payment options, and installment settings.","api":null,"buttonLink":null,"buttonText":null,"buttonIcon":null},"fields":{"langKey":"en","verKey":["/v1"],"slug":"/en/v1/product/product-plans/"}},"allMarkdownRemark":{"distinct":["en","es","pt-BR"]}},"pageContext":{"category":"product","slug":"/en/v1/product/product-plans/","pathNoLang":"/v1/product/product-plans/"}},
    "staticQueryHashes": ["1180253839","1927663127","2095688679","3367957584","3579948671","3996864857","4162568218","4285555676"]}