Assina um cliente a um plano

POST/v1/subscriptions

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

cURL

curl -X POST https://integrate.api.kyvopay.com.br/v1/subscriptions \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_id": "01HZ8K3M5N",
  "payment_method_id": "01HZ8K3M5N",
  "plan_id": "01HZ8K3M5N"
}'

Resposta200 OK

{
  "data": {
    "cancel_reason": "string",
    "current_cycle": 0,
    "customer_id": "01HZ8K3M5N",
    "failed_attempts": 0,
    "id": "01HZ8K3M5N",
    "method": "string",
    "next_charge_at": "2026-01-01T12:00:00Z",
    "payment_method_id": "01HZ8K3M5N",
    "plan_id": "01HZ8K3M5N",
    "public_id": "01HZ8K3M5N",
    "status": "pending"
  },
  "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

customer_idstringobrigatório

Identificador do cliente.

payment_method_idstring

Método de pagamento salvo usado na cobrança. Sem ele, cada ciclo gera um Pix.

plan_idstringobrigatório

Identificador do plano de assinatura.

Precisa de ajuda? Fale com o suporte

curl -X POST https://integrate.api.kyvopay.com.br/v1/subscriptions \ -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \ -H "Content-Type: application/json" \ -d '{ "customer_id": "01HZ8K3M5N", "payment_method_id": "01HZ8K3M5N", "plan_id": "01HZ8K3M5N" }'

{ "data": { "cancel_reason": "string", "current_cycle": 0, "customer_id": "01HZ8K3M5N", "failed_attempts": 0, "id": "01HZ8K3M5N", "method": "string", "next_charge_at": "2026-01-01T12:00:00Z", "payment_method_id": "01HZ8K3M5N", "plan_id": "01HZ8K3M5N", "public_id": "01HZ8K3M5N", "status": "pending" }, "error": { "code": "string", "details": {}, "message": "string" }, "request_id": "req_01HZ8K3M5N" }