Editar Plano

PUT /plans/{planId}/{typeId}

Para utilizar esse método, o access_token deve conter o scope plans.write

Método utilizado para editar informações dos planos dentro do sistema.

Dados da requisição

Você pode alterar todos os dados abaixo do registro ou apenas o campo que desejar.
Apenas os campos enviados serão validados.

Nome

Tipo

Obrigatório

Explicação

myId

string 255 caracteres

Sim

Id referente no seu sistema, para salvar no cel_cash.

name

string 255 caracteres

Sim

Nome do plano.

periodicity

string 255 caracteres

Sim

Periodicidade do plano.

Valor	Explicação
weekly	Semanal
biweekly	Quinzenal
monthly	Mensal
bimonthly	Bimestral
quarterly	Trimestral
biannual	Semestral
yearly	Anual

quantity

int 3 dígitos

Sim

Para indeterminada envie 0.
Ou seja, a assinatura que usar este plano vai continuar criando transações indefinidamente até ser cancelado.
Valores válidos de 1 a 100.
Para uma quantidade de transações maior que 100 utilize a opção 'Indeterminada'.

additionalInfo

text

Não

Texto livre dedicado a informações adicionais internas.

PlanPrices

Não

Array de preços por forma de pagamento.
Clique para ver os campos.

payment

string 30 caracteres

Sim

PaymentMethod.id
Id do pagamento

Valor	Explicação
creditcard	Cartão de Crédito
boleto	Boleto Bancário

value

int 11 dígitos

Sim

Preço em centavos.

Parâmetros da URL:

{planId}: Id do plano a ser alterado.
{typeId}: Tipo do id. Opções:
- galaxPayId: Id no cel_cash
- myId: Id referente no seu sistema, para salvar no cel_cash.

URL da Requisição

https://api.sandbox.cel.cash/v2/plans/ /

URL da Requisição

https://api.sandbox.cel.cash/v2/plans/1/myId

Body da requisição

Código da resposta

---

Tempo de resposta

---

Body da Resposta

{
    "type": true,
    "Plan": {
        "galaxPayId": 1,
        "myId": "pay-664aecdaeb1e34.45527196",
        "name": "Plano mensal 2 pessoas",
        "periodicity": "monthly",
        "quantity": 12,
        "additionalInfo": "Lorem ipsum dolor sit amet.",
        "PlanPrices": [
            {
                "payment": "creditcard",
                "value": 12999
            }
        ]
    }
}

Nome

Tipo

Explicação

type

bool

Sucesso ou não da ação.

Plan

Plano
Clique para ver os campos.

galaxPayId

int 11 dígitos

Id no cel_cash

myId

string 255 caracteres

Id referente no seu sistema.

name

string 255 caracteres

Nome do plano.

periodicity

string 255 caracteres

Periodicidade do plano.

Valor

Explicação

weekly

Semanal

biweekly

Quinzenal

monthly

Mensal

bimonthly

Bimestral

quarterly

Trimestral

biannual

Semestral

yearly

Anual

quantity

int 11 dígitos

Quantidade de pagamentos total. Em caso de indeterminada irá retornar 0.

additionalInfo

text

Texto livre dedicado a informações adicionais internas.

PlanPrices

Array de preços por forma de pagamento.
Clique para ver os campos.

payment

string 30 caracteres

PaymentMethod.id
Id do pagamento

Valor

Explicação

creditcard

Cartão de Crédito

boleto

Boleto Bancário

value

int 11 dígitos

Preço em centavos.

error

Nó de erros, caso haja.
Clique para ver os campos.

message

string 255 caracteres

Mensagem que indica qual o erro.

details

Objeto com detalhes sobre o erro, mostrando qual o campo referente e qual o erro.
Clique para ver os campos.

Entity.field

array de string

Array cuja chave é Entidade.campo onde deu o erro e cada valor é uma descrição sobre o problema.

Código

Explicação

200

Plano alterado com sucesso.

400

Erros de validação.

401

Falha ao autenticar.

403

Validação de segurança.

404

Plano não encontrado.