PayZu GatewayPlanos

Criar um plano

POST/v1/plans

Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/create-a-plan


Body Params

namestringobrigatório
Nome do plano.
descriptionstringobrigatório
Descrição do plano.
amountintegerobrigatório
Valor de cada ciclo, em centavos.
recurrencestring enumobrigatório
Periodicidade da cobrança.
payment_settingsobjectobrigatório
Como as assinaturas do plano podem ser pagas.
checkoutobject
Página de adesão do plano.
discountobject
Desconto dos primeiros ciclos de cada assinatura.
metadataobject
Seus dados, em chave e valor.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
Idempotency-Keystring
Valor único da operação, para repetir a chamada sem duplicar.
acceptstring
Formato da resposta.

Responses

201Plano criado
idstringID do plano.
statusstringStatus do plano.
activeinactive
urlstringPágina de adesão do plano.
namestringNome do plano.
descriptionstringDescrição do plano.
amountintegerValor de cada ciclo, em centavos.
recurrencestringPeriodicidade da cobrança.
monthlybimonthlyquarterlysemiannualannual
created_atstringData e hora da criação.
updated_atstringData e hora da última alteração.
payment_settingsobjectComo as assinaturas do plano podem ser pagas.
Campos do objeto 1
accepted_methodsarray of stringsMeios de pagamento aceitos.
credit_cardpix
checkoutobjectPágina de adesão do plano.
Campos do objeto 3
slugstring | nullSlug do plano na url da página.
logo_urlstring | nullLogotipo exibido na página.
redirect_urlstring | nullPara onde o cliente vai depois de pagar a adesão.
discountobject | nullDesconto dos primeiros ciclos de cada assinatura, contando a adesão; nulo sem desconto.
Campos do objeto 5
typestringTipo do desconto.
fixed_amountpercentage
valueintegerDesconto: centavos ou porcentagem, conforme o tipo.
cyclesintegerCiclos com desconto, contando a adesão.
internal_descriptionstring | nullDescrição interna do desconto.
public_descriptionstring | nullTexto do desconto para o cliente.
metadataobject | nullSeus dados, em chave e valor; nulo sem metadata.
400Requisição inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
fieldsarray of objectsCampos recusados na validação.
Campos de cada item 2
namestringCaminho do campo recusado.
messagestringMotivo da recusa.
401Chave ausente ou inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
403Acesso negado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
404Não encontrado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
409Conflito
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
422Operação recusada
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.
500Erro interno
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.

Linguagem

Credenciais Bearer

Token de API

curl --request POST \     --url https://api.sandbox.payzu.dev/v1/plans \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --data '{}'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json