Venflow API
V1Payment linksPor ID

Actualizar un payment link

PATCH
/v1/payment-links/{id}

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

active?boolean

Activa o desactiva el link. Los payment links no se eliminan, se desactivan.

Optional so metadata can be updated on its own. Omitting it leaves the link's active state exactly as it was.

metadata?

Key-value pairs for storing your own information on this payment link. They are merged into what is already stored: keys you do not mention are kept. Send a key with a null value to delete that key, or {} to delete them all. At most 50 keys; keys up to 40 characters, values up to 500, and 27000 characters across all keys and values. Do not store sensitive data here: it is not encrypted and is returned on reads.

Four key names are reserved by Venflow and rejected: checkoutMode, subscriptionId, obInvoiceId and billing_cycles; use a different name, such as externalId.

Propertiesproperties <= 50

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.venflow.app/v1/payment-links/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "active": false  }'
{
  "active": true,
  "allow_manual_payments": true,
  "apply_discount_to_additional_items": true,
  "collection_mode": "engine",
  "created": 0.1,
  "discount_id": "string",
  "expiration_hours": 0.1,
  "external_initial_charge": true,
  "id": "string",
  "items": [
    {
      "id": "string",
      "name": "string",
      "plan_id": "string",
      "price": 0.1,
      "product_id": "string",
      "quantity": 0.1
    }
  ],
  "livemode": true,
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "object": "payment_link",
  "plan": "string",
  "redirect_url": "string",
  "trial_days": 0,
  "url": "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"
}
{
  "code": "not_found",
  "details": {},
  "message": "string"
}

Obtener un payment link GET

Obtiene un payment link por su ID, esté activo o desactivado. Un link de otra organización responde 404, igual que uno que no existe. Obtiene los datos de un payment link existente, esté activo o desactivado. Sirve tanto para links de planes recurrentes como de pago único.

Listar todos los pagos GET

Devuelve una lista de pagos. Los pagos se devuelven ordenados por fecha de creación, con los más recientes primero.