Cria um plano de assinatura

POST/v1/subscription-plans

https://integrate.api.kyvopay.com.br

cURL

curl -X POST https://integrate.api.kyvopay.com.br/v1/subscription-plans \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \
  -H "Content-Type: application/json" \
  -d '{
  "amount_centavos": 4990,
  "interval": "weekly",
  "max_cycles": 0,
  "max_retries": 0,
  "name": "Cliente Exemplo",
  "trial_days": 0
}'

Resposta200 OK

{
  "data": {
    "amount_centavos": "4990",
    "id": "01HZ8K3M5N",
    "interval": "string",
    "is_active": false,
    "max_cycles": "string",
    "max_retries": 0,
    "name": "Cliente Exemplo",
    "public_id": "01HZ8K3M5N",
    "trial_days": 0
  },
  "error": {
    "code": "string",
    "details": {},
    "message": "string"
  },
  "request_id": "req_01HZ8K3M5N"
}

Autenticação

X-API-Keystring · headerobrigatório

Use a chave ky_... criada em Integrações → Chaves de API no painel KyvoPay.

Requisição

Corpo

amount_centavosintegerobrigatório

Valor em centavos. R$ 49,90 = 4990.

intervalstringobrigatório

Intervalo entre cobranças.

max_cyclesinteger

Número máximo de ciclos. Vazio = sem limite.

max_retriesinteger

—

namestringobrigatório

Nome.

trial_daysinteger

Dias de teste grátis.

Precisa de ajuda? Fale com o suporte

curl -X POST https://integrate.api.kyvopay.com.br/v1/subscription-plans \ -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \ -H "Content-Type: application/json" \ -d '{ "amount_centavos": 4990, "interval": "weekly", "max_cycles": 0, "max_retries": 0, "name": "Cliente Exemplo", "trial_days": 0 }'

{ "data": { "amount_centavos": "4990", "id": "01HZ8K3M5N", "interval": "string", "is_active": false, "max_cycles": "string", "max_retries": 0, "name": "Cliente Exemplo", "public_id": "01HZ8K3M5N", "trial_days": 0 }, "error": { "code": "string", "details": {}, "message": "string" }, "request_id": "req_01HZ8K3M5N" }