Venflow API
V1PlanesPor ID

Actualizar un Plan

PATCH
/v1/plans/{id}
Api-Key<token>

Tu clave API privada (comienza con pvk_)

In: header

Organization<token>

Tu ID de organización

In: header

Path Parameters

idstring
Formatuuid
active?boolean

Si el plan está activo

apply_discount_to_additional_items?boolean

Si el descuento también aplica sobre los items adicionales

billing_cycles?integer

Número de cuotas. Entero de 1 a 999 para fijar el límite; enviar 0 para quitarlo (la suscripción se cobra hasta que se cancele). null no se acepta: usar 0. Solo para planes recurrentes. No se puede cambiar mientras el plan tenga suscripciones vigentes (cualquier estado salvo cancelled): cada una se cobra con las cuotas del plan, así que el cambio devuelve 400 con details.code = "plan_billing_cycles_locked". Enviar el mismo valor guardado no es un cambio. Para ofrecer otra cantidad de cuotas, crear un plan nuevo

Rangevalue <= 999
description?string

Descripción del plan

Length1 <= length <= 1000
external_id?string

Identificador externo para integración con otros sistemas

Lengthlength <= 255
frequency?string
Value in"hourly" | "daily" | "weekly" | "biweekly" | "monthly" | "quarterly" | "semiannual" | "annual"
is_taxes_included?boolean

Si los impuestos están incluidos en el precio

name?string

Nombre del plan

Length1 <= length <= 255
price?number

Precio en dólares (no centavos)

Formatdouble
Range0 <= value
product_id?string

ID del producto al que está asociado este plan

Formatuuid
trial_days?integer

Días de prueba gratis. Entero de 1 a 365 para fijarlos; enviar 0 para quitar la prueba. null no se acepta: usar 0. Solo para planes recurrentes

Range0 <= value <= 365
type?string

Tipo de plan: recurrente o pago único

Value in"one_time" | "recurring"
usage_pricing_model?string

Modelo de precio por uso — solo editable en planes metered (usage_type y meter_id son inmutables)

Value in"per_unit" | "tiered" | "volume"
usage_tiers?

Escalones de precio; el último debe tener up_to = null

usage_unit_amount?number

Tarifa por unidad en dólares

Formatdouble

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.venflow.app/v1/plans/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "Plan Básico Actualizado",    "active": true  }'
{
  "active": true,
  "apply_discount_to_additional_items": true,
  "billing_cycles": 0,
  "created": 0.1,
  "description": "string",
  "external_id": "string",
  "frequency": "hourly",
  "id": "string",
  "is_taxes_included": true,
  "livemode": true,
  "meter_id": "string",
  "name": "string",
  "object": "plan",
  "price": 0,
  "product_id": "string",
  "trial_days": 0,
  "type": "recurring",
  "updated": 0.1,
  "usage_pricing_model": "per_unit",
  "usage_tiers": [
    {
      "unit_amount": 0.1,
      "up_to": 0
    }
  ],
  "usage_type": "licensed",
  "usage_unit_amount": 0
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}