Venflow API
V1SuscripcionesPor IDCancel

Cancelar una suscripción

POST
/v1/subscriptions/{id}/cancel

Authorization

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

Request Body

cancel_mode?string

When the cancellation takes effect. period_end (the default) keeps the subscription active until the current billing period closes, then cancels it. It is the only mode available today.

Value in"period_end"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.venflow.app/v1/subscriptions/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \  -H "Content-Type: application/json" \  -d '{    "cancel_mode": "period_end"  }'
{
  "billing_cycles": 0,
  "billing_cycles_completed": 0.1,
  "cancel_at_period_end": true,
  "collection_mode": "engine",
  "created": 0.1,
  "current_period_end": 0.1,
  "current_period_start": 0.1,
  "customer": "string",
  "discount": {
    "amount_off": 0,
    "duration": "once",
    "duration_periods": 0,
    "id": "string",
    "name": "string",
    "percent_off": 0,
    "remaining_periods": 0
  },
  "id": "string",
  "livemode": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "object": "subscription",
  "plan": "string",
  "scheduled_start_date": "string",
  "status": "string",
  "trial_end": 0,
  "trial_start": 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"
}

Actualizar una suscripción PATCH

Actualiza la metadata de la suscripción indicada. Es un endpoint aparte de los de cancelar y reactivar a propósito: esos mueven dinero y ciclo de vida, y anotar metadata no. La metadata se combina con la que ya tenga: las claves que no menciones se conservan, una clave con valor `null` se borra, y `{}` las borra todas.

Listar los cobros de una suscripción GET

Devuelve las solicitudes de cobro de una suscripción, ordenadas por fecha de creación con las más recientes primero. Incluye las canceladas y las fallidas, para que puedas auditar todo lo que pediste sobre esa suscripción.