Aplica um cupom a uma sessão open que tenha couponEnabled: true. O desconto é calculado por item elegível e a resposta traz os novos discounts, discountAmount e amount. Aplicar outro cupom substitui o anterior. Itens recorrentes sob um teste não recebem desconto, porque nada é cobrado hoje por eles.Permissão: checkout_session.write. Aceita a chave secreta ou o clientSecret da sessão. Limite do navegador: 20 por minuto por IP, para que os códigos não sejam adivinhados.
Os exemplos usam o sandbox (https://api.upag.dev/v1). Em produção use https://api.upag.io/v1 com sk_live_…; no navegador, o upag-js usa só a chave pública.
Do servidor: a sessão não existe ou é de outra conta
404
COUPON_NOT_FOUND
Nenhum cupom com esse código na conta
409
CHECKOUT_SESSION_NOT_OPEN
A sessão já está complete ou expired
400
COUPON_NOT_ENABLED
A sessão não permite cupom (couponEnabled: false)
400
COUPON_NOT_ACTIVE
O cupom está inativo
400
COUPON_EXPIRED
O cupom venceu
400
COUPON_MAX_USES_REACHED
O cupom esgotou os usos
422
VALIDATION_FAILED
code com menos de 3 caracteres
429
n/a
Do navegador: mais de 20 tentativas por minuto pelo mesmo IP
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Upag Documentation","colors":{"primary":"#06AEDD","light":"#13C6F9","dark":"#0583A6"},"logo":{"light":"https://mintcdn.com/upag/J0FSTIds_wQSyfe4/logo/light.svg?fit=max\u0026auto=format\u0026n=J0FSTIds_wQSyfe4\u0026q=85\u0026s=69934217fd5359442c60393a5611af74","dark":"https://mintcdn.com/upag/J0FSTIds_wQSyfe4/logo/dark.svg?fit=max\u0026auto=format\u0026n=J0FSTIds_wQSyfe4\u0026q=85\u0026s=17e82005fbb54288e4d8a5d7918e98ee"},"favicon":"https://mintcdn.com/upag/J0FSTIds_wQSyfe4/favicon.svg?fit=max\u0026auto=format\u0026n=J0FSTIds_wQSyfe4\u0026q=85\u0026s=f25e12f43de622c85348e03828014f7b","api":{"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["curl","javascript","node"],"prefill":false,"autogenerate":true},"url":"full","mdx":{"auth":{"method":"bearer"}}},"navbar":{"links":[{"href":"/llm.txt","label":"llm.txt"}]},"seo":{"metatags":{"canonical":"https://docs.upag.io","og:locale":"pt_BR","language":"pt-BR"},"organization":{"name":"Upag","url":"https://upag.io"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"upag","hasAudioNarration":false,"actualSubdomain":"upag","customDomains":["docs.upag.io"],"gitSource":{"type":"github","owner":"upaghq","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ac77c4fdf14e6603e2e7221","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"default","tag":"Referência","count":113},{"language":"default","tag":"Webhooks","count":19},{"language":"default","tag":"Sessões de checkout","count":14},{"language":"default","tag":"Apps","count":11},{"language":"default","tag":"Faturas","count":11},{"language":"default","tag":"Links de pagamento","count":11},{"language":"default","tag":"Assinaturas","count":11},{"language":"default","tag":"Guias","count":10},{"language":"default","tag":"Payloads","count":8},{"language":"default","tag":"Layouts de checkout","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"pages/checkout-sessions/apply-coupon","slug":"/pages/checkout-sessions/apply-coupon","pageMetadata":{"title":"Aplicar cupom","description":"Aplica um cupom a uma sessão de checkout aberta","sidebarTitle":"Aplicar cupom","api":"POST https://api.upag.io/v1/checkout/sessions/{sessionId}/coupon","href":"/pages/checkout-sessions/apply-coupon"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Aplica um cupom a uma sessão de checkout aberta\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Note,ParamField,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Aplica um `,_jsx(_components.a,{href:`/pages/coupons/reference`,children:`cupom`}),` a uma sessão `,_jsx(_components.code,{children:`open`}),` que tenha `,_jsx(_components.code,{children:`couponEnabled: true`}),`. O desconto é calculado por item elegível e a resposta traz os novos `,_jsx(_components.code,{children:`discounts`}),`, `,_jsx(_components.code,{children:`discountAmount`}),` e `,_jsx(_components.code,{children:`amount`}),`. Aplicar outro cupom substitui o anterior. Itens recorrentes sob um teste não recebem desconto, porque nada é cobrado hoje por eles.`]}),`\n`,_jsxs(_components.p,{children:[`Permissão: `,_jsx(_components.code,{children:`checkout_session.write`}),`. Aceita a chave secreta ou o `,_jsx(_components.code,{children:`clientSecret`}),` da sessão. Limite do navegador: 20 por minuto por IP, para que os códigos não sejam adivinhados.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Os exemplos usam o sandbox (`,_jsx(_components.code,{children:`https://api.upag.dev/v1`}),`). Em produção use `,_jsx(_components.code,{children:`https://api.upag.io/v1`}),` com `,_jsx(_components.code,{children:`sk_live_…`}),`; no navegador, o `,_jsx(_components.code,{children:`upag-js`}),` usa só a chave pública.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`endpoint`,children:`Endpoint`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -X POST https://api.upag.dev/v1/checkout/sessions/4f9d2b71-6c03-4e58-9a1d-8b3e7c0f5a26/coupon \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization: Bearer Zk3v0pQ8xJ2mR7cYt1LwN5dHs9uAeB4gXo6iFqVjT0E\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` -d `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'{ \"code\": \"BEMVINDO10\" }'`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`upag-js`,numberOfLines:`5`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { UpagJs } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'upag-js'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` upag = `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`new`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` UpagJs(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'pk_test_your_public_key'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` session = `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` upag.checkout.applyCoupon(id, clientSecret, { code: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'BEMVINDO10'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` });`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Node.js SDK`,numberOfLines:`7`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { Upag } `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'upag'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` upag = `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`new`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Upag(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'sk_test_your_api_key'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`const`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` session = `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` upag.checkoutSessions.applyCoupon(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'4f9d2b71-6c03-4e58-9a1d-8b3e7c0f5a26'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` code: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'BEMVINDO10'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`2`,id:`parâmetros`,children:`Parâmetros`}),`\n`,_jsx(ParamField,{path:`sessionId`,type:`string (uuid)`,required:true,id:`param-session-id`,children:_jsx(_components.p,{children:`ID da sessão.`})}),`\n`,_jsx(ParamField,{body:`code`,type:`string`,required:true,id:`param-code`,children:_jsx(_components.p,{children:`Código do cupom, com pelo menos 3 caracteres. Maiúsculas e minúsculas não importam.`})}),`\n`,_jsx(Heading,{level:`2`,id:`resposta`,children:`Resposta`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`200 OK`}),`. Com o `,_jsx(_components.code,{children:`clientSecret`}),`, é a `,_jsx(_components.a,{href:`/pages/checkout-sessions/retrieve`,children:`visão do pagador`}),`; com a chave secreta, é a `,_jsx(_components.a,{href:`/pages/checkout-sessions/reference`,children:`sessão`}),` do servidor. Trecho da visão do pagador:`]}),`\n`,_jsx(CodeBlock,{filename:`Response`,numberOfLines:`19`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`19`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"4f9d2b71-6c03-4e58-9a1d-8b3e7c0f5a26\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"open\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"currency\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"brl\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"subtotal\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`19900`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"discountAmount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1990`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`17910`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"discounts\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"0d6f3a82-5e19-4b47-a3c8-7f1b9e2d4c60\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"item\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"b7e1c4a9-3d52-4f08-86a1-2c9d5e7f0b34\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"coupon\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"a58c2e14-9d70-4f36-b1e5-3c8a6d0f7b92\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"coupon\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"amount\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1990`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"couponEnabled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"couponCode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"BEMVINDO10\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`A resposta completa traz também os demais campos da sessão; aqui estão os que mudam.`}),`\n`,_jsx(Heading,{level:`2`,id:`erros`,children:`Erros`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Código`}),_jsx(_components.th,{children:`Quando`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`CHECKOUT_SESSION_NOT_FOUND`})}),_jsx(_components.td,{children:`Do servidor: a sessão não existe ou é de outra conta`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`COUPON_NOT_FOUND`})}),_jsx(_components.td,{children:`Nenhum cupom com esse código na conta`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`CHECKOUT_SESSION_NOT_OPEN`})}),_jsxs(_components.td,{children:[`A sessão já está `,_jsx(_components.code,{children:`complete`}),` ou `,_jsx(_components.code,{children:`expired`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`COUPON_NOT_ENABLED`})}),_jsxs(_components.td,{children:[`A sessão não permite cupom (`,_jsx(_components.code,{children:`couponEnabled: false`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`COUPON_NOT_ACTIVE`})}),_jsx(_components.td,{children:`O cupom está inativo`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`COUPON_EXPIRED`})}),_jsx(_components.td,{children:`O cupom venceu`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`COUPON_MAX_USES_REACHED`})}),_jsx(_components.td,{children:`O cupom esgotou os usos`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`422`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`VALIDATION_FAILED`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`code`}),` com menos de 3 caracteres`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`429`})}),_jsx(_components.td,{children:`n/a`}),_jsx(_components.td,{children:`Do navegador: mais de 20 tentativas por minuto pelo mesmo IP`})]})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Aplicar cupom","description":"Aplica um cupom a uma sessão de checkout aberta","sidebarTitle":"Aplicar cupom","api":"POST https://api.upag.io/v1/checkout/sessions/{sessionId}/coupon","href":"/pages/checkout-sessions/apply-coupon"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoint","slug":"endpoint","depth":2,"children":[]},{"title":"Parâmetros","slug":"parâmetros","depth":2,"children":[]},{"title":"Resposta","slug":"resposta","depth":2,"children":[]},{"title":"Erros","slug":"erros","depth":2,"children":[]}],"codeExamples":{},"endpoint":{"title":"Aplicar cupom","path":"/v1/checkout/sessions/{sessionId}/coupon","servers":[{"url":"https://api.upag.io"}],"method":"post","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{"sessionId":{"schema":[{"type":"object","properties":{},"description":"ID da sessão.","required":true}]}}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"code":[{"type":"string","description":"Código do cupom, com pelo menos 3 caracteres. Maiúsculas e minúsculas não importam.","required":true}]}}],"examples":{"example":{"value":{"code":"\u003cstring>"}}}}}},"response":{},"deprecated":false}},"jsLinks":[],"subdomain":"upag","siteName":"Upag Documentation","title":"Aplicar cupom - Upag Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-08T11:19:53.415Z","originalFileLocation":"pages/checkout-sessions/apply-coupon.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Aplica um cupom a uma sessão de checkout aberta\">\u003cmeta data-mint-head name=\"application-name\" content=\"Upag Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/upag/-kAfZwMHyVqMVY71/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/upag/-kAfZwMHyVqMVY71/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/upag/-kAfZwMHyVqMVY71/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/upag/-kAfZwMHyVqMVY71/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/upag/-kAfZwMHyVqMVY71/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/upag/-kAfZwMHyVqMVY71/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/upag/-kAfZwMHyVqMVY71/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/upag/-kAfZwMHyVqMVY71/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/upag/-kAfZwMHyVqMVY71/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Aplicar cupom - Upag Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Aplica um cupom a uma sessão de checkout aberta\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Upag Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.upag.io/pages/checkout-sessions/apply-coupon\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://upag.mintlify.site/_mintlify/api/og/v2?division=Sess%C3%B5es+de+checkout\u0026amp;title=Aplicar+cupom\u0026amp;description=Aplica+um+cupom+a+uma+sess%C3%A3o+de+checkout+aberta\u0026amp;theme=ec18ef61f13e0db7a8ddbb8d\u0026amp;signature=c45f31edd290ce15030abd2138cbf2fff4ebc5782d7613219e7a7a592a7baf3b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Aplicar cupom - Upag Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Aplica um cupom a uma sessão de checkout aberta\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://upag.mintlify.site/_mintlify/api/og/v2?division=Sess%C3%B5es+de+checkout\u0026amp;title=Aplicar+cupom\u0026amp;description=Aplica+um+cupom+a+uma+sess%C3%A3o+de+checkout+aberta\u0026amp;theme=ec18ef61f13e0db7a8ddbb8d\u0026amp;signature=c45f31edd290ce15030abd2138cbf2fff4ebc5782d7613219e7a7a592a7baf3b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/upag/-kAfZwMHyVqMVY71/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Upag Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#06AEDD\">\u003cmeta data-mint-head name=\"og:locale\" content=\"pt_BR\">\u003cmeta data-mint-head name=\"language\" content=\"pt-BR\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.upag.io/pages/checkout-sessions/apply-coupon\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pages/checkout-sessions/apply-coupon.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://upag.io/#organization\",\"name\":\"Upag\",\"url\":\"https://upag.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/upag/J0FSTIds_wQSyfe4/logo/light.svg?fit=max\u0026auto=format\u0026n=J0FSTIds_wQSyfe4\u0026q=85\u0026s=69934217fd5359442c60393a5611af74\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.upag.io#website\",\"name\":\"Upag Documentation\",\"url\":\"https://docs.upag.io\",\"publisher\":{\"@id\":\"https://upag.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.upag.io/pages/checkout-sessions/apply-coupon#webpage\",\"url\":\"https://docs.upag.io/pages/checkout-sessions/apply-coupon\",\"name\":\"Aplicar cupom\",\"description\":\"Aplica um cupom a uma sessão de checkout aberta\",\"dateModified\":\"2026-10-08T11:19:53.415Z\",\"isPartOf\":{\"@id\":\"https://docs.upag.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.upag.io/pages/checkout-sessions/apply-coupon#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.upag.io/pages/checkout-sessions/apply-coupon#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sessões de checkout\",\"item\":\"https://docs.upag.io/pages/checkout-sessions/reference\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Aplicar cupom\",\"item\":\"https://docs.upag.io/pages/checkout-sessions/apply-coupon\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.upag.io/pages/checkout-sessions/apply-coupon#apireference\",\"headline\":\"Aplicar cupom\",\"name\":\"Aplicar cupom\",\"description\":\"Aplica um cupom a uma sessão de checkout aberta\",\"url\":\"https://docs.upag.io/pages/checkout-sessions/apply-coupon\",\"mainEntityOfPage\":{\"@id\":\"https://docs.upag.io/pages/checkout-sessions/apply-coupon#webpage\"},\"dateModified\":\"2026-10-08T11:19:53.415Z\",\"publisher\":{\"@id\":\"https://upag.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.upag.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Upag Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Upag\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/pages/checkout-sessions/apply-coupon.md","siteName":"Upag Documentation","nav":{"global":null,"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":"/pages/guides/quickstart"}]},{"tab":"Referência","groups":[{"group":"Cobranças","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/charges/reference"},{"title":"Criar cobrança","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/charges","href":"/pages/charges/create"},{"title":"Listar cobranças","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/charges","href":"/pages/charges/list"},{"title":"Obter cobrança","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/charges/{chargeId}","href":"/pages/charges/get"}]},{"group":"Cartões","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/cards/reference"},{"title":"Criar cartão","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/cards","href":"/pages/cards/create"},{"title":"Listar cartões","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/cards","href":"/pages/cards/list"},{"title":"Obter cartão","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/cards/{cardId}","href":"/pages/cards/get"},{"title":"Remover cartão","sidebarTitle":"Remover","api":"DELETE https://api.upag.io/v1/cards/{cardId}","href":"/pages/cards/delete"}]},{"group":"3D Secure","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/three-d-secure/reference"},{"title":"Criar sessão 3DS","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/3ds/sessions","href":"/pages/three-d-secure/create"},{"title":"Obter sessão 3DS","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/3ds/sessions/{sessionId}","href":"/pages/three-d-secure/get"},{"title":"Iniciar sessão 3DS","sidebarTitle":"Iniciar","api":"POST https://api.upag.io/v1/3ds/sessions/start","href":"/pages/three-d-secure/start"},{"title":"Concluir sessão 3DS","sidebarTitle":"Concluir","api":"POST https://api.upag.io/v1/3ds/sessions/complete","href":"/pages/three-d-secure/complete"}]},{"group":"Clientes","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/customers/reference"},{"title":"Criar cliente","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/customers","href":"/pages/customers/create"},{"title":"Listar clientes","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/customers","href":"/pages/customers/list"},{"title":"Obter cliente","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/customers/{customerId}","href":"/pages/customers/get"},{"title":"Atualizar cliente","sidebarTitle":"Atualizar","api":"PATCH https://api.upag.io/v1/customers/{customerId}","href":"/pages/customers/update"},{"title":"Excluir cliente","sidebarTitle":"Excluir","api":"DELETE https://api.upag.io/v1/customers/{customerId}","href":"/pages/customers/delete"}]},{"group":"Produtos","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/products/reference"},{"title":"Criar produto","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/products","href":"/pages/products/create"},{"title":"Listar produtos","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/products","href":"/pages/products/list"},{"title":"Obter produto","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/products/{productId}","href":"/pages/products/get"},{"title":"Atualizar produto","sidebarTitle":"Atualizar","api":"PATCH https://api.upag.io/v1/products/{productId}","href":"/pages/products/update"}]},{"group":"Preços","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/prices/reference"},{"title":"Criar preço","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/products/{productId}/prices","href":"/pages/prices/create"},{"title":"Listar preços","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/products/{productId}/prices","href":"/pages/prices/list"},{"title":"Obter preço","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/products/{productId}/prices/{priceId}","href":"/pages/prices/get"},{"title":"Atualizar preço","sidebarTitle":"Atualizar","api":"PATCH https://api.upag.io/v1/products/{productId}/prices/{priceId}","href":"/pages/prices/update"}]},{"group":"Cupons","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/coupons/reference"},{"title":"Criar cupom","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/coupons","href":"/pages/coupons/create"},{"title":"Listar cupons","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/coupons","href":"/pages/coupons/list"},{"title":"Obter cupom","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/coupons/{couponId}","href":"/pages/coupons/get"},{"title":"Atualizar cupom","sidebarTitle":"Atualizar","api":"PATCH https://api.upag.io/v1/coupons/{couponId}","href":"/pages/coupons/update"},{"title":"Excluir cupom","sidebarTitle":"Excluir","api":"DELETE https://api.upag.io/v1/coupons/{couponId}","href":"/pages/coupons/delete"}]},{"group":"Faturas","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/invoices/reference"},{"title":"Criar fatura","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/invoices","href":"/pages/invoices/create"},{"title":"Listar faturas","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/invoices","href":"/pages/invoices/list"},{"title":"Obter fatura","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/invoices/{invoiceId}","href":"/pages/invoices/get"},{"title":"Atualizar fatura","sidebarTitle":"Atualizar","api":"PATCH https://api.upag.io/v1/invoices/{invoiceId}","href":"/pages/invoices/update"},{"title":"Próxima fatura","sidebarTitle":"Próxima fatura","api":"GET https://api.upag.io/v1/invoices/upcoming","href":"/pages/invoices/upcoming"},{"title":"Pagar fatura","sidebarTitle":"Pagar","api":"POST https://api.upag.io/v1/invoices/{invoiceId}/pay","href":"/pages/invoices/pay"},{"title":"Marcar como paga","sidebarTitle":"Marcar como paga","api":"POST https://api.upag.io/v1/invoices/{invoiceId}/mark-as-paid","href":"/pages/invoices/mark-as-paid"},{"title":"Adicionar item","sidebarTitle":"Adicionar item","api":"POST https://api.upag.io/v1/invoices/{invoiceId}/items","href":"/pages/invoices/create-item"},{"title":"Atualizar item","sidebarTitle":"Atualizar item","api":"PATCH https://api.upag.io/v1/invoices/{invoiceId}/items/{itemId}","href":"/pages/invoices/update-item"},{"title":"Remover item","sidebarTitle":"Remover item","api":"DELETE https://api.upag.io/v1/invoices/{invoiceId}/items/{itemId}","href":"/pages/invoices/delete-item"}]},{"group":"Assinaturas","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/subscriptions/reference"},{"title":"Criar assinatura","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/subscriptions","href":"/pages/subscriptions/create"},{"title":"Listar assinaturas","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/subscriptions","href":"/pages/subscriptions/list"},{"title":"Obter assinatura","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/subscriptions/{subscriptionId}","href":"/pages/subscriptions/get"},{"title":"Atualizar assinatura","sidebarTitle":"Atualizar","api":"PATCH https://api.upag.io/v1/subscriptions/{subscriptionId}","href":"/pages/subscriptions/update"},{"title":"Cancelar assinatura","sidebarTitle":"Cancelar","api":"POST https://api.upag.io/v1/subscriptions/{subscriptionId}/cancel","href":"/pages/subscriptions/cancel"},{"title":"Adicionar item","sidebarTitle":"Adicionar item","api":"POST https://api.upag.io/v1/subscriptions/{subscriptionId}/items","href":"/pages/subscriptions/create-item"},{"title":"Atualizar item","sidebarTitle":"Atualizar item","api":"PATCH https://api.upag.io/v1/subscriptions/{subscriptionId}/items/{itemId}","href":"/pages/subscriptions/update-item"},{"title":"Remover item","sidebarTitle":"Remover item","api":"DELETE https://api.upag.io/v1/subscriptions/{subscriptionId}/items/{itemId}","href":"/pages/subscriptions/delete-item"},{"title":"Mudanças agendadas","sidebarTitle":"Mudanças agendadas","api":"GET https://api.upag.io/v1/subscriptions/{subscriptionId}/scheduled-changes","href":"/pages/subscriptions/scheduled-changes"},{"title":"Cancelar mudança agendada","sidebarTitle":"Cancelar mudança agendada","api":"DELETE https://api.upag.io/v1/subscriptions/{subscriptionId}/scheduled-changes/{changeId}","href":"/pages/subscriptions/delete-scheduled-change"}]},{"group":"Links de pagamento","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/payment-links/reference"},{"title":"Criar link de pagamento","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/payment-links","href":"/pages/payment-links/create"},{"title":"Listar links de pagamento","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/payment-links","href":"/pages/payment-links/list"},{"title":"Obter link de pagamento","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/payment-links/{paymentLinkId}","href":"/pages/payment-links/get"},{"title":"Atualizar link de pagamento","sidebarTitle":"Atualizar","api":"PATCH https://api.upag.io/v1/payment-links/{paymentLinkId}","href":"/pages/payment-links/update"},{"title":"Adicionar item ao link","sidebarTitle":"Adicionar item","api":"POST https://api.upag.io/v1/payment-links/{paymentLinkId}/items","href":"/pages/payment-links/add-item"},{"title":"Atualizar item do link","sidebarTitle":"Atualizar item","api":"PATCH https://api.upag.io/v1/payment-links/{paymentLinkId}/items/{itemId}","href":"/pages/payment-links/update-item"},{"title":"Remover item do link","sidebarTitle":"Remover item","api":"DELETE https://api.upag.io/v1/payment-links/{paymentLinkId}/items/{itemId}","href":"/pages/payment-links/remove-item"},{"title":"Adicionar bump ao link","sidebarTitle":"Adicionar bump","api":"POST https://api.upag.io/v1/payment-links/{paymentLinkId}/bumps","href":"/pages/payment-links/add-bump"},{"title":"Atualizar bump do link","sidebarTitle":"Atualizar bump","api":"PATCH https://api.upag.io/v1/payment-links/{paymentLinkId}/bumps/{bumpId}","href":"/pages/payment-links/update-bump"},{"title":"Remover bump do link","sidebarTitle":"Remover bump","api":"DELETE https://api.upag.io/v1/payment-links/{paymentLinkId}/bumps/{bumpId}","href":"/pages/payment-links/remove-bump"}]},{"group":"Sessões de checkout","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/checkout-sessions/reference"},{"title":"Criar sessão de checkout","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/checkout/sessions","href":"/pages/checkout-sessions/create"},{"title":"Listar sessões de checkout","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/checkout/sessions","href":"/pages/checkout-sessions/list"},{"title":"Obter sessão de checkout","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/checkout/sessions/{sessionId}","href":"/pages/checkout-sessions/get"},{"title":"Atualizar sessão de checkout","sidebarTitle":"Atualizar","api":"PATCH https://api.upag.io/v1/checkout/sessions/{sessionId}","href":"/pages/checkout-sessions/update"},{"title":"Remover sessão de checkout","sidebarTitle":"Remover","api":"DELETE https://api.upag.io/v1/checkout/sessions/{sessionId}","href":"/pages/checkout-sessions/delete"},{"title":"Iniciar sessão de checkout","sidebarTitle":"Iniciar","api":"POST https://api.upag.io/v1/checkout/payment-links/{code}/sessions","href":"/pages/checkout-sessions/start"},{"title":"Obter sessão (pagador)","sidebarTitle":"Obter (pagador)","api":"GET https://api.upag.io/v1/checkout/sessions/{sessionId}","href":"/pages/checkout-sessions/retrieve"},{"title":"Confirmar sessão de checkout","sidebarTitle":"Confirmar","api":"POST https://api.upag.io/v1/checkout/sessions/{sessionId}/confirm","href":"/pages/checkout-sessions/confirm"},{"title":"Abrir sessão 3DS do checkout","description":"Abre uma sessão 3D Secure para o valor de uma sessão de checkout, antes de confirmar com cartão","sidebarTitle":"Sessão 3DS","api":"POST https://api.upag.io/v1/checkout/sessions/{sessionId}/3ds/session","href":"/pages/checkout-sessions/three-d-secure"},{"title":"Aplicar cupom","sidebarTitle":"Aplicar cupom","api":"POST https://api.upag.io/v1/checkout/sessions/{sessionId}/coupon","href":"/pages/checkout-sessions/apply-coupon"},{"title":"Remover cupom","description":"Remove o cupom de uma sessão de checkout aberta","sidebarTitle":"Remover cupom","api":"DELETE https://api.upag.io/v1/checkout/sessions/{sessionId}/coupon","href":"/pages/checkout-sessions/remove-coupon"},{"title":"Listar apps do checkout","sidebarTitle":"Listar apps","api":"GET https://api.upag.io/v1/checkout/sessions/{sessionId}/apps","href":"/pages/checkout-sessions/list-apps"},{"title":"Iniciar checkout Shopify","sidebarTitle":"Checkout Shopify","api":"POST https://api.upag.io/v1/checkout/shopify/sessions","href":"/pages/checkout-sessions/shopify"}]},{"group":"Layouts de checkout","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/checkout-layouts/reference"},{"title":"Criar layout de checkout","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/checkout/layouts","href":"/pages/checkout-layouts/create"},{"title":"Listar layouts de checkout","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/checkout/layouts","href":"/pages/checkout-layouts/list"},{"title":"Obter layout de checkout","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/checkout/layouts/{layoutId}","href":"/pages/checkout-layouts/get"},{"title":"Atualizar layout de checkout","sidebarTitle":"Atualizar","api":"PATCH https://api.upag.io/v1/checkout/layouts/{layoutId}","href":"/pages/checkout-layouts/update"},{"title":"Excluir layout de checkout","sidebarTitle":"Excluir","api":"DELETE https://api.upag.io/v1/checkout/layouts/{layoutId}","href":"/pages/checkout-layouts/delete"}]},{"group":"Transferências Pix","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/transfers/reference"},{"title":"Consultar destino Pix","sidebarTitle":"Consultar","api":"POST https://api.upag.io/v1/transfers/lookup","href":"/pages/transfers/lookup"},{"title":"Criar transferência","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/transfers","href":"/pages/transfers/create"},{"title":"Listar transferências","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/transfers","href":"/pages/transfers/list"},{"title":"Obter transferência","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/transfers/{transferId}","href":"/pages/transfers/get"},{"title":"Comprovante","sidebarTitle":"Comprovante","api":"GET https://api.upag.io/v1/transfers/{transferId}/receipt","href":"/pages/transfers/receipt"}]},{"group":"Subcontas","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/sub-accounts/reference"},{"title":"Criar subconta","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/sub-accounts","href":"/pages/sub-accounts/create"},{"title":"Listar subcontas","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/sub-accounts","href":"/pages/sub-accounts/list"},{"title":"Obter subconta","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/sub-accounts/{subAccountId}","href":"/pages/sub-accounts/get"},{"title":"Rotacionar chave da subconta","sidebarTitle":"Rotacionar chave","api":"POST https://api.upag.io/v1/sub-accounts/{subAccountId}/api-key/roll","href":"/pages/sub-accounts/roll-api-key"}]},{"group":"Apps","pages":[{"title":"Referência","sidebarTitle":"Visão geral","href":"/pages/apps/reference"},{"title":"Criar app","sidebarTitle":"Criar","api":"POST https://api.upag.io/v1/apps","href":"/pages/apps/create"},{"title":"Listar apps","sidebarTitle":"Listar","api":"GET https://api.upag.io/v1/apps","href":"/pages/apps/list"},{"title":"Obter app","sidebarTitle":"Obter","api":"GET https://api.upag.io/v1/apps/{appId}","href":"/pages/apps/get"},{"title":"Atualizar app","sidebarTitle":"Atualizar","api":"PATCH https://api.upag.io/v1/apps/{appId}","href":"/pages/apps/update"},{"title":"Excluir app","sidebarTitle":"Excluir","api":"DELETE https://api.upag.io/v1/apps/{appId}","href":"/pages/apps/delete"},{"title":"Instalar app","sidebarTitle":"Instalar","api":"POST https://api.upag.io/v1/apps/{appId}/install","href":"/pages/apps/install"},{"title":"Verificar script","sidebarTitle":"Verificar script","api":"GET https://api.upag.io/v1/apps/{appId}/script","href":"/pages/apps/verify-script"},{"title":"Desinstalar app","sidebarTitle":"Desinstalar","api":"DELETE https://api.upag.io/v1/apps/{appId}/uninstall","href":"/pages/apps/uninstall"},{"title":"Listar logs do app","sidebarTitle":"Listar logs","api":"GET https://api.upag.io/v1/apps/{appId}/logs","href":"/pages/apps/list-logs"},{"title":"Obter log do app","sidebarTitle":"Obter log","api":"GET https://api.upag.io/v1/apps/{appId}/logs/{logId}","href":"/pages/apps/get-log"}]},{"group":"Chave de API","pages":[{"title":"Identificar chave","sidebarTitle":"Identificar chave","api":"GET https://api.upag.io/v1/me","href":"/pages/me/get"}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/pages/webhooks/overview"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/pages/sdk/overview"}]},{"tab":"Simulador","pages":[{"title":"Simulador","href":"/pages/simulator"}]}]},"basePath":"","title":"Aplicar cupom - Upag Documentation","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js"]}